Class CfnAnalysis.HistogramConfigurationProperty
The configuration for a HistogramVisual .
Inheritance
System.Object
CfnAnalysis.HistogramConfigurationProperty
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class HistogramConfigurationProperty : Object, CfnAnalysis.IHistogramConfigurationPropertySyntax (vb)
Public Class HistogramConfigurationProperty
Inherits Object
Implements CfnAnalysis.IHistogramConfigurationPropertyRemarks
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 dataDriven;
var histogramConfigurationProperty = new HistogramConfigurationProperty {
BinOptions = new HistogramBinOptionsProperty {
BinCount = new BinCountOptionsProperty {
Value = 123
},
BinWidth = new BinWidthOptionsProperty {
BinCountLimit = 123,
Value = 123
},
SelectedBinType = "selectedBinType",
StartValue = 123
},
DataLabels = new DataLabelOptionsProperty {
CategoryLabelVisibility = "categoryLabelVisibility",
DataLabelTypes = new [] { new DataLabelTypeProperty {
DataPathLabelType = new DataPathLabelTypeProperty {
FieldId = "fieldId",
FieldValue = "fieldValue",
Visibility = "visibility"
},
FieldLabelType = new FieldLabelTypeProperty {
FieldId = "fieldId",
Visibility = "visibility"
},
MaximumLabelType = new MaximumLabelTypeProperty {
Visibility = "visibility"
},
MinimumLabelType = new MinimumLabelTypeProperty {
Visibility = "visibility"
},
RangeEndsLabelType = new RangeEndsLabelTypeProperty {
Visibility = "visibility"
}
} },
LabelColor = "labelColor",
LabelContent = "labelContent",
LabelFontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
MeasureLabelVisibility = "measureLabelVisibility",
Overlap = "overlap",
Position = "position",
Visibility = "visibility"
},
FieldWells = new HistogramFieldWellsProperty {
HistogramAggregatedFieldWells = new HistogramAggregatedFieldWellsProperty {
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"
}
}
}
}
} }
}
},
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"
},
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"
} }
},
XAxisDisplayOptions = new AxisDisplayOptionsProperty {
AxisLineVisibility = "axisLineVisibility",
AxisOffset = "axisOffset",
DataOptions = new AxisDataOptionsProperty {
DateAxisOptions = new DateAxisOptionsProperty {
MissingDateVisibility = "missingDateVisibility"
},
NumericAxisOptions = new NumericAxisOptionsProperty {
Range = new AxisDisplayRangeProperty {
DataDriven = dataDriven,
MinMax = new AxisDisplayMinMaxRangeProperty {
Maximum = 123,
Minimum = 123
}
},
Scale = new AxisScaleProperty {
Linear = new AxisLinearScaleProperty {
StepCount = 123,
StepSize = 123
},
Logarithmic = new AxisLogarithmicScaleProperty {
Base = 123
}
}
}
},
GridLineVisibility = "gridLineVisibility",
ScrollbarOptions = new ScrollBarOptionsProperty {
Visibility = "visibility",
VisibleRange = new VisibleRangeOptionsProperty {
PercentRange = new PercentVisibleRangeProperty {
From = 123,
To = 123
}
}
},
TickLabelOptions = new AxisTickLabelOptionsProperty {
LabelOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
},
RotationAngle = 123
}
},
XAxisLabelOptions = 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"
},
YAxisDisplayOptions = new AxisDisplayOptionsProperty {
AxisLineVisibility = "axisLineVisibility",
AxisOffset = "axisOffset",
DataOptions = new AxisDataOptionsProperty {
DateAxisOptions = new DateAxisOptionsProperty {
MissingDateVisibility = "missingDateVisibility"
},
NumericAxisOptions = new NumericAxisOptionsProperty {
Range = new AxisDisplayRangeProperty {
DataDriven = dataDriven,
MinMax = new AxisDisplayMinMaxRangeProperty {
Maximum = 123,
Minimum = 123
}
},
Scale = new AxisScaleProperty {
Linear = new AxisLinearScaleProperty {
StepCount = 123,
StepSize = 123
},
Logarithmic = new AxisLogarithmicScaleProperty {
Base = 123
}
}
}
},
GridLineVisibility = "gridLineVisibility",
ScrollbarOptions = new ScrollBarOptionsProperty {
Visibility = "visibility",
VisibleRange = new VisibleRangeOptionsProperty {
PercentRange = new PercentVisibleRangeProperty {
From = 123,
To = 123
}
}
},
TickLabelOptions = new AxisTickLabelOptionsProperty {
LabelOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
},
RotationAngle = 123
}
}
};Synopsis
Constructors
| HistogramConfigurationProperty() |
Properties
| BinOptions | The options that determine the presentation of histogram bins. |
| DataLabels | The data label configuration of a histogram. |
| FieldWells | The field well configuration of a histogram. |
| Tooltip | The tooltip configuration of a histogram. |
| VisualPalette | The visual palette configuration of a histogram. |
| XAxisDisplayOptions | The options that determine the presentation of the x-axis. |
| XAxisLabelOptions | The options that determine the presentation of the x-axis label. |
| YAxisDisplayOptions | The options that determine the presentation of the y-axis. |
Constructors
HistogramConfigurationProperty()
public HistogramConfigurationProperty()Properties
BinOptions
The options that determine the presentation of histogram bins.
public object BinOptions { get; set; }Property Value
System.Object
Remarks
DataLabels
The data label configuration of a histogram.
public object DataLabels { get; set; }Property Value
System.Object
Remarks
FieldWells
The field well configuration of a histogram.
public object FieldWells { get; set; }Property Value
System.Object
Remarks
Tooltip
The tooltip configuration of a histogram.
public object Tooltip { get; set; }Property Value
System.Object
Remarks
VisualPalette
The visual palette configuration of a histogram.
public object VisualPalette { get; set; }Property Value
System.Object
Remarks
XAxisDisplayOptions
The options that determine the presentation of the x-axis.
public object XAxisDisplayOptions { get; set; }Property Value
System.Object
Remarks
XAxisLabelOptions
The options that determine the presentation of the x-axis label.
public object XAxisLabelOptions { get; set; }Property Value
System.Object
Remarks
YAxisDisplayOptions
The options that determine the presentation of the y-axis.
public object YAxisDisplayOptions { get; set; }Property Value
System.Object