Skip to main content

Pie

Ant Design

The Pie component is Ant Design's pie and donut chart. It shows how a total splits across categories, such as revenue by product or tickets by status.

Properties​

Property
Description
Expected Value
DataRows to chart, one per slice, such as [{ type: 'Charter', value: 62 }].Array
Angle fieldField in each row that holds the slice's value.Text. Default: value
Color fieldField in each row that names the slice's category.Text. Default: type
Inner radiusSize of the hole in the middle, from 0 for a full pie to 0.9 for a thin ring.Number. Default: 0.6
TitleHeading shown above the chart.Text
LegendWhere the legend of categories sits, or none to hide it. On a narrow chart, right moves under the chart.right, bottom, top, none. Default: right
LabelShows each slice's share of the total as a percent on the slice.On or off. Default: Off
FormatterHow values are written in tooltips. auto keeps whole numbers whole and others to two decimals, percent reads 0.25 as 25%, and compact shortens large numbers to 12K or 1.2M.auto, number, currency, percent, compact. Default: auto
CurrencyCurrency code, such as USD or EUR, used when Formatter is currency.Text. Default: USD
LocaleLocale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format.Text
Highlight clicked pointKeeps the point the user clicked highlighted and fades the others until Clear clicked point runs.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On element clickTriggers when the user clicks a slice.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Clear clicked pointClears the clicked slice, which empties selectedDatum and removes the highlight.components.pie1.clearClickedPoint()
Set visibilityShows the component when true, hides it when false.components.pie1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.pie1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.pie1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
dataRows to chart, one per slice, such as [{ type: 'Charter', value: 62 }].{{components.pie1.data}}
angleFieldField in each row that holds the slice's value.{{components.pie1.angleField}}
colorFieldField in each row that names the slice's category.{{components.pie1.colorField}}
innerRadiusSize of the hole in the middle, from 0 for a full pie to 0.9 for a thin ring.{{components.pie1.innerRadius}}
titleHeading shown above the chart.{{components.pie1.title}}
legendWhere the legend of categories sits, or none to hide it. On a narrow chart, right moves under the chart.{{components.pie1.legend}}
labelShows each slice's share of the total as a percent on the slice.{{components.pie1.label}}
formatterHow values are written in tooltips. auto keeps whole numbers whole and others to two decimals, percent reads 0.25 as 25%, and compact shortens large numbers to 12K or 1.2M.{{components.pie1.formatter}}
currencyCurrency code, such as USD or EUR, used when Formatter is currency.{{components.pie1.currency}}
localeLocale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format.{{components.pie1.locale}}
highlightClickedKeeps the point the user clicked highlighted and fades the others until Clear clicked point runs.{{components.pie1.highlightClicked}}
selectedDatumThe data row of the slice the user clicked last, or {} after Clear clicked point.{{components.pie1.selectedDatum}}
isVisibleWhether the component is visible.{{components.pie1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.pie1.isLoading}}
isDisabledWhether the component is disabled.{{components.pie1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.