Interface CfnTemplate.IFunnelChartConfigurationProperty
The configuration of a FunnelChartVisual
.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public interface IFunnelChartConfigurationProperty
Syntax (vb)
Public Interface IFunnelChartConfigurationProperty
Remarks
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 funnelChartConfigurationProperty = new FunnelChartConfigurationProperty {
CategoryLabelOptions = new ChartAxisLabelOptionsProperty {
AxisLabelOptions = new [] { new AxisLabelOptionsProperty {
ApplyTo = new AxisLabelReferenceOptionsProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId"
},
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
}
} },
SortIconVisibility = "sortIconVisibility",
Visibility = "visibility"
},
DataLabelOptions = new FunnelChartDataLabelOptionsProperty {
CategoryLabelVisibility = "categoryLabelVisibility",
LabelColor = "labelColor",
LabelFontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
MeasureDataLabelStyle = "measureDataLabelStyle",
MeasureLabelVisibility = "measureLabelVisibility",
Position = "position",
Visibility = "visibility"
},
FieldWells = new FunnelChartFieldWellsProperty {
FunnelChartAggregatedFieldWells = new FunnelChartAggregatedFieldWellsProperty {
Category = new [] { new DimensionFieldProperty {
CategoricalDimensionField = 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"
},
DateDimensionField = new DateDimensionFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
DateGranularity = "dateGranularity",
FormatConfiguration = new DateTimeFormatConfigurationProperty {
DateTimeFormat = "dateTimeFormat",
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"
},
NumericalDimensionField = new NumericalDimensionFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
FormatConfiguration = new NumberFormatConfigurationProperty {
FormatConfiguration = 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"
}
} },
Values = new [] { new MeasureFieldProperty {
CalculatedMeasureField = new CalculatedMeasureFieldProperty {
Expression = "expression",
FieldId = "fieldId"
},
CategoricalMeasureField = new CategoricalMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = "aggregationFunction",
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"
}
}
}
},
DateMeasureField = new DateMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = "aggregationFunction",
FormatConfiguration = new DateTimeFormatConfigurationProperty {
DateTimeFormat = "dateTimeFormat",
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"
}
}
}
},
NumericalMeasureField = new NumericalMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
},
FormatConfiguration = new NumberFormatConfigurationProperty {
FormatConfiguration = 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"
}
}
}
}
} }
}
},
SortConfiguration = new FunnelChartSortConfigurationProperty {
CategoryItemsLimit = new ItemsLimitConfigurationProperty {
ItemsLimit = 123,
OtherCategories = "otherCategories"
},
CategorySort = new [] { new FieldSortOptionsProperty {
ColumnSort = new ColumnSortProperty {
Direction = "direction",
SortBy = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
}
},
FieldSort = new FieldSortProperty {
Direction = "direction",
FieldId = "fieldId"
}
} }
},
Tooltip = new TooltipOptionsProperty {
FieldBasedTooltip = new FieldBasedTooltipProperty {
AggregationVisibility = "aggregationVisibility",
TooltipFields = new [] { new TooltipItemProperty {
ColumnTooltipItem = new ColumnTooltipItemProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
// the properties below are optional
Aggregation = new AggregationFunctionProperty {
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
},
Label = "label",
Visibility = "visibility"
},
FieldTooltipItem = new FieldTooltipItemProperty {
FieldId = "fieldId",
// the properties below are optional
Label = "label",
Visibility = "visibility"
}
} },
TooltipTitleType = "tooltipTitleType"
},
SelectedTooltipType = "selectedTooltipType",
TooltipVisibility = "tooltipVisibility"
},
ValueLabelOptions = new ChartAxisLabelOptionsProperty {
AxisLabelOptions = new [] { new AxisLabelOptionsProperty {
ApplyTo = new AxisLabelReferenceOptionsProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId"
},
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
}
} },
SortIconVisibility = "sortIconVisibility",
Visibility = "visibility"
},
VisualPalette = new VisualPaletteProperty {
ChartColor = "chartColor",
ColorMap = new [] { new DataPathColorProperty {
Color = "color",
Element = new DataPathValueProperty {
FieldId = "fieldId",
FieldValue = "fieldValue"
},
// the properties below are optional
TimeGranularity = "timeGranularity"
} }
}
};
Synopsis
Properties
CategoryLabelOptions | The label options of the categories that are displayed in a |
DataLabelOptions | The options that determine the presentation of the data labels. |
FieldWells | The field well configuration of a |
SortConfiguration | The sort configuration of a |
Tooltip | The tooltip configuration of a |
ValueLabelOptions | The label options for the values that are displayed in a |
VisualPalette | The visual palette configuration of a |
Properties
CategoryLabelOptions
The label options of the categories that are displayed in a FunnelChartVisual
.
virtual object CategoryLabelOptions { get; }
Property Value
System.Object
Remarks
DataLabelOptions
The options that determine the presentation of the data labels.
virtual object DataLabelOptions { get; }
Property Value
System.Object
Remarks
FieldWells
The field well configuration of a FunnelChartVisual
.
virtual object FieldWells { get; }
Property Value
System.Object
Remarks
SortConfiguration
The sort configuration of a FunnelChartVisual
.
virtual object SortConfiguration { get; }
Property Value
System.Object
Remarks
Tooltip
The tooltip configuration of a FunnelChartVisual
.
virtual object Tooltip { get; }
Property Value
System.Object
Remarks
ValueLabelOptions
The label options for the values that are displayed in a FunnelChartVisual
.
virtual object ValueLabelOptions { get; }
Property Value
System.Object
Remarks
VisualPalette
The visual palette configuration of a FunnelChartVisual
.
virtual object VisualPalette { get; }
Property Value
System.Object