AWS::QuickSight::Template BarChartVisual

Filter View

All

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 QuickSight User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Actions" : [ VisualCustomAction, ... ],
  "ChartConfiguration" : BarChartConfiguration,
  "ColumnHierarchies" : [ ColumnHierarchy, ... ],
  "Subtitle" : VisualSubtitleLabelOptions,
  "Title" : VisualTitleLabelOptions,
  "VisualContentAltText" : String,
  "VisualId" : String
}

YAML

  Actions: 
    - VisualCustomAction
  ChartConfiguration: 
    BarChartConfiguration
  ColumnHierarchies: 
    - ColumnHierarchy
  Subtitle: 
    VisualSubtitleLabelOptions
  Title: 
    VisualTitleLabelOptions
  VisualContentAltText: String
  VisualId: String

Properties

Actions

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

Required: No

Type: Array of VisualCustomAction

Minimum: 0

Maximum: 10

Update requires: No interruption

ChartConfiguration

The configuration settings of the visual.

Required: No

Type: BarChartConfiguration

Update requires: No interruption

ColumnHierarchies

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

Required: No

Type: Array of ColumnHierarchy

Minimum: 0

Maximum: 2

Update requires: No interruption

Subtitle

The subtitle that is displayed on the visual.

Required: No

Type: VisualSubtitleLabelOptions

Update requires: No interruption

Title

The title that is displayed on the visual.

Required: No

Type: VisualTitleLabelOptions

Update requires: No interruption

VisualContentAltText

The alt text for the visual.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

VisualId

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.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: No interruption