Column
Ant Design
The Column chart compares values across categories or time as vertical bars, such as orders per month or revenue by region.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Data | The rows to plot, usually a query's data, one row per point on the x axis, such as [{ month, sales }]. | Array |
| X field | Name of the field in Data that holds the x axis value, such as a month or category. | Text. Default: x |
| Y field | Name of the field that holds the value, such as sales, or a list of fields such as ['sales', 'cost'] to plot each one as its own series. | Array. Default: ["y"] |
| Color field | For data with one row per x value and series, the field that names the series, such as region. Each value 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 value on the chart. | On or off. Default: Off |
| Y formatter | How values on the axis, labels and tooltips are written. compact shortens large numbers, such as 1.2K; percent reads 0.25 as 25%; auto shows whole numbers with no decimals and others with up to two. | 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 and currency formats, such as pt-BR. Leave it empty to follow the currency's usual format. | Text |
| Highlight clicked point | Keeps the clicked mark at full strength and fades the rest, until another mark is clicked or Clear clicked point runs. | On or off. Default: Off |
| Stack | Stacks the series on top of each other in one bar instead of placing them side by side. | On or off. Default: Off |
| Horizontal | Draws the bars horizontally, running from left to right. | On or off. Default: Off |
| Corner radius | Roundness of the bar ends, from 0 to 20 pixels. | Number. Default: 4 |
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 mark on the chart, such as a bar or 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 mark, which empties selectedDatum and removes the highlight. | components.column1.clearClickedPoint() |
| Set visibility | Shows the component when true, hides it when false. | components.column1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.column1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.column1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
data | The rows to plot, usually a query's data, one row per point on the x axis, such as [{ month, sales }]. | {{components.column1.data}} |
xField | Name of the field in Data that holds the x axis value, such as a month or category. | {{components.column1.xField}} |
yField | Name of the field that holds the value, such as sales, or a list of fields such as ['sales', 'cost'] to plot each one as its own series. | {{components.column1.yField}} |
colorField | For data with one row per x value and series, the field that names the series, such as region. Each value gets its own color. | {{components.column1.colorField}} |
title | Heading shown above the chart. | {{components.column1.title}} |
legend | Where the legend sits, or none to hide it. The legend shows only when the chart has more than one series. | {{components.column1.legend}} |
label | Shows each value on the chart. | {{components.column1.label}} |
yFormatter | How values on the axis, labels and tooltips are written. compact shortens large numbers, such as 1.2K; percent reads 0.25 as 25%; auto shows whole numbers with no decimals and others with up to two. | {{components.column1.yFormatter}} |
currency | Currency code, such as USD or EUR, used when Y formatter is currency. | {{components.column1.currency}} |
locale | Locale for number and currency formats, such as pt-BR. Leave it empty to follow the currency's usual format. | {{components.column1.locale}} |
highlightClicked | Keeps the clicked mark at full strength and fades the rest, until another mark is clicked or Clear clicked point runs. | {{components.column1.highlightClicked}} |
stack | Stacks the series on top of each other in one bar instead of placing them side by side. | {{components.column1.stack}} |
horizontal | Draws the bars horizontally, running from left to right. | {{components.column1.horizontal}} |
radius | Roundness of the bar ends, from 0 to 20 pixels. | {{components.column1.radius}} |
selectedDatum | The data row of the mark the user clicked last. It is empty after Clear clicked point. | {{components.column1.selectedDatum}} |
isVisible | Whether the component is visible. | {{components.column1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.column1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.column1.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.