interface CategoricalDimensionFieldProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnAnalysis.CategoricalDimensionFieldProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_CategoricalDimensionFieldProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnAnalysis.CategoricalDimensionFieldProperty`
Python	`aws_cdk.aws_quicksight.CfnAnalysis.CategoricalDimensionFieldProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnAnalysis` » `CategoricalDimensionFieldProperty`

The dimension type field with categorical type columns..

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const categoricalDimensionFieldProperty: quicksight.CfnAnalysis.CategoricalDimensionFieldProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  fieldId: 'fieldId',

  // the properties below are optional
  formatConfiguration: {
    nullValueFormatConfiguration: {
      nullString: 'nullString',
    },
    numericFormatConfiguration: {
      currencyDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
        symbol: 'symbol',
      },
      numberDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
  },
  hierarchyId: 'hierarchyId',
};

Properties

Name	Type	Description
column	`IResolvable` `\|` `ColumnIdentifierProperty`	The column that is used in the `CategoricalDimensionField` .
fieldId	`string`	The custom field ID.
formatConfiguration?	`IResolvable` `\|` `StringFormatConfigurationProperty`	The format configuration of the field.
hierarchyId?	`string`	The custom hierarchy ID.

column

Type: IResolvable | ColumnIdentifierProperty

The column that is used in the CategoricalDimensionField .

fieldId

Type: string

The custom field ID.

formatConfiguration?

Type: IResolvable | StringFormatConfigurationProperty (optional)

The format configuration of the field.

hierarchyId?

Type: string (optional)

The custom hierarchy ID.