interface DisplayFormatOptionsProperty

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

A structure that represents additional options for display formatting.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html

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 displayFormatOptionsProperty: quicksight.CfnTopic.DisplayFormatOptionsProperty = {
  blankCellFormat: 'blankCellFormat',
  currencySymbol: 'currencySymbol',
  dateFormat: 'dateFormat',
  decimalSeparator: 'decimalSeparator',
  fractionDigits: 123,
  groupingSeparator: 'groupingSeparator',
  negativeFormat: {
    prefix: 'prefix',
    suffix: 'suffix',
  },
  prefix: 'prefix',
  suffix: 'suffix',
  unitScaler: 'unitScaler',
  useBlankCellFormat: false,
  useGrouping: false,
};

Properties

Name	Type	Description
blankCellFormat?	string	Determines the blank cell format.
currencySymbol?	string	The currency symbol, such as USD .
dateFormat?	string	Determines the DateTime format.
decimalSeparator?	string	Determines the decimal separator.
fractionDigits?	number	Determines the number of fraction digits.
groupingSeparator?	string	Determines the grouping separator.
negativeFormat?	IResolvable | NegativeFormatProperty	The negative format.
prefix?	string	The prefix value for a display format.
suffix?	string	The suffix value for a display format.
unitScaler?	string	The unit scaler.
useBlankCellFormat?	boolean | IResolvable	A Boolean value that indicates whether to use blank cell format.
useGrouping?	boolean | IResolvable	A Boolean value that indicates whether to use grouping.

---

blankCellFormat?

Type: string (optional)

Determines the blank cell format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-blankcellformat

---

currencySymbol?

Type: string (optional)

The currency symbol, such as USD .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-currencysymbol

---

dateFormat?

Type: string (optional)

Determines the DateTime format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-dateformat

---

decimalSeparator?

Type: string (optional)

Determines the decimal separator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-decimalseparator

---

fractionDigits?

Type: number (optional, default: 0)

Determines the number of fraction digits.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-fractiondigits

---

groupingSeparator?

Type: string (optional)

Determines the grouping separator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-groupingseparator

---

negativeFormat?

Type: IResolvable | NegativeFormatProperty (optional)

The negative format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-negativeformat

---

prefix?

Type: string (optional)

The prefix value for a display format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-prefix

---

suffix?

Type: string (optional)

The suffix value for a display format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-suffix

---

unitScaler?

Type: string (optional)

The unit scaler.

Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-unitscaler

---

useBlankCellFormat?

Type: boolean | IResolvable (optional, default: false)

A Boolean value that indicates whether to use blank cell format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-useblankcellformat

---

useGrouping?

Type: boolean | IResolvable (optional, default: false)

A Boolean value that indicates whether to use grouping.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-usegrouping