XAxis
Related Docs:
class XAxis
| package config
Whether to allow decimals in this axis' ticks. Ticks are hidden by default on a Highmaps axis, though they are inherited from Highcharts and can be enabled.
When using an alternate grid color, a band is painted across the plot area between every other grid line.
A class name that opens for styling the axis by CSS, especially in Highcharts styled mode. The class name is applied to group elements for the grid, axis elements and labels.
Configure a crosshair that follows either the mouse pointer or the hovered point.. .
In styled mode, the crosshairs are styled in the .highcharts-crosshair, .highcharts-crosshair-thin or .highcharts-xaxis-category classes.
Requires Accessibility module. . Description of the axis to screen reader users.
Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
Event handlers for the axis.
Color of the grid lines extending the ticks across the plot area. Highmaps grid lines are hidden by default and can be enabled by setting the gridLineWidth option.
The dash or dot style of the grid lines. For possible values, see this demonstration.
The width of the grid lines extending the ticks across the plot area.
An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
The axis labels show the number or category for each tick. X and Y axis labels are by default disabled in Highmaps, but the functionality is inherited from Highcharts and used on colorAxis, and can be enabled on X and Y axes too.. For more live examples on label options, see xAxis.labels in the Highcharts API.
The color of the line marking the axis itself.
The width of the line marking the axis itself.. .
In styled mode, the stroke width is given in the .highcharts-axis-line or .highcharts-xaxis-line class.
The maximum value of the axis. If null, the max value is automatically calculated. If the endOnTick option is true, the max value might be rounded up.. .
If a tickAmount is set, the axis may be extended beyond the set max in order to reach the given number of ticks. The same may happen in a chart with multiple axes, determined by chart.alignTicks, where a tickAmount is applied internally.
Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer. This is useful when you don't want the map shapes to touch the plot border. When the axis' max option is set or a max extreme is set using axis.setExtremes(), the maxPadding will be ignored.
The minimum value of the axis in terms of the coordinates of the map shape paths. If null the min value is automatically calculated. If the startOnTick option is true, the min value might be rounded down.
Padding of the min value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer. This is useful when you don't want the map shapes to touch the plot border. When the axis' min option is set or a min extreme is set using axis.setExtremes(), the minPadding will be ignored.
The minimum range to display on this axis. The entire axis will not be allowed to span over a smaller interval than this, in terms of shape path coordinates. Defaults to 5 times the size of the smallest area.. .
Note that the minPadding, maxPadding, startOnTick and endOnTick settings also affect how the extremes of the axis are computed.
The minimum tick interval allowed in axis values. For example on zooming in on an axis with daily data, this can be used to prevent the axis from showing hours. In Highmaps, ticks are hidden by default.
Color of the minor, secondary grid lines.
The dash or dot style of the minor grid lines. For possible values, see this demonstration.
Width of the minor, secondary grid lines.
Color for the minor tick marks.
Tick interval in scale units for the minor ticks. On a linear axis, if "auto", . the minor tick interval is calculated as a fifth of the tickInterval. If. null, minor ticks are not shown..
On logarithmic axes, the unit is the power of the value. For example, setting. the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10, 100 etc. Setting. the minorTickInterval to 0.1 produces 9 ticks between 1 and 10, . 10 and 100 etc. A minorTickInterval of "auto" on a log axis results in a best guess,. attempting to enter approximately 5 minor ticks between each major tick.. .
If user settings dictate minor ticks to become too dense, they don't make sense, and will be ignored to prevent performance problems.
The pixel length of the minor tick marks.
The position of the minor tick marks relative to the axis line. Can be one of inside and outside.
The pixel width of the minor tick mark.
The distance in pixels from the plot area to the axis line. A positive offset moves the axis with it's line, labels and ticks away from the plot area. This is typically used when two or more axes are displayed on the same side of the plot. With multiple axes the offset is dynamically adjusted to avoid collision, this can be overridden by setting offset explicitly.
Whether to display the axis on the opposite side of the normal. The normal is on the left side for vertical axes and bottom for horizontal, so the opposite sides will be right and top respectively.
Whether to reverse the axis so that the highest number is closest to the origin.
Whether to show the axis line and title when the axis has no data. By default Highmaps X and Y axis don't have visible line and title regardless.
If labels are enabled, whether to show the first tick label.
If labels are enabled, whether to show the last tick label.
A soft minimum for the axis. If the series data minimum is greater than this, the axis will stay at this minimum, but if the series data minimum is lower, the axis will flex to show all data.
Whether to force the axis to start on a tick. Use this option with the minPadding option to control the axis start.
Color for the main tick marks.
The interval of the tick marks in axis units. When null, the tick interval. is computed to approximately follow the tickPixelInterval.
The pixel length of the main tick marks.
If tickInterval is null this option sets the approximate pixel interval of the tick marks.. .
The tick interval is also influenced by the minTickInterval option, that, by default prevents ticks from being denser than the data points.. .
Defaults to 72 for the Y axis and 100 for the X axis.
The position of the major tick marks relative to the axis line. Can be one of inside and outside.
A callback function returning array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval.
An array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval.
The pixel width of the major tick marks.. .
In styled mode, the stroke width is given in the .highcharts-tick class.
The axis title. In Highmaps, the axis is hidden by default, but adding an axis title is still possible. X axis and Y axis titles will appear at the bottom and left by default.