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

Interface CfnTemplatePropsMixin.ComboChartConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplatePropsMixin.ComboChartConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplatePropsMixin

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

The configuration of a ComboChartVisual .

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplatePropsMixin.ComboChartConfigurationProperty.Builder	builder()
default Object	getBarDataLabels()	The options that determine if visual data labels are displayed.
default String	getBarsArrangement()	Determines the bar arrangement in a combo chart.
default Object	getCategoryAxis()	The category axis of a combo chart.
default Object	getCategoryLabelOptions()	The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
default Object	getColorLabelOptions()	The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
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 Object	getLineDataLabels()	The options that determine if visual data labels are displayed.
default Object	getPrimaryYAxisDisplayOptions()	The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
default Object	getPrimaryYAxisLabelOptions()	The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
default Object	getReferenceLines()	The reference line setup of the visual.
default Object	getSecondaryYAxisDisplayOptions()	The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
default Object	getSecondaryYAxisLabelOptions()	The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
default Object	getSingleAxisOptions()	Returns union: either IResolvable or CfnTemplatePropsMixin.SingleAxisOptionsProperty
default Object	getSortConfiguration()	The sort configuration of a ComboChartVisual .
default Object	getTooltip()	The legend display setup of the visual.
default Object	getVisualPalette()	The palette (chart color) display setup of the visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBarDataLabels

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

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

Returns union: either IResolvable or CfnTemplatePropsMixin.DataLabelOptionsProperty

See Also:

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

getBarsArrangement

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

Determines the bar arrangement in a combo chart. The following are valid values in this structure:.

• CLUSTERED : For clustered bar combo charts.
• STACKED : For stacked bar combo charts.
• STACKED_PERCENT : Do not use. If you use this value, the operation returns a validation error.

See Also:

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

getCategoryAxis

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

The category axis of a combo chart.

Returns union: either IResolvable or CfnTemplatePropsMixin.AxisDisplayOptionsProperty

See Also:

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

getCategoryLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

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

getColorLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

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

getFieldWells

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

The field wells of the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.ComboChartFieldWellsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-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-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-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-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-legend

getLineDataLabels

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

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

Returns union: either IResolvable or CfnTemplatePropsMixin.DataLabelOptionsProperty

See Also:

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

getPrimaryYAxisDisplayOptions

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

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

Returns union: either IResolvable or CfnTemplatePropsMixin.AxisDisplayOptionsProperty

See Also:

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

getPrimaryYAxisLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

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

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-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-referencelines

getSecondaryYAxisDisplayOptions

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

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

Returns union: either IResolvable or CfnTemplatePropsMixin.AxisDisplayOptionsProperty

See Also:

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

getSecondaryYAxisLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

Returns union: either IResolvable or CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty

See Also:

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

getSingleAxisOptions

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

Returns union: either IResolvable or CfnTemplatePropsMixin.SingleAxisOptionsProperty

See Also:

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

getSortConfiguration

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

The sort configuration of a ComboChartVisual .

Returns union: either IResolvable or CfnTemplatePropsMixin.ComboChartSortConfigurationProperty

See Also:

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

getTooltip

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

The legend 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-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-tooltip

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-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-visualpalette

builder

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

Returns:

a CfnTemplatePropsMixin.ComboChartConfigurationProperty.Builder of CfnTemplatePropsMixin.ComboChartConfigurationProperty