HIYAxis Class Reference

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 lowest data value to appear on the edge of the plot area. When the axis' min option is set or a max extreme is set using axis.setExtremes(), the maxPadding will be ignored. Also the softThreshold option takes precedence over minPadding, so if the data is tangent to the threshold, minPadding may not apply unless softThreshold is set to false.

The axis labels show the number or category for each tick. Since v8.0.0: Labels are animated in categorized x-axis with updating data if tickInterval and step is set to 1.

The height of the Y axis. If it’s a number, it is interpreted as pixels. Since Highcharts 2: If it’s a percentage string, it is interpreted as percentages of the total plot height.

Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.

A soft maximum for the axis. If the series data maximum is less than this, the axis will stay at this maximum, but if the series data maximum is higher, the axis will flex to show all data. Note: The series.softThreshold option takes precedence over this option.

The minimum value of the axis. If null the min value is automatically calculated. If the startOnTick option is true (default), the min value might be rounded down. The automatically calculated minimum value is also affected by floor, softMin, minPadding, minRange as well as series.threshold and series.softThreshold.

An array of colored bands stretching across the plot area marking an interval on the axis. In styled mode, the plot bands are styled by the .highcharts-plot-band class in addition to the className option.

Solid gauge series only. Color stops for the solid gauge. Use this in cases where a linear gradient between a minColor and maxColor is not sufficient. The stops is an array of tuples, where the first item is a float between 0 and 1 assigning the relative position in the gradient, and the second item is the color. For solid gauges, the Y axis also inherits the concept of data classes from the Highmaps color axis.

Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end. This option is always disabled, when panning type is either y or xy.

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.

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. Note: The series.softThreshold option takes precedence over this option.

The type of axis. Can be one of linear, logarithmic, datetime, category or treegrid. Defaults to treegrid for Gantt charts, linear for other chart types. In a datetime axis, the numbers are given in milliseconds, and tick marks are placed on appropriate values, like full hours or days. In a category or treegrid axis, the point names of the chart’s series are used for categories, if a categories array is not defined.

Relevant only for pictorial series. The stackShadow forms the background of stacked points. Requires series.stacking to be defined.

If tickInterval is null this option sets the approximate pixel interval of the tick marks. Not applicable to categorized axis. The tick interval is also influenced by the minTickInterval option, that, by default prevents ticks from being denser than the data points.

The pixel width of the major tick marks.

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. This is typically used with dual or multiple axes.

Whether to reverse the axis so that the highest number is closest to the origin.

An array of lines stretching across the plot area, marking a specific value on one of the axes. In styled mode, the plot lines are styled by the .highcharts-plot-line class in addition to the className option.

The width of the grid lines extending the ticks across the plot area. Defaults to 1 on the Y axis and 0 on the X axis, except for 3d charts. In styled mode, the stroke width is given in the .highcharts-grid-line class.

Parallel coordinates only. Format that will be used for point.y and available in tooltip.pointFormat as {point.formattedValue}. If not set, {point.formattedValue} will use other options, in this order: 1. yAxis.labels.format will be used if set 2. If yAxis is a category, then category name will be displayed 3. If yAxis is a datetime, then value will use the same format as yAxis labels 4. If yAxis is linear/logarithmic type, then simple value will be used

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.

Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.

Whether to show the last tick label.

Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start. This option is always disabled, when panning type is either y or xy.

The stack labels show the total value for each bar in a stacked column or bar chart. The label will be placed on top of positive columns and below negative columns. In case of an inverted column chart or a bar chart the label is placed to the right of positive bars and to the left of negative bars.

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 highest data value to appear on the edge of the plot area. When the axis' max option is set or a max extreme is set using axis.setExtremes(), the maxPadding will be ignored. Also the softThreshold option takes precedence over maxPadding, so if the data is tangent to the threshold, maxPadding may not apply unless softThreshold is set to false.

The axis title, showing next to the axis line.

If true, the first series in a stack will be drawn on top in a positive, non-reversed Y axis. If false, the first series is in the base of the stack.

The top position of the Y axis. If it’s a number, it is interpreted as pixel position relative to the chart. Since Highcharts 2: If it’s a percentage string, it is interpreted as percentages of the plot height, offset from plot area top.

The Z index of the grid lines.

Refers to the index in the panes array. Used for circular gauges and polar charts. When the option is not set then first pane will be used.

Whether to pan axis. If chart.panning is enabled, the option allows to disable panning on an individual axis.

An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.

The interval of the tick marks in axis units. When undefined, the tick interval is computed to approximately follow the tickPixelInterval on linear and datetime axes. On categorized axes, a undefined tickInterval will default to 1, one category. Note that datetime axes are based on milliseconds, so for example an interval of one day is expressed as 24 * 3600 * 1000. On logarithmic axes, the tickInterval is based on powers, so a tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40 etc. If the tickInterval is too dense for labels to be drawn, Highcharts may remove ticks. If the chart has multiple axes, the alignTicks option may interfere with the tickInterval setting.

If categories are present for the xAxis, names are used instead of numbers for that axis. Since Highcharts 3.0, categories can also be extracted by giving each point a name and setting axis type to category. However, if you have multiple series, best practice remains defining the categories array. Example: categories: ['Apples', 'Bananas', 'Oranges']

The value on a perpendicular axis where this axis should cross. This is typically used on mathematical plots where the axes cross at 0. When crossing is set, space will not be reserved at the sides of the chart for axis labels and title, so those may be clipped. In this case it is better to place the axes without the crossing option.

The position of the major tick marks relative to the axis line. Can be one of inside and outside.

Whether to show the axis line and title when the axis has no data.

For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.

Color of the minor, secondary grid lines. In styled mode, the stroke width is given in the .highcharts-minor-grid-line class.

Polar charts only. Whether the grid lines should draw as a polygon with straight lines between categories, or as circles. Can be either circle or polygon. Since v8.0.0 this option is also applicable for X axis (inverted polar).

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.

The dash or dot style of the grid lines. For possible values, see this demonstration.

The position of the minor tick marks relative to the axis line. Can be one of inside and outside.

Enable or disable minor ticks. The interval between the minor ticks can be controlled either by the minorTicksPerMajor setting, or as an absolute minorTickInterval value. On a logarithmic axis, minor ticks are laid out based on a best guess, attempting to enter an approximate number of minor ticks between each major tick based on minorTicksPerMajor. Prior to v6.0.0, ticks were enabled in auto layout by setting minorTickInterval to "auto".

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.

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. Defaults to the closest distance between two points on the axis.

Specific tick interval in axis units for the minor ticks. On a linear axis, if "auto", the minor tick interval is calculated as a fifth of the tickInterval. If undefined, 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. If user settings dictate minor ticks to become too dense, they don’t make sense, and will be ignored to prevent performance problems.

Index of another axis that this axis is linked to. When an axis is linked to a master axis, it will take the same extremes as the master, but as assigned by min or max or by setExtremes. It can be used to show additional info, or to ease reading the chart by duplicating the scales.

The color of the line marking the axis itself. In styled mode, the line stroke is given in the .highcharts-axis-line or .highcharts-xaxis-line class.

For a datetime axis, the scale will automatically adjust to the appropriate unit. This member gives the default string representations used for each unit. For intermediate values, different units may be used, for example the day unit can be used on midnight and hour unit be used for intermediate values on the same axis. For an overview of the replacement codes, see dateFormat. Defaults to: js { millisecond: '%H:%M:%S.%L', second: '%H:%M:%S', minute: '%H:%M', hour: '%H:%M', day: '%e. %b', week: '%e. %b', month: '%b \'%y', year: '%Y' }

Whether axis, including axis title, line, ticks and labels, should be visible.

Whether to show the first tick label.

For categorized axes only. If on the tick mark is placed in the center of the category, if between the tick mark is placed between categories. The default is between if the tickInterval is 1, else on. In order to render tick marks on a category axis it is necessary to provide a tickWidth.

A callback function returning array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval. The automatic tick positions are accessible through this.tickPositions and can be modified by the callback.

The width as the horizontal axis. If it’s a number, it is interpreted as pixels. Since Highcharts v5.0.13: If it’s a percentage string, it is interpreted as percentages of the total plot width.

The pixel length of the minor tick marks.

The highest allowed value for automatically computed axis extremes.

When using an alternate grid color, a band is painted across the plot area between every other grid line.

Color for the minor tick marks.

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.

If there are multiple axes on the same side of the chart, the pixel margin between the axes. Defaults to 0 on vertical axes, 15 on horizontal axes.

Accessibility options for an axis. Requires the accessibility module.

When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified. This can be prevented by setting alignTicks to false. If the grid lines look messy, it’s a good idea to hide them for the secondary axis by setting gridLineWidth to 0. If startOnTick or endOnTick in an Axis options are set to false, then the alignTicks will be disabled for the Axis. Disabled for logarithmic axes.

Whether to zoom axis. If chart.zoomType is set, the option allows to disable zooming on an individual axis.

An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().

The minimum range to display on this axis. The entire axis will not be allowed to span over a smaller interval than this. For example, for a datetime axis the main unit is milliseconds. If minRange is set to 3600000, you can’t zoom in more than to one hour. The default minRange for the x axis is five times the smallest interval between any of the data points. On a logarithmic axis, the unit for the minimum range is the power. So a minRange of 1 means that the axis can be zoomed to 10-100, 100-1000, 1000-10000 etc. Note: The minPadding, maxPadding, startOnTick and endOnTick settings also affect how the extremes of the axis are computed.

In a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right. The angle determines the position of the axis line and the labels, though the coordinate system is unaffected. Since v8.0.0 this option is also applicable for X axis (inverted polar).

Whether to allow decimals in this axis' ticks. When counting integers, like persons or hits on a web page, decimals should be avoided in the labels. By default, decimals are allowed on small scale axes.

The lowest allowed value for automatically computed axis extremes.

An array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval.

Datetime axis only. An array determining what time intervals the ticks are allowed to fall on. Each array item is an array where the first value is the time unit and the second value another array of allowed multiples. Defaults to: js units: [[ 'millisecond', // unit name [1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples ], [ 'second', [1, 2, 5, 10, 15, 30] ], [ 'minute', [1, 2, 5, 10, 15, 30] ], [ 'hour', [1, 2, 3, 4, 6, 8, 12] ], [ 'day', [1, 2] ], [ 'week', [1, 2] ], [ 'month', [1, 2, 3, 4, 6] ], [ 'year', null ]]

Event handlers for the axis.

The pixel length of the main tick marks.

The dash or dot style of the minor grid lines. For possible values, see this demonstration.

The Z index for the axis group.

Color for the main tick marks. In styled mode, the stroke is given in the .highcharts-tick class.

Color of the grid lines extending the ticks across the plot area. In styled mode, the stroke is given in the .highcharts-grid-line class.

Width of the minor, secondary grid lines. In styled mode, the stroke width is given in the .highcharts-grid-line class.

Applies only when the axis type is category. When uniqueNames is true, points are placed on the X axis according to their names. If the same point name is repeated in the same or another series, the point is placed on the same X position as other points of the same name. When uniqueNames is false, the points are laid out in increasing X positions regardless of their names, and the X axis category will take the name of the last point in each position.

The amount of ticks to draw on the axis. This opens up for aligning the ticks of multiple charts or panes within a chart. This option overrides the tickPixelInterval option. This option only has an effect on linear axes. Datetime, logarithmic or category axes are not affected.

The number of minor ticks per major tick. Works for linear, logarithmic and datetime axes.

The left position as the horizontal axis. If it’s a number, it is interpreted as pixel position relative to the chart. Since Highcharts v5.0.13: If it’s a percentage string, it is interpreted as percentages of the plot width, offset from plot area left.

Add a plot band after render time.

Add a plot line after render time.

Adds the title defined in axis.options.title.

Internal function to draw a crosshair.

Hide the crosshair if visible.

Remove the axis from the chart.

Remove the axis from the chart.

Remove a plot band by its id.

Remove a plot line by its id.

Render the axis line. Called internally when rendering and redrawing the axis.

Render a minor tick into the given position. If a minor tick already exists in this position, move it.

Render a major tick into the given position. If a tick already exists in this position, move it.

Set new axis categories and optionally redraw.

Set new axis categories and optionally redraw.

Set the minimum and maximum of the axes after render time. If the startOnTick and endOnTick options are true, the minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to false before calling setExtremes. Also, setExtremes will not allow a range lower than the minRange option, which by default is the range of five points.

Set the minimum and maximum of the axes after render time. If the startOnTick and endOnTick options are true, the minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to false before calling setExtremes. Also, setExtremes will not allow a range lower than the minRange option, which by default is the range of five points.

Set the minimum and maximum of the axes after render time. If the startOnTick and endOnTick options are true, the minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to false before calling setExtremes. Also, setExtremes will not allow a range lower than the minRange option, which by default is the range of five points.

Set the minimum and maximum of the axes after render time. If the startOnTick and endOnTick options are true, the minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to false before calling setExtremes. Also, setExtremes will not allow a range lower than the minRange option, which by default is the range of five points.

Set the minimum and maximum of the axes after render time. If the startOnTick and endOnTick options are true, the minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to false before calling setExtremes. Also, setExtremes will not allow a range lower than the minRange option, which by default is the range of five points.

Now we have computed the normalized tickInterval, get the tick positions

Update the axis title by options after render time.

Update the axis title by options after render time.

Update an axis object with a new set of options. The options are merged with the existing options, so only new or altered options need to be specified.

Update an axis object with a new set of options. The options are merged with the existing options, so only new or altered options need to be specified.