Scatter
Ant Design
The Scatter component is Ant Design's scatter chart. It plots rows as points by two numbers, to show how they relate, such as deal size against days to close.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Data | Rows to chart, one per point, such as [{ x: 12, y: 34 }]. | Array |
| X field | Field in each row that holds the number on the horizontal axis. | Text. Default: x |
| Y field | Field that holds the number on the vertical axis. With a list of fields, only the first is plotted. | Array. Default: ["y"] |
| Color field | Field that names each point's group. Each group gets its own color. | Text |
| Title | Heading shown above the chart. | Text |
| Legend | Where the legend sits, or none to hide it. The legend shows only when the chart has more than one series. | top, bottom, right, none. Default: top |
| Label | Shows each data point's value on the chart. | On or off. Default: Off |
| Y formatter | How values on the value axis, labels and tooltips are written. 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: compact |
| Currency | Currency code, such as USD or EUR, used when Y formatter is currency. | Text. Default: USD |
| Locale | Locale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format. | Text |
| Highlight clicked point | Keeps the point the user clicked highlighted and fades the others until Clear clicked point runs. | On or off. Default: Off |
| Size field | Number field that sets each point's size, which turns the chart into a bubble chart. | Text |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows 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 click | Triggers when the user clicks a point. |
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 point | Clears the clicked point, which empties selectedDatum and removes the highlight. | components.scatter1.clearClickedPoint() |
| Set visibility | Shows the component when true, hides it when false. | components.scatter1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.scatter1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.scatter1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
data | Rows to chart, one per point, such as [{ x: 12, y: 34 }]. | {{components.scatter1.data}} |
xField | Field in each row that holds the number on the horizontal axis. | {{components.scatter1.xField}} |
yField | Field that holds the number on the vertical axis. With a list of fields, only the first is plotted. | {{components.scatter1.yField}} |
colorField | Field that names each point's group. Each group gets its own color. | {{components.scatter1.colorField}} |
title | Heading shown above the chart. | {{components.scatter1.title}} |
legend | Where the legend sits, or none to hide it. The legend shows only when the chart has more than one series. | {{components.scatter1.legend}} |
label | Shows each data point's value on the chart. | {{components.scatter1.label}} |
yFormatter | How values on the value axis, labels and tooltips are written. 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.scatter1.yFormatter}} |
currency | Currency code, such as USD or EUR, used when Y formatter is currency. | {{components.scatter1.currency}} |
locale | Locale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format. | {{components.scatter1.locale}} |
highlightClicked | Keeps the point the user clicked highlighted and fades the others until Clear clicked point runs. | {{components.scatter1.highlightClicked}} |
sizeField | Number field that sets each point's size, which turns the chart into a bubble chart. | {{components.scatter1.sizeField}} |
selectedDatum | The data row of the point the user clicked last, or {} after Clear clicked point. | {{components.scatter1.selectedDatum}} |
isVisible | Whether the component is visible. | {{components.scatter1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.scatter1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.scatter1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 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.