Components / Charts / API

XAxisItemComponent

The configuration component for an X axis
(see example).

Inputs

axisCrossingValue any | any[]

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

To denote the far end of the axis, set a value that is greater than or equal to the axis maximum value.

baseUnit BaseUnit

The base time interval for the axis labels.
The default baseUnit is automatically determined from the value range.

The available options are:

milliseconds
seconds
minutes
hours
days
weeks
months
years

color string

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

crosshair XAxisCrosshair

The configuration options of the crosshair.
The crosshair is displayed when the xAxis.crosshair.visible option is set to true.

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 Scatter Chart X-axis major ticks.

The interval between major divisions.
If this is a date axis, the value represents the number of xAxis.baseUnits between major divisions.
If xAxis.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 X-axis minor ticks.

minorUnit number

The interval between minor divisions. It defaults to 1/5 of the xAxis.majorUnit.
If xAxis.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 X axis by using the series.xAxis 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 XAxisNotes

The X-axis notes configuration.

pane string

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

plotBands PlotBand[]

The plot bands of the X axis.

reverse boolean

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

startAngle number

The angle (in degrees) where the zero value is placed.
Angles increase counterclockwise and zero is to the right. Negative values are acceptable.

title XAxisTitle

The title configuration of the Scatter Chart X axis.
To display the title, set the xAxis.title.text option.

type "numeric" | "log" | "date"

The axis type.

The supported values are:

"numeric"—Numeric axis.
"date"—Specialized axis for displaying chronological data.
"log"—Logarithmic axis.

If the series X value is of the date type, the Chart automatically switches to a date axis.
To avoid this behavior, set the type.

visible boolean

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

Methods

notifyChanges

Updates the component fields with the specified values and refreshes the Chart.

Use this method when the configuration values cannot be set through the template.

item.notifyChanges({ visible: true });

Parameters

changes any

An object containing the updated input fields.