interface NumericalMeasureFieldProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.NumericalMeasureFieldProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.NumericalMeasureFieldProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.NumericalMeasureFieldProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » 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 * as quicksight from '@aws-cdk/aws-quicksight';
const numericalMeasureFieldProperty: quicksight.CfnTemplate.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

Name	Type	Description
column	IResolvable | ColumnIdentifierProperty	The column that is used in the NumericalMeasureField .
fieldId	string	The custom field ID.
aggregationFunction?	IResolvable | NumericalAggregationFunctionProperty	The aggregation function of the measure field.
formatConfiguration?	IResolvable | NumberFormatConfigurationProperty	The 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.