Bar Chart Configuration

Function: a!barChartConfig()

Contains configuration for how to display data in a bar chart. See the Bar Chart Component page for examples on using this configuration supporting function.

See also: Chart Configuration Using Records, Column Chart Config, Line Chart Config, Pie Chart Config, UX Charts Best Practices

Parameters

Name Keyword Type Description
Primary Grouping primaryGrouping Grouping Defines the field labels to display on the axis in the chart, configured using a!grouping().
Secondary Grouping secondaryGrouping Grouping Defines the field labels to display in the stacking or grouped bars in the chart, configured using a!grouping().
Measures measures Measure Defines the numerical calculations for data in the chart, configured using a!measure(). If no measure is provided, a count of records shows as the measurement in the chart.
Sort sort SortInfo Field to sort by in the chart. To define a sort, use the alias or record field reference of any grouping or measure field, and sort ascending or descending using a!sortInfo().
Data Limit dataLimit Integer Maximum number of data points to display on the chart. Default: 100. Valid values: 1-5000.

Notes

  • a!barChartConfig() is always used within a bar chart component.
  • This configuration is used when a record type is defined as the data source for a bar chart.
  • The primaryGrouping is required to display data on the chart. The data values returned from the grouping display on the vertical axis.
  • secondaryGrouping is optional; if this parameter is provided, the data values for the secondary grouping will display in the legend and / or tooltips if they are enabled.
  • If no measure is provided, the chart displays a count of records. Also, the label displays as Count of <primary key field name>.
  • The dataLimit determines the total number of data points displayed in the chart. When both a primary and secondary grouping are provided, there is a data point for each unique combination of values: with 3 values in your primary grouping and 4 values in your secondary grouping, you will have 12 values on your chart.
Open in Github

On This Page

FEEDBACK