BarChartConfiguration
The configuration of a BarChartVisual.
Contents
Note
In the following list, the required parameters are described first.
- BarsArrangement
-
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
Type: String
Valid Values:
CLUSTERED | STACKED | STACKED_PERCENTRequired: No
- CategoryAxis
-
The label display options (grid line, range, scale, axis step) for bar chart category.
Type: AxisDisplayOptions object
Required: No
- CategoryLabelOptions
-
The label options (label text, label visibility and sort icon visibility) for a bar chart.
Type: ChartAxisLabelOptions object
Required: No
- ColorLabelOptions
-
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
Type: ChartAxisLabelOptions object
Required: No
- ContributionAnalysisDefaults
-
The contribution analysis (anomaly configuration) setup of the visual.
Type: Array of ContributionAnalysisDefault objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
- DataLabels
-
The options that determine if visual data labels are displayed.
Type: DataLabelOptions object
Required: No
- FieldWells
-
The field wells of the visual.
Type: BarChartFieldWells object
Required: No
- Interactions
-
The general visual interactions setup for a visual.
Type: VisualInteractionOptions object
Required: No
- Legend
-
The legend display setup of the visual.
Type: LegendOptions object
Required: No
- 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.
Type: String
Valid Values:
HORIZONTAL | VERTICALRequired: No
-
- ReferenceLines
-
The reference line setup of the visual.
Type: Array of ReferenceLine objects
Array Members: Maximum number of 20 items.
Required: No
- SmallMultiplesOptions
-
The small multiples setup for the visual.
Type: SmallMultiplesOptions object
Required: No
- SortConfiguration
-
The sort configuration of a
BarChartVisual.Type: BarChartSortConfiguration object
Required: No
- Tooltip
-
The tooltip display setup of the visual.
Type: TooltipOptions object
Required: No
- ValueAxis
-
The label display options (grid line, range, scale, axis step) for a bar chart value.
Type: AxisDisplayOptions object
Required: No
- ValueLabelOptions
-
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
Type: ChartAxisLabelOptions object
Required: No
- VisualPalette
-
The palette (chart color) display setup of the visual.
Type: VisualPalette object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: