interface CategoricalMeasureFieldProperty

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

The measure 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 categoricalMeasureFieldProperty: quicksight.CfnTemplate.CategoricalMeasureFieldProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  fieldId: 'fieldId',

  // the properties below are optional
  aggregationFunction: 'aggregationFunction',
  formatConfiguration: {
    nullValueFormatConfiguration: {
      nullString: 'nullString',
    },
    numericFormatConfiguration: {
      currencyDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            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: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
  },
};

Properties

Name	Type	Description
column	`IResolvable` `\|` `ColumnIdentifierProperty`	The column that is used in the `CategoricalMeasureField` .
fieldId	`string`	The custom field ID.
aggregationFunction?	`string`	The aggregation function of the measure field.
formatConfiguration?	`IResolvable` `\|` `StringFormatConfigurationProperty`	The format configuration of the field.

column

Type: IResolvable | ColumnIdentifierProperty

The column that is used in the CategoricalMeasureField .

fieldId

Type: string

The custom field ID.

aggregationFunction?

Type: string (optional)

The aggregation function of the measure field.

formatConfiguration?

Type: IResolvable | StringFormatConfigurationProperty (optional)

The format configuration of the field.