Skip to main content

Radial Chart

Ant Design

The Radial Chart component shows figures as rings. It shows one value against a maximum as a progress ring, such as a quota reached, or compares a few categories as concentric rings.

Properties​

Property
Description
Expected Value
Modeprogress shows one ring for Value out of Max value; categories shows one ring per row of Data.progress, categories. Default: progress
ValueThe figure shown on the progress ring.Number. Default: 68
Max valueThe figure that fills the ring completely.Number. Default: 100
DataRows to show as rings in categories mode, such as [{ name: 'Charter', value: 62 }].Array
Category fieldField in each row that names the ring.Text. Default: name
Value fieldField in each row that holds the ring's value.Text. Default: value
Center valueText shown in the middle of the progress ring. Leave it empty to show the percent.Text
Center labelSmaller text shown under the center value of the progress ring.Text
TypeShape of the progress ring. circle is a full ring; dashboard leaves a gap at the bottom.circle, dashboard. Default: dashboard
Stroke widthThickness of the progress ring.Number. Default: 8
Show legendShows a legend of the categories in categories mode.On or off. Default: On
ColorsColors to use, such as ['#4f46e5', '#22c55e']. The progress ring uses the first. Leave it empty to use the theme's colors.Array

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 clickTriggers when the user clicks the progress ring or one of the category rings.

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 clickedDataPoint.components.radialchart1.clearClickedPoint()
Set visibilityShows the component when true, hides it when false.components.radialchart1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.radialchart1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.radialchart1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
modeprogress shows one ring for Value out of Max value; categories shows one ring per row of Data.{{components.radialchart1.mode}}
valueThe figure shown on the progress ring.{{components.radialchart1.value}}
maxValueThe figure that fills the ring completely.{{components.radialchart1.maxValue}}
dataRows to show as rings in categories mode, such as [{ name: 'Charter', value: 62 }].{{components.radialchart1.data}}
categoryFieldField in each row that names the ring.{{components.radialchart1.categoryField}}
valueFieldField in each row that holds the ring's value.{{components.radialchart1.valueField}}
centerValueText shown in the middle of the progress ring. Leave it empty to show the percent.{{components.radialchart1.centerValue}}
centerLabelSmaller text shown under the center value of the progress ring.{{components.radialchart1.centerLabel}}
typeShape of the progress ring. circle is a full ring; dashboard leaves a gap at the bottom.{{components.radialchart1.type}}
strokeWidthThickness of the progress ring.{{components.radialchart1.strokeWidth}}
showLegendShows a legend of the categories in categories mode.{{components.radialchart1.showLegend}}
colorsColors to use, such as ['#4f46e5', '#22c55e']. The progress ring uses the first. Leave it empty to use the theme's colors.{{components.radialchart1.colors}}
clickedDataPointWhat the user clicked last: { value, maxValue, percent } for the progress ring, or the { name, value } of a category ring. {} after Clear clicked point.{{components.radialchart1.clickedDataPoint}}
isVisibleWhether the component is visible.{{components.radialchart1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.radialchart1.isLoading}}
isDisabledWhether the component is disabled.{{components.radialchart1.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.