aws-cdk-lib.aws_quicksight.CfnDashboard.NumericalMeasureFieldProperty

interface NumericalMeasureFieldProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.NumericalMeasureFieldProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_NumericalMeasureFieldProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.NumericalMeasureFieldProperty
Pythonaws_cdk.aws_quicksight.CfnDashboard.NumericalMeasureFieldProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnDashboard » NumericalMeasureFieldProperty

The measure type field with numerical 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 numericalMeasureFieldProperty: quicksight.CfnDashboard.NumericalMeasureFieldProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  fieldId: 'fieldId',

  // the properties below are optional
  aggregationFunction: {
    percentileAggregation: {
      percentileValue: 123,
    },
    simpleNumericalAggregation: 'simpleNumericalAggregation',
  },
  formatConfiguration: {
    formatConfiguration: {
      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',
      },
    },
  },
};

Properties

NameTypeDescription
columnIResolvable | ColumnIdentifierPropertyThe column that is used in the NumericalMeasureField .
fieldIdstringThe custom field ID.
aggregationFunction?IResolvable | NumericalAggregationFunctionPropertyThe aggregation function of the measure field.
formatConfiguration?IResolvable | NumberFormatConfigurationPropertyThe format configuration of the field.

column

Type: IResolvable | ColumnIdentifierProperty

The column that is used in the NumericalMeasureField .


fieldId

Type: string

The custom field ID.


aggregationFunction?

Type: IResolvable | NumericalAggregationFunctionProperty (optional)

The aggregation function of the measure field.


formatConfiguration?

Type: IResolvable | NumberFormatConfigurationProperty (optional)

The format configuration of the field.