AWS::QuickSight::Template BarChartConfiguration

The configuration of a BarChartVisual.

Syntax

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

JSON


{
  "BarsArrangement" : String,
  "CategoryAxis" : AxisDisplayOptions,
  "CategoryLabelOptions" : ChartAxisLabelOptions,
  "ColorLabelOptions" : ChartAxisLabelOptions,
  "ContributionAnalysisDefaults" : [ ContributionAnalysisDefault, ... ],
  "DataLabels" : DataLabelOptions,
  "FieldWells" : BarChartFieldWells,
  "Legend" : LegendOptions,
  "Orientation" : String,
  "ReferenceLines" : [ ReferenceLine, ... ],
  "SmallMultiplesOptions" : SmallMultiplesOptions,
  "SortConfiguration" : BarChartSortConfiguration,
  "Tooltip" : TooltipOptions,
  "ValueAxis" : AxisDisplayOptions,
  "ValueLabelOptions" : ChartAxisLabelOptions,
  "VisualPalette" : VisualPalette
}

YAML


  BarsArrangement: String
  CategoryAxis: 
    AxisDisplayOptions
  CategoryLabelOptions: 
    ChartAxisLabelOptions
  ColorLabelOptions: 
    ChartAxisLabelOptions
  ContributionAnalysisDefaults: 
    - ContributionAnalysisDefault
  DataLabels: 
    DataLabelOptions
  FieldWells: 
    BarChartFieldWells
  Legend: 
    LegendOptions
  Orientation: String
  ReferenceLines: 
    - ReferenceLine
  SmallMultiplesOptions: 
    SmallMultiplesOptions
  SortConfiguration: 
    BarChartSortConfiguration
  Tooltip: 
    TooltipOptions
  ValueAxis: 
    AxisDisplayOptions
  ValueLabelOptions: 
    ChartAxisLabelOptions
  VisualPalette: 
    VisualPalette

Properties

BarsArrangement

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

Required: No

Type: String

Allowed values: CLUSTERED | STACKED | STACKED_PERCENT

Update requires: No interruption

CategoryAxis

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

Required: No

Type: AxisDisplayOptions

Update requires: No interruption

CategoryLabelOptions

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

Required: No

Type: ChartAxisLabelOptions

Update requires: No interruption

ColorLabelOptions

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

Required: No

Type: ChartAxisLabelOptions

Update requires: No interruption

ContributionAnalysisDefaults

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

Required: No

Type: Array of ContributionAnalysisDefault

Minimum: 1

Maximum: 200

Update requires: No interruption

DataLabels

The options that determine if visual data labels are displayed.

Required: No

Type: DataLabelOptions

Update requires: No interruption

FieldWells

The field wells of the visual.

Required: No

Type: BarChartFieldWells

Update requires: No interruption

Legend

The legend display setup of the visual.

Required: No

Type: LegendOptions

Update requires: No interruption

Orientation

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.

Required: No

Type: String

Allowed values: HORIZONTAL | VERTICAL

Update requires: No interruption

ReferenceLines