Components / Charts / API

ValueAxis

The configuration options of the value axis.

axisCrossingValue? any | any[]

  • (Only for objects) The value at which the category axis crosses this axis.
  • (Only for arrays) The value indices at which the category axes cross the value axis.
  • (Only for dates) The date at which the category axis crosses this axis.

background? string

The background color of the axis.

color? string

The color of the value axis. Accepts a valid CSS color string, including hex and rgb.

crosshair? ValueAxisCrosshair

The crosshair configuration options.

The crosshair is displayed when the valueAxis.crosshair.visible option is set to true.

labels? ValueAxisLabels

The axis labels configuration.

line? AxisLine

The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.

majorGridLines? GridLines

The configuration of the major grid lines.
These are the lines that are an extension of the major ticks through the body of the Chart.

majorTicks? AxisTicks

The configuration of the value axis major ticks.

majorUnit? number

The interval between major divisions.
If valueAxis.type is set to "log", the majorUnit value is used for the base of the
logarithm.

max? any

The maximum value of the axis.

min? any

The minimum value of the axis.

minorGridLines? GridLines

The configuration of the minor grid lines.
These are the lines that are an extension of the minor ticks through the body of the Chart.

minorTicks? AxisTicks

The configuration of the value axis minor ticks.

minorUnit? number

The interval between minor divisions. It defaults to one-fifth (1/5) of the valueAxis.majorUnit.
If valueAxis.type is set to "log", the minorUnit value represents the number of divisions
between two major units and defaults to the major unit minus one.

name? string

The unique axis name. Used to associate a series with a value axis by using the series.axis option.

narrowRange? boolean

If set to true, the Chart prevents the automatic axis range from snapping to zero.
Setting it to false forces the automatic axis range to snap to zero.

notes? ValueAxisNotes

The value axis notes configuration.

pane? string

The name of the pane that the value axis has to be rendered in.
If not set, the axis is rendered in the first (default) pane.

plotBands? PlotBand[]

The plot bands of the value axis.

reverse? boolean

If set to true, the value axis direction is reversed.
By default, the categories are listed from left to right and from bottom to top.

Radar and Polar Charts do not support reverse value axes.

title? ValueAxisTitle

The title configuration of the value axis.

To display the title, set the valueAxis.title.text option.

type? "numeric" | "log"

The axis type.

The supported values are:

  • "numeric"—Numeric axis.
  • "log"—Logarithmic axis.

visible? boolean

If set to true, the Chart displays the value axis. By default, the value axis is visible.