Skip to content
v2.274.0

DisplayFormatOptionsProperty Struct ​

A structure that represents additional options for display formatting.

Example ​

ts
// 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 ​

blankCellFormatoptionalstringblank_cell_formatoptionalstrblankCellFormatoptionalStringBlankCellFormatoptionalstringBlankCellFormatoptional*string#
Determines the blank cell format.
currencySymboloptionalstringcurrency_symboloptionalstrcurrencySymboloptionalStringCurrencySymboloptionalstringCurrencySymboloptional*string#
The currency symbol, such as `USD` .
dateFormatoptionalstringdate_formatoptionalstrdateFormatoptionalStringDateFormatoptionalstringDateFormatoptional*string#
Determines the `DateTime` format.
decimalSeparatoroptionalstringdecimal_separatoroptionalstrdecimalSeparatoroptionalStringDecimalSeparatoroptionalstringDecimalSeparatoroptional*string#
Determines the decimal separator.
fractionDigitsoptionalnumberfraction_digitsoptionalint | floatfractionDigitsoptionalNumberFractionDigitsoptionaldoubleFractionDigitsoptional*float64= 0#
Determines the number of fraction digits.
groupingSeparatoroptionalstringgrouping_separatoroptionalstrgroupingSeparatoroptionalStringGroupingSeparatoroptionalstringGroupingSeparatoroptional*string#
Determines the grouping separator.
negativeFormatoptionalIResolvable | CfnTopic.NegativeFormatPropertynegative_formatoptionaltyping.Union[IResolvable, NegativeFormatProperty]negativeFormatoptionalIResolvableNegativeFormatoptionalIResolvableNegativeFormatoptionalinterface{}#
The negative format.
prefixoptionalstringprefixoptionalstrprefixoptionalStringPrefixoptionalstringPrefixoptional*string#
The prefix value for a display format.
suffixoptionalstringsuffixoptionalstrsuffixoptionalStringSuffixoptionalstringSuffixoptional*string#
The suffix value for a display format.
unitScaleroptionalstringunit_scaleroptionalstrunitScaleroptionalStringUnitScaleroptionalstringUnitScaleroptional*string#
The unit scaler.

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

useBlankCellFormatoptionalboolean | IResolvableuse_blank_cell_formatoptionaltyping.Union[bool, IResolvable]useBlankCellFormatoptionalBooleanUseBlankCellFormatoptionalboolUseBlankCellFormatoptionalinterface{}= false#
A Boolean value that indicates whether to use blank cell format.
useGroupingoptionalboolean | IResolvableuse_groupingoptionaltyping.Union[bool, IResolvable]useGroupingoptionalBooleanUseGroupingoptionalboolUseGroupingoptionalinterface{}= false#
A Boolean value that indicates whether to use grouping.