YAxis
Related Docs:
class YAxis
| package config
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.
When using an alternate grid color, a band is painted across the plot area between every other grid line.
An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.
The highest allowed value for automatically computed axis extremes.
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. By default, the crosshair is enabled on the X axis and disabled on Y axis.. .
In styled mode, the crosshairs are styled in the .highcharts-crosshair, .highcharts-crosshair-thin or .highcharts-xaxis-category classes.
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:.
{. 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'. }
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.
The lowest allowed value for automatically computed axis extremes.
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.
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.
The Z index of the grid lines.
The height of the Y axis. If it's a number, it is interpreted as pixels.. Since Highstock 2: If it's a percentage string, it is interpreted as percentages of the total plot height.
An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
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.
The width of the line marking the axis itself.
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 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 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.
Deprecated. Use minRange instead.
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.
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 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. 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 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. Defaults to the closest distance between two points on the axis.
Color of the minor, secondary grid lines.. . .
In styled mode, the stroke width is given in the .highcharts-minor-grid-line class.
The dash or dot style of the minor grid lines. For possible values, see this demonstration.
Width of the minor, secondary grid lines.. .
In styled mode, the stroke width is given in the .highcharts-grid-line class.
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. In Highstock 1.x, the Y axis was placed on the left side by default.
In an ordinal axis, the points are equally spaced in the chart regardless of the actual time or x distance between them. This means that missing data for nights or weekends will not take up space in the chart.
An array of objects defining plot bands on the Y axis.
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 zoomed range to display when only defining one or none of min or max. For example, to show the latest month, a range of one month can be set.
Whether to reverse the axis so that the highest number is closest to the origin.
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.
An optional scrollbar to display on the Y axis in response to limiting the minimum an maximum of the axis values.. .
In styled mode, all the presentational options for the scrollbar are replaced by the classes .highcharts-scrollbar-thumb, .highcharts-scrollbar-arrow, .highcharts-scrollbar-button, .highcharts-scrollbar-rifles and .highcharts-scrollbar-track.
Whether to show the axis line and title when the axis has no data.
Whether to show the first tick label.
Whether to show the last tick label.
A soft maximum for the axis. If the series data maximum is greater 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.
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.
For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.
Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start.
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.
Color for the main tick marks.. .
In styled mode, the stroke is given in the .highcharts-tick class.
The interval of the tick marks in axis units. When null, the tick interval is computed to approximately follow the tickPixelInterval on linear and datetime axes. On categorized axes, a null 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..
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.
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 to compute on what values the ticks should be placed. Returns an array of numbers. The min and max of the axis are passed in as the first and second parameter. Options like tickInterval can be accessed by this.options.tickInterval. The automatic tick positions are accessible through this.tickPositions and can be modified by the callback.Note that in stock charts, the last label is hidden by default by the showLastLabel option.
A collection of hard coded tick value positions. This overrides the auto computed positions based on tickInterval and tickPixelInterval. See also tickPositioner.
The pixel width of the major tick marks.
The top position of the Y axis. If it's a number, it is interpreted as pixel position relative to the chart.. Since Highstock 2: If it's a percentage string, it is interpreted as percentages of the plot height, offset from plot area top.
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:.
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]. ], [. 'week',. [1]. ], [. 'month',. [1, 3, 6]. ], [. 'year',. null. ]]
Whether axis, including axis title, line, ticks and labels, should be visible.