XAxis
configurationThe X-axis configuration options of the scatter chart X-axis. Supports all valueAxis options.
xAxis
ArrayxAxis.axisCrossingValue
Object|Date|ArrayValue at which the Y axis crosses this axis. (Only for object)
Value indices at which the Y axes cross the value axis. (Only for array)
Date at which the Y axis crosses this axis. (Only for date)
Set a value greater than or equal to the axis maximum value to denote the far end of the axis.
xAxis.background
StringThe background color of the axis.
xAxis.baseUnit
StringThe base time interval for the axis labels. The default baseUnit is determined automatically from the value range. Available options:
- milliseconds
- seconds
- minutes
- hours
- days
- weeks
- months
- years
xAxis.categories
ArrayThe category names. Applicable for charts with X and Y category axes (heatmap).
xAxis.color
StringThe color of the axis. Accepts a valid CSS color string, including hex and rgb.
xAxis.crosshair
ObjectThe crosshair configuration options.
The crosshair is displayed when the xAxis.crosshair.visible option is set to
true.
xAxis.labels
ObjectThe axis labels configuration.
xAxis.line
ObjectThe configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
xAxis.majorGridLines
ObjectThe configuration of the major grid lines. These are the lines that are an extension of the major ticks through the body of the chart.
xAxis.majorTicks
ObjectThe configuration of the scatter chart x axis major ticks.
xAxis.majorUnit
NumberThe interval between major divisions.
If this is a date axis the value represents the number of xAxis.baseUnits between major divisions.
If the xAxis.type is set to "log", the majorUnit value will be used for the base of the logarithm.
xAxis.max
ObjectThe maximum value of the axis.
xAxis.min
ObjectThe minimum value of the axis.
xAxis.minorGridLines
ObjectThe configuration of the minor grid lines. These are the lines that are an extension of the minor ticks through the body of the chart.
xAxis.minorTicks
ObjectThe configuration of the x axis minor ticks.
xAxis.minorUnit
NumberThe interval between minor divisions. It defaults to 1/5 of the xAxis.majorUnit.
If the 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.
xAxis.name
StringThe unique axis name. Used to associate a series with a x axis using the series.xAxis option.
Default: "primary"
xAxis.narrowRange
BooleanIf set to true the chart will prevent the automatic axis range from snapping to 0.
Setting it to false will force the automatic axis range to snap to 0.
Default: false
xAxis.notes
ObjectThe x axis notes configuration.
xAxis.pane
StringThe name of the pane that the axis should be rendered in. The axis will be rendered in the first (default) pane if not set.
xAxis.plotBands
ArrayThe plot bands of the x axis.
xAxis.reverse
BooleanIf set to true the value axis direction will be reversed. By default values increase from left to right and from bottom to top.
Default: false
xAxis.startAngle
NumberThe angle (degrees) where the 0 value is placed. Applicable to polar series.
Angles increase counterclockwise and zero is to the right. Negative values are acceptable.
Default: 0
xAxis.title
ObjectThe title configuration of the scatter chart x axis.
The xAxis.title.text option must be set in order to display the title.
xAxis.type
StringThe axis type.
The supported values are:
- "numeric" - numeric axis.
- "date" - specialized axis for displaying chronological data.
- "log" - logarithmic axis.
The chart will automatically switch to a date axis if the series X value
is of type Date. Set the xAsix.type when such behavior is undesired.
Default: "numeric"
xAxis.visible
BooleanIf set to true the chart will display the x axis. By default the x axis is visible.
Default: true