aws-cdk-lib.aws_quicksight.CfnDashboard.NumericalDimensionFieldProperty

interface NumericalDimensionFieldProperty

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

The dimension 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 numericalDimensionFieldProperty: quicksight.CfnDashboard.NumericalDimensionFieldProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  fieldId: 'fieldId',

  // the properties below are optional
  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',
      },
    },
  },
  hierarchyId: 'hierarchyId',
};

Properties

NameTypeDescription
columnIResolvable | ColumnIdentifierPropertyThe column that is used in the NumericalDimensionField .
fieldIdstringThe custom field ID.
formatConfiguration?IResolvable | NumberFormatConfigurationPropertyThe format configuration of the field.
hierarchyId?stringThe custom hierarchy ID.

column

Type: IResolvable | ColumnIdentifierProperty

The column that is used in the NumericalDimensionField .


fieldId

Type: string

The custom field ID.


formatConfiguration?

Type: IResolvable | NumberFormatConfigurationProperty (optional)

The format configuration of the field.


hierarchyId?

Type: string (optional)

The custom hierarchy ID.