Free cookie consent management tool by TermsFeed Pie Chart Configuration (a!pieChartConfig)
Pie Chart Configuration
SAIL Design System guidance available for Charts

Every chart should tell a story. What does yours say? Learn how to build rich reporting dashboards that provide users with visualizations of their data.

Function

a!pieChartConfig( primaryGrouping, measures, sort, dataLimit, link )

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:

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().

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

Use a!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.

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 considerations

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 parameters

  • The primaryGrouping is required to display data on the chart.
  • The dataLimit determines the total number of slices displayed in the chart.

Using the sort parameter

  • You can sort by the alias of any groupings or measures, or by any fields that are not directly referenced in the chart as long as they are of type Number (Integer), Number (Decimal), Date, Date and Time, Time, or Boolean. See Chart Configuration Using Records for an example of sorting by a field not referenced in the chart.
  • When configuring sort in Design Mode, you must use the alias of any groupings or measures to sort by the fields in the chart. In Expression Mode, you can use the alias or the field name if the alias is not provided.
  • 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.

Feature compatibility

The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Pie Chart Configuration.

  • Aggregate Data and Display in a Chart (Reports, Charts, Query Data, Records): Aggregate data, specifically the total number of employees in a given department, to display in a pie chart.
Open in Github Built: Thu, Mar 28, 2024 (10:34:59 PM)

Pie Chart Configuration

FEEDBACK