Interface CfnDashboard.HistogramConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDashboard.HistogramConfigurationProperty.Jsii$Proxy
- Enclosing class:
- CfnDashboard
@Stability(Stable)
public static interface CfnDashboard.HistogramConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
The configuration for a
HistogramVisual .
Example:
// 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.*;
Object dataDriven;
HistogramConfigurationProperty histogramConfigurationProperty = HistogramConfigurationProperty.builder()
.binOptions(HistogramBinOptionsProperty.builder()
.binCount(BinCountOptionsProperty.builder()
.value(123)
.build())
.binWidth(BinWidthOptionsProperty.builder()
.binCountLimit(123)
.value(123)
.build())
.selectedBinType("selectedBinType")
.startValue(123)
.build())
.dataLabels(DataLabelOptionsProperty.builder()
.categoryLabelVisibility("categoryLabelVisibility")
.dataLabelTypes(List.of(DataLabelTypeProperty.builder()
.dataPathLabelType(DataPathLabelTypeProperty.builder()
.fieldId("fieldId")
.fieldValue("fieldValue")
.visibility("visibility")
.build())
.fieldLabelType(FieldLabelTypeProperty.builder()
.fieldId("fieldId")
.visibility("visibility")
.build())
.maximumLabelType(MaximumLabelTypeProperty.builder()
.visibility("visibility")
.build())
.minimumLabelType(MinimumLabelTypeProperty.builder()
.visibility("visibility")
.build())
.rangeEndsLabelType(RangeEndsLabelTypeProperty.builder()
.visibility("visibility")
.build())
.build()))
.labelColor("labelColor")
.labelContent("labelContent")
.labelFontConfiguration(FontConfigurationProperty.builder()
.fontColor("fontColor")
.fontDecoration("fontDecoration")
.fontSize(FontSizeProperty.builder()
.relative("relative")
.build())
.fontStyle("fontStyle")
.fontWeight(FontWeightProperty.builder()
.name("name")
.build())
.build())
.measureLabelVisibility("measureLabelVisibility")
.overlap("overlap")
.position("position")
.visibility("visibility")
.build())
.fieldWells(HistogramFieldWellsProperty.builder()
.histogramAggregatedFieldWells(HistogramAggregatedFieldWellsProperty.builder()
.values(List.of(MeasureFieldProperty.builder()
.calculatedMeasureField(CalculatedMeasureFieldProperty.builder()
.expression("expression")
.fieldId("fieldId")
.build())
.categoricalMeasureField(CategoricalMeasureFieldProperty.builder()
.column(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build())
.fieldId("fieldId")
// the properties below are optional
.aggregationFunction("aggregationFunction")
.formatConfiguration(StringFormatConfigurationProperty.builder()
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
.currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numberScale("numberScale")
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.symbol("symbol")
.build())
.numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numberScale("numberScale")
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.build())
.percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.build())
.build())
.build())
.build())
.dateMeasureField(DateMeasureFieldProperty.builder()
.column(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build())
.fieldId("fieldId")
// the properties below are optional
.aggregationFunction("aggregationFunction")
.formatConfiguration(DateTimeFormatConfigurationProperty.builder()
.dateTimeFormat("dateTimeFormat")
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
.currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numberScale("numberScale")
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.symbol("symbol")
.build())
.numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numberScale("numberScale")
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.build())
.percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.build())
.build())
.build())
.build())
.numericalMeasureField(NumericalMeasureFieldProperty.builder()
.column(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build())
.fieldId("fieldId")
// the properties below are optional
.aggregationFunction(NumericalAggregationFunctionProperty.builder()
.percentileAggregation(PercentileAggregationProperty.builder()
.percentileValue(123)
.build())
.simpleNumericalAggregation("simpleNumericalAggregation")
.build())
.formatConfiguration(NumberFormatConfigurationProperty.builder()
.formatConfiguration(NumericFormatConfigurationProperty.builder()
.currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numberScale("numberScale")
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.symbol("symbol")
.build())
.numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.numberScale("numberScale")
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.build())
.percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
.decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
.decimalPlaces(123)
.build())
.negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
.displayMode("displayMode")
.build())
.nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
.nullString("nullString")
.build())
.prefix("prefix")
.separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
.decimalSeparator("decimalSeparator")
.thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
.symbol("symbol")
.visibility("visibility")
.build())
.build())
.suffix("suffix")
.build())
.build())
.build())
.build())
.build()))
.build())
.build())
.tooltip(TooltipOptionsProperty.builder()
.fieldBasedTooltip(FieldBasedTooltipProperty.builder()
.aggregationVisibility("aggregationVisibility")
.tooltipFields(List.of(TooltipItemProperty.builder()
.columnTooltipItem(ColumnTooltipItemProperty.builder()
.column(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build())
// the properties below are optional
.aggregation(AggregationFunctionProperty.builder()
.categoricalAggregationFunction("categoricalAggregationFunction")
.dateAggregationFunction("dateAggregationFunction")
.numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
.percentileAggregation(PercentileAggregationProperty.builder()
.percentileValue(123)
.build())
.simpleNumericalAggregation("simpleNumericalAggregation")
.build())
.build())
.label("label")
.visibility("visibility")
.build())
.fieldTooltipItem(FieldTooltipItemProperty.builder()
.fieldId("fieldId")
// the properties below are optional
.label("label")
.visibility("visibility")
.build())
.build()))
.tooltipTitleType("tooltipTitleType")
.build())
.selectedTooltipType("selectedTooltipType")
.tooltipVisibility("tooltipVisibility")
.build())
.visualPalette(VisualPaletteProperty.builder()
.chartColor("chartColor")
.colorMap(List.of(DataPathColorProperty.builder()
.color("color")
.element(DataPathValueProperty.builder()
.fieldId("fieldId")
.fieldValue("fieldValue")
.build())
// the properties below are optional
.timeGranularity("timeGranularity")
.build()))
.build())
.xAxisDisplayOptions(AxisDisplayOptionsProperty.builder()
.axisLineVisibility("axisLineVisibility")
.axisOffset("axisOffset")
.dataOptions(AxisDataOptionsProperty.builder()
.dateAxisOptions(DateAxisOptionsProperty.builder()
.missingDateVisibility("missingDateVisibility")
.build())
.numericAxisOptions(NumericAxisOptionsProperty.builder()
.range(AxisDisplayRangeProperty.builder()
.dataDriven(dataDriven)
.minMax(AxisDisplayMinMaxRangeProperty.builder()
.maximum(123)
.minimum(123)
.build())
.build())
.scale(AxisScaleProperty.builder()
.linear(AxisLinearScaleProperty.builder()
.stepCount(123)
.stepSize(123)
.build())
.logarithmic(AxisLogarithmicScaleProperty.builder()
.base(123)
.build())
.build())
.build())
.build())
.gridLineVisibility("gridLineVisibility")
.scrollbarOptions(ScrollBarOptionsProperty.builder()
.visibility("visibility")
.visibleRange(VisibleRangeOptionsProperty.builder()
.percentRange(PercentVisibleRangeProperty.builder()
.from(123)
.to(123)
.build())
.build())
.build())
.tickLabelOptions(AxisTickLabelOptionsProperty.builder()
.labelOptions(LabelOptionsProperty.builder()
.customLabel("customLabel")
.fontConfiguration(FontConfigurationProperty.builder()
.fontColor("fontColor")
.fontDecoration("fontDecoration")
.fontSize(FontSizeProperty.builder()
.relative("relative")
.build())
.fontStyle("fontStyle")
.fontWeight(FontWeightProperty.builder()
.name("name")
.build())
.build())
.visibility("visibility")
.build())
.rotationAngle(123)
.build())
.build())
.xAxisLabelOptions(ChartAxisLabelOptionsProperty.builder()
.axisLabelOptions(List.of(AxisLabelOptionsProperty.builder()
.applyTo(AxisLabelReferenceOptionsProperty.builder()
.column(ColumnIdentifierProperty.builder()
.columnName("columnName")
.dataSetIdentifier("dataSetIdentifier")
.build())
.fieldId("fieldId")
.build())
.customLabel("customLabel")
.fontConfiguration(FontConfigurationProperty.builder()
.fontColor("fontColor")
.fontDecoration("fontDecoration")
.fontSize(FontSizeProperty.builder()
.relative("relative")
.build())
.fontStyle("fontStyle")
.fontWeight(FontWeightProperty.builder()
.name("name")
.build())
.build())
.build()))
.sortIconVisibility("sortIconVisibility")
.visibility("visibility")
.build())
.yAxisDisplayOptions(AxisDisplayOptionsProperty.builder()
.axisLineVisibility("axisLineVisibility")
.axisOffset("axisOffset")
.dataOptions(AxisDataOptionsProperty.builder()
.dateAxisOptions(DateAxisOptionsProperty.builder()
.missingDateVisibility("missingDateVisibility")
.build())
.numericAxisOptions(NumericAxisOptionsProperty.builder()
.range(AxisDisplayRangeProperty.builder()
.dataDriven(dataDriven)
.minMax(AxisDisplayMinMaxRangeProperty.builder()
.maximum(123)
.minimum(123)
.build())
.build())
.scale(AxisScaleProperty.builder()
.linear(AxisLinearScaleProperty.builder()
.stepCount(123)
.stepSize(123)
.build())
.logarithmic(AxisLogarithmicScaleProperty.builder()
.base(123)
.build())
.build())
.build())
.build())
.gridLineVisibility("gridLineVisibility")
.scrollbarOptions(ScrollBarOptionsProperty.builder()
.visibility("visibility")
.visibleRange(VisibleRangeOptionsProperty.builder()
.percentRange(PercentVisibleRangeProperty.builder()
.from(123)
.to(123)
.build())
.build())
.build())
.tickLabelOptions(AxisTickLabelOptionsProperty.builder()
.labelOptions(LabelOptionsProperty.builder()
.customLabel("customLabel")
.fontConfiguration(FontConfigurationProperty.builder()
.fontColor("fontColor")
.fontDecoration("fontDecoration")
.fontSize(FontSizeProperty.builder()
.relative("relative")
.build())
.fontStyle("fontStyle")
.fontWeight(FontWeightProperty.builder()
.name("name")
.build())
.build())
.visibility("visibility")
.build())
.rotationAngle(123)
.build())
.build())
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDashboard.HistogramConfigurationPropertystatic final classAn implementation forCfnDashboard.HistogramConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe options that determine the presentation of histogram bins.default ObjectThe data label configuration of a histogram.default ObjectThe field well configuration of a histogram.default ObjectThe tooltip configuration of a histogram.default ObjectThe visual palette configuration of a histogram.default ObjectThe options that determine the presentation of the x-axis.default ObjectThe options that determine the presentation of the x-axis label.default ObjectThe options that determine the presentation of the y-axis.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBinOptions
The options that determine the presentation of histogram bins. -
getDataLabels
The data label configuration of a histogram. -
getFieldWells
The field well configuration of a histogram. -
getTooltip
The tooltip configuration of a histogram. -
getVisualPalette
The visual palette configuration of a histogram. -
getXAxisDisplayOptions
The options that determine the presentation of the x-axis. -
getXAxisLabelOptions
The options that determine the presentation of the x-axis label. -
getYAxisDisplayOptions
The options that determine the presentation of the y-axis. -
builder
-