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 Types Description

Primary Grouping

primaryGrouping

Grouping

Defines the field labels to display for each slice of the pie chart, configured using a!grouping().

Secondary Grouping

secondaryGrouping

Grouping

Defines the field labels to display across each line 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.

Link

link

Any Type

Link to execute when a user selects a data point on the chart. Use fv!selection to pass context from the selection made on the chart to the link. Create a link using a!dynamicLink().

Usage conisderations

Using a!pieChartConfig()

  • 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().
  • If no measure is provided, the chart displays a count of records. Also, the label displays as Count of <primary key field name>.

Using groups and data limits

  • The primaryGrouping is required to display data on the chart.
  • The dataLimit determines the total number of slices displayed in the chart.
  • When a dynamic link is added to the link parameter, the current selected data is available using fv!selection. This variable returns a map that contains each of the field aliases as the key and the unformatted value as the value. Since the alias is used for the key, aliases are required for each grouping and measure when using a link. See Chart Configuration Using Records for an example of how to configure a link.
Open in Github

On This Page

FEEDBACK