Skip to content
v2.278.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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

display_format_options_property = quicksight.CfnTopic.DisplayFormatOptionsProperty(
    blank_cell_format="blankCellFormat",
    currency_symbol="currencySymbol",
    date_format="dateFormat",
    decimal_separator="decimalSeparator",
    fraction_digits=123,
    grouping_separator="groupingSeparator",
    negative_format=quicksight.CfnTopic.NegativeFormatProperty(
        prefix="prefix",
        suffix="suffix"
    ),
    prefix="prefix",
    suffix="suffix",
    unit_scaler="unitScaler",
    use_blank_cell_format=False,
    use_grouping=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

DisplayFormatOptionsProperty displayFormatOptionsProperty = DisplayFormatOptionsProperty.builder()
        .blankCellFormat("blankCellFormat")
        .currencySymbol("currencySymbol")
        .dateFormat("dateFormat")
        .decimalSeparator("decimalSeparator")
        .fractionDigits(123)
        .groupingSeparator("groupingSeparator")
        .negativeFormat(NegativeFormatProperty.builder()
                .prefix("prefix")
                .suffix("suffix")
                .build())
        .prefix("prefix")
        .suffix("suffix")
        .unitScaler("unitScaler")
        .useBlankCellFormat(false)
        .useGrouping(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var displayFormatOptionsProperty = new DisplayFormatOptionsProperty {
    BlankCellFormat = "blankCellFormat",
    CurrencySymbol = "currencySymbol",
    DateFormat = "dateFormat",
    DecimalSeparator = "decimalSeparator",
    FractionDigits = 123,
    GroupingSeparator = "groupingSeparator",
    NegativeFormat = new NegativeFormatProperty {
        Prefix = "prefix",
        Suffix = "suffix"
    },
    Prefix = "prefix",
    Suffix = "suffix",
    UnitScaler = "unitScaler",
    UseBlankCellFormat = false,
    UseGrouping = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

displayFormatOptionsProperty := &DisplayFormatOptionsProperty{
	BlankCellFormat: jsii.String("blankCellFormat"),
	CurrencySymbol: jsii.String("currencySymbol"),
	DateFormat: jsii.String("dateFormat"),
	DecimalSeparator: jsii.String("decimalSeparator"),
	FractionDigits: jsii.Number(123),
	GroupingSeparator: jsii.String("groupingSeparator"),
	NegativeFormat: &NegativeFormatProperty{
		Prefix: jsii.String("prefix"),
		Suffix: jsii.String("suffix"),
	},
	Prefix: jsii.String("prefix"),
	Suffix: jsii.String("suffix"),
	UnitScaler: jsii.String("unitScaler"),
	UseBlankCellFormat: jsii.Boolean(false),
	UseGrouping: jsii.Boolean(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.