Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnTemplatePropsMixin.BarChartConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplatePropsMixin.BarChartConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplatePropsMixin

@Stability(Stable)
public static interface CfnTemplatePropsMixin.BarChartConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration of a BarChartVisual .

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplatePropsMixin.BarChartConfigurationProperty.Builder	A builder for CfnTemplatePropsMixin.BarChartConfigurationProperty
static final class	CfnTemplatePropsMixin.BarChartConfigurationProperty.Jsii$Proxy	An implementation for CfnTemplatePropsMixin.BarChartConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplatePropsMixin.BarChartConfigurationProperty.Builder	builder()
default String	getBarsArrangement()	Determines the arrangement of the bars.
default Object	getCategoryAxis()	The label display options (grid line, range, scale, axis step) for bar chart category.
default Object	getCategoryLabelOptions()	The label options (label text, label visibility and sort icon visibility) for a bar chart.
default Object	getColorLabelOptions()	The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
default Object	getContributionAnalysisDefaults()	The contribution analysis (anomaly configuration) setup of the visual.
default Object	getDataLabels()	The options that determine if visual data labels are displayed.
default Object	getFieldWells()	The field wells of the visual.
default Object	getInteractions()	The general visual interactions setup for a visual.
default Object	getLegend()	The legend display setup of the visual.
default String	getOrientation()	The orientation of the bars in a bar chart visual.
default Object	getReferenceLines()	The reference line setup of the visual.
default Object	getSmallMultiplesOptions()	The small multiples setup for the visual.
default Object	getSortConfiguration()	The sort configuration of a BarChartVisual .
default Object	getTooltip()	The tooltip display setup of the visual.
default Object	getValueAxis()	The label display options (grid line, range, scale, axis step) for a bar chart value.
default Object	getValueLabelOptions()	The label options (label text, label visibility and sort icon visibility) for a bar chart value.
default Object	getVisualPalette()	The palette (chart color) display setup of the visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBarsArrangement

@Stability(Stable)
@Nullable
default String getBarsArrangement()

Determines the arrangement of the bars.

The orientation and arrangement of bars determine the type of bar that is used in the visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-barsarrangement

getCategoryAxis

@Stability(Stable)
@Nullable
default Object getCategoryAxis()

The label display options (grid line, range, scale, axis step) for bar chart category.

Returns union: either IResolvable or CfnTemplatePropsMixin.AxisDisplayOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-categoryaxis

getCategoryLabelOptions

@Stability(Stable)
@Nullable
default Object getCategoryLabelOptions()

The label options (label text, label visibility and sort icon visibility) for a bar chart.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-categorylabeloptions

getColorLabelOptions

@Stability(Stable)
@Nullable
default Object getColorLabelOptions()

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-colorlabeloptions

getContributionAnalysisDefaults

@Stability(Stable)
@Nullable
default Object getContributionAnalysisDefaults()

The contribution analysis (anomaly configuration) setup of the visual.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplatePropsMixin.ContributionAnalysisDefaultProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-contributionanalysisdefaults

getDataLabels

@Stability(Stable)
@Nullable
default Object getDataLabels()

The options that determine if visual data labels are displayed.

Returns union: either IResolvable or CfnTemplatePropsMixin.DataLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-datalabels

getFieldWells

@Stability(Stable)
@Nullable
default Object getFieldWells()

The field wells of the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.BarChartFieldWellsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-fieldwells

getInteractions

@Stability(Stable)
@Nullable
default Object getInteractions()

The general visual interactions setup for a visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.VisualInteractionOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-interactions

getLegend

@Stability(Stable)
@Nullable
default Object getLegend()

The legend display setup of the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.LegendOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-legend

getOrientation

@Stability(Stable)
@Nullable
default String getOrientation()

The orientation of the bars in a bar chart visual. There are two valid values in this structure:.

• HORIZONTAL : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
• VERTICAL : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-orientation

getReferenceLines

@Stability(Stable)
@Nullable
default Object getReferenceLines()

The reference line setup of the visual.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplatePropsMixin.ReferenceLineProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-referencelines

getSmallMultiplesOptions

@Stability(Stable)
@Nullable
default Object getSmallMultiplesOptions()

The small multiples setup for the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.SmallMultiplesOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-smallmultiplesoptions

getSortConfiguration

@Stability(Stable)
@Nullable
default Object getSortConfiguration()

The sort configuration of a BarChartVisual .

Returns union: either IResolvable or CfnTemplatePropsMixin.BarChartSortConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-sortconfiguration

getTooltip

@Stability(Stable)
@Nullable
default Object getTooltip()

The tooltip display setup of the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.TooltipOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-tooltip

getValueAxis

@Stability(Stable)
@Nullable
default Object getValueAxis()

The label display options (grid line, range, scale, axis step) for a bar chart value.

Returns union: either IResolvable or CfnTemplatePropsMixin.AxisDisplayOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-valueaxis

getValueLabelOptions

@Stability(Stable)
@Nullable
default Object getValueLabelOptions()

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-valuelabeloptions

getVisualPalette

@Stability(Stable)
@Nullable
default Object getVisualPalette()

The palette (chart color) display setup of the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.VisualPaletteProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-visualpalette

builder

@Stability(Stable)
static CfnTemplatePropsMixin.BarChartConfigurationProperty.Builder builder()

Returns:

a CfnTemplatePropsMixin.BarChartConfigurationProperty.Builder of CfnTemplatePropsMixin.BarChartConfigurationProperty