Pie Chart Component

Function

label, instructions, series, showDataLabels, showTooltips, showAsPercentage, labelPosition, helpTooltip, accessibilityText, showWhen, colorScheme, style, seriesLabelStyle, height, data, config

Displays numerical data as slices of a single circle. Use a pie chart to graphically display parts of a whole.

See also:

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Instructions

instructions

Text

Supplemental text about this field.

Series

series

List of PieChartSeries

Array of data series created with a!chartSeries().

Show data labels

showDataLabels

Boolean

Determines if data values are displayed with each pie slice. Default: false.

Show tooltips

showTooltips

Boolean

Determines if a tooltip displays the data value for a pie slice. Default: false.

Show as percentage

showAsPercentage

Boolean

Determines if the data is shown as a percentage. Default: false.

Label Position

labelPosition

Text

Determines where the label appears. Valid values:

  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Color scheme

colorScheme

Any type

Determines which color scheme to use in the chart. Use one of the following valid values: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a!colorSchemeCustom. See Chart Color Scheme for color scheme examples.

Style

style

Text

Determines if the chart displays as a full pie or as a donut. Valid values: "PIE" (default), "DONUT".

Series Label Style

seriesLabelStyle

Text

Determines where to display the series labels. Valid values: "ON_CHART" (default), "LEGEND", "NONE".

Height

height

Text

Determines the chart height. Valid values: "SHORT", "MEDIUM" (default), "TALL".

Data

data

Any type

Reference to the record type used for the source of this chart. Can accept a!recordData or a Record Type Reference.

Chart Configuration

config

PieChartConfig

Configures how to display data on the chart, including fields used for calculations and grouping, using a!pieChartConfig().

Configuration

There are two ways to configure a pie chart:

  1. Set a record type as the data source and define fields to display on the chart.
  2. Perform your own query and define lists of data within the series.

The chart allows using an entity-backed or synced record type as the source. If you have one of these record types available as a source, we recommend using the record type as the source. This configuration is easier because Appian will perform the query for you and display the results in the bar chart directly. If you have complex requirements or your data source is not a entity-backed or synced record type, use the series to construct the chart manually.

Using record data

Configuring a pie chart using a record type as the source requires using two parameters: data and config. Once you provide a source record type in the data parameter and provide the fields in the config parameter, the chart displays the results.

See Chart Configuration Using Record Data for details on using a record type as the source.

Using series

When using series, you must provide the list of data labels and values directly to the parameter using a list of a!chartSeries(). See the notes below for guidance.

  • The labels and data arguments in the Series are shown in the data labels and tooltips (if enabled).
  • If a Series has a non-null label value paired with a 0, null, or empty data value, the data value is treated as 0 and is still displayed if Show data labels is set to true. For example, Americas: 0.
  • If a Series argument has a null or empty label paired with a non-null data value, the label is displayed as [Series #] with # as the label's index number in the Series if Show data labels is set to true. For example, [Series 1]: 3.
  • If a Series argument has both a null or empty label paired with a 0, null, or empty data value, the above behaviors are combined and the following is displayed if Show data labels is set to true: [Series 1]: 0.

Usage considerations

Chart legends

  • If the series label style is set to LEGEND and data labels are displayed, the data labels are shown in the legend in parentheses. For example, West Region (25%).
  • Using the LEGEND or NONE series label styles will ensure consistent sizing of the pie for any columns of the same width. When ON_CHART is used for the series label style, the pie changes size based on the length of the series label.
  • The ON_CHART style will usually use screen space more effectively than the LEGEND. Since showing the legend guarantees the same size pies across columns of the same width, there may be extra whitespace if a short label is used in the legend.
  • If the legend is displayed, it will show below the pie in MEDIUM width columns or narrower; in wider columns the legend will show adjacent to the chart. The legend always displays below the pie on phones.

Chart data and values

  • If a data value is negative, the data label shows it as negative (for example -20), but it still displays as a pie slice. To avoid any confusion, negative values should only be used with bar, column, and line charts.
  • Since pie chart values do not have an x-axis for reference, Appian recommends setting Show data labels as true.
  • When values are shown as percentages, they are rounded to one decimal place. If values in the second decimal place are 5 or higher, the first decimal number is rounded up.
  • If data contains a!recordData or a record type reference, the series parameter is ignored.
  • When you use a record type as a source for your chart, you can use a!measure() to perform a calculation on a single field. If you need to perform multiple calculations within the same chart, use series to configure your chart instead of data and config.

Chart lines and background colors

  • When the chart is placed in a colored card, the chart background will match the color of the card. Text labels and lines in the chart will also adjust if a dark background color is used. See the UX Design Guide for best practices on using charts with background colors.

Examples

Use the interactive editor below to test out your code:

The examples below demonstrate how to configure your charts using categories and series. For examples on using record data, please see Chart Configuration Using Record Data.

Pie chart with label, instructions, and data labels

Pie chart with label, instructions, data labels, tooltips, and percentage

Donut style chart with legend and colors assigned in series

The following patterns include usage of the Pie Chart Component.

Open in Github

On This Page

FEEDBACK