Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.BarChartVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.BarChartVisualProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.BarChartVisualProperty
extends software.amazon.jsii.JsiiSerializable

A bar chart.

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

• Horizontal bar chart
• Vertical bar chart
• Horizontal stacked bar chart
• Vertical stacked bar chart
• Horizontal stacked 100% bar chart
• Vertical stacked 100% bar chart

For more information, see Using bar charts in the Amazon Quick Suite User Guide .

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.BarChartVisualProperty.Builder	builder()
default Object	getActions()	The list of custom actions that are configured for a visual.
default Object	getChartConfiguration()	The configuration settings of the visual.
default Object	getColumnHierarchies()	The column hierarchy that is used during drill-downs and drill-ups.
default Object	getSubtitle()	The subtitle that is displayed on the visual.
default Object	getTitle()	The title that is displayed on the visual.
default String	getVisualContentAltText()	The alt text for the visual.
String	getVisualId()	The unique identifier of a visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVisualId

@Stability(Stable)
@NotNull
String getVisualId()

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See Also:

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

getActions

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

The list of custom actions that are configured for a visual.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.VisualCustomActionProperty>

See Also:

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

getChartConfiguration

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

The configuration settings of the visual.

Returns union: either IResolvable or CfnTemplate.BarChartConfigurationProperty

See Also:

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

getColumnHierarchies

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

The column hierarchy that is used during drill-downs and drill-ups.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.ColumnHierarchyProperty>

See Also:

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

getSubtitle

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

The subtitle that is displayed on the visual.

Returns union: either IResolvable or CfnTemplate.VisualSubtitleLabelOptionsProperty

See Also:

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

getTitle

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

The title that is displayed on the visual.

Returns union: either IResolvable or CfnTemplate.VisualTitleLabelOptionsProperty

See Also:

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

getVisualContentAltText

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

The alt text for the visual.

See Also:

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

builder

@Stability(Stable)
static CfnTemplate.BarChartVisualProperty.Builder builder()

Returns:

a CfnTemplate.BarChartVisualProperty.Builder of CfnTemplate.BarChartVisualProperty