Class CfnDashboard.CategoricalDimensionFieldProperty

The dimension type field with categorical type columns..

Inheritance

System.Object

CfnDashboard.CategoricalDimensionFieldProperty

Implements

CfnDashboard.ICategoricalDimensionFieldProperty

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.AWS.QuickSight.dll

Syntax (csharp)

public class CategoricalDimensionFieldProperty : Object, CfnDashboard.ICategoricalDimensionFieldProperty

Syntax (vb)

Public Class CategoricalDimensionFieldProperty
    Inherits Object
    Implements CfnDashboard.ICategoricalDimensionFieldProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html

ExampleMetadata: fixture=_generated

Examples

// 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 categoricalDimensionFieldProperty = new CategoricalDimensionFieldProperty {
    Column = new ColumnIdentifierProperty {
        ColumnName = "columnName",
        DataSetIdentifier = "dataSetIdentifier"
    },
    FieldId = "fieldId",

    // the properties below are optional
    FormatConfiguration = new StringFormatConfigurationProperty {
        NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
            NullString = "nullString"
        },
        NumericFormatConfiguration = new NumericFormatConfigurationProperty {
            CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
                DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                    DecimalPlaces = 123
                },
                NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                    DisplayMode = "displayMode"
                },
                NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                    NullString = "nullString"
                },
                NumberScale = "numberScale",
                Prefix = "prefix",
                SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                    DecimalSeparator = "decimalSeparator",
                    ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                        Symbol = "symbol",
                        Visibility = "visibility"
                    }
                },
                Suffix = "suffix",
                Symbol = "symbol"
            },
            NumberDisplayFormatConfiguration = new NumberDisplayFormatConfigurationProperty {
                DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                    DecimalPlaces = 123
                },
                NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                    DisplayMode = "displayMode"
                },
                NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                    NullString = "nullString"
                },
                NumberScale = "numberScale",
                Prefix = "prefix",
                SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                    DecimalSeparator = "decimalSeparator",
                    ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                        Symbol = "symbol",
                        Visibility = "visibility"
                    }
                },
                Suffix = "suffix"
            },
            PercentageDisplayFormatConfiguration = new PercentageDisplayFormatConfigurationProperty {
                DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                    DecimalPlaces = 123
                },
                NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                    DisplayMode = "displayMode"
                },
                NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                    NullString = "nullString"
                },
                Prefix = "prefix",
                SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                    DecimalSeparator = "decimalSeparator",
                    ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                        Symbol = "symbol",
                        Visibility = "visibility"
                    }
                },
                Suffix = "suffix"
            }
        }
    },
    HierarchyId = "hierarchyId"
};

Synopsis

Constructors

CategoricalDimensionFieldProperty()

Properties

Column	The column that is used in the `CategoricalDimensionField` .
FieldId	The custom field ID.
FormatConfiguration	The format configuration of the field.
HierarchyId	The custom hierarchy ID.

Constructors

CategoricalDimensionFieldProperty()

public CategoricalDimensionFieldProperty()

Properties

Column

The column that is used in the CategoricalDimensionField .

public object Column { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-column

FieldId

The custom field ID.

public string FieldId { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-fieldid

FormatConfiguration

The format configuration of the field.

public object FormatConfiguration { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-formatconfiguration

HierarchyId

The custom hierarchy ID.

public string HierarchyId { get; set; }