ValueAxisDefinition
A value axis displays a set of values. It may be in either the X or Y axis, depending on how the chart is setup. For example, in a bar chart, the value axis is on the X axis, and the category axis is on the Y axis, but for a column chart it's the other way around. Scatter and bubble charts have a value axis in both X and Y.
| Name | Type | Description |
|---|---|---|
| crosshair? | boolean | CrosshairOptions | Whether to show a crosshair for this axis. If you supply 'true', defaults will be used. Otherwise you can supply options to customise the crosshair. |
| font? | FontSpec | Spec for the font to use for all text on the axis. If you provide a spec for this axis, any font settings in that spec will override these for the title. |
| gridLineSize? | number | Width of the grid lines. Defaults to 1 pixel. |
| id? | string | Axis ID. |
| inverted? | boolean | Whether or not to invert the axis. If true, the axis will run from max to min instead of min to max. |
| labelFormatter? | (value:number) => string | Optional formatter for all value labels. |
| labelPrefix? | string | Optional prefix for all value labels. Will be ignored if you provide a . |
| labelSuffix? | string | Optional suffix for all value labels. Will be ignored if you provide a . |
| lineSize? | number | The width of the baseline (if visible). Defaults to 2 pixels. |
| max? | number | Maximum value for the axis. Defaults to not set. If this is set and your dataset has values above this value their visual representation in bar/column charts will be truncated. If you have a chart with multiple value axes and one or more of them declares a , the largest value for will be used for all axes. |
| min? | number | Minimum value for the axis. Defaults to not set. If this is set and your dataset has values below this value their visual representation in bar/column charts will be truncated. If you have a chart with multiple value axes and one or more of them declares a , the smallest value for will be used for all axes. |
| position? | AxisPosition | The position for the axis: for a Y axis, AXIS_POSITION_START means on the left (this is the default for a y axis), and AXIS_POSITION_END means on the right. For an X axis, AXIS_POSITION_START means on the top, and AXIS_POSITION_END means on the bottom (the default for an X axis). |
| showGrid? | boolean | Whether or not to show grid lines for each value in the scale. Defaults to false. |
| showLine? | boolean | Whether or not to show a solid line representing the axis' baseline. Defaults to false. |
| step? | number | Optional fixed step size for the axis scale. |
| title? | AxisTitleSpec | Title for the axis. Defaults to empty. |