Pie Chart Configuration

Function: a!pieChartConfig()

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

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

Parameters

Name Keyword Type Description
Primary Grouping primaryGrouping Grouping Defines the field labels to display for each slice of the pie 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!pieChartConfig() is always used within a pie chart component.
  • This configuration is used when a record type is defined as the data source for a pie chart in the data parameter of a!pieChartField().
  • The primaryGrouping is required to display data on the chart.
  • 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 slices displayed in the chart.
Open in Github

On This Page

FEEDBACK