io.udash.wrappers.highcharts.config.axis
YAxis
Related Docs:
trait YAxis
| package axis
In a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right.
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. Requires that the broken-axis.js module is loaded.
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 highest allowed value for automatically computed axis extremes.
Configure a crosshair that follows either the mouse pointer or the hovered point.
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'. }
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.
The lowest allowed value for automatically computed axis extremes.
Color of the grid lines extending the ticks across the plot area.
The dash or dot style of the grid lines. For possible values, see this demonstration.
Polar charts only. Whether the grid lines should draw as a polygon with straight lines between categories, or as circles.
The width of the grid lines extending the ticks across the plot area.
The Z index of the grid lines.
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.
The color of the line marking the axis itself.
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.
Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.
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.
The minimum value of the axis. If null the min value is automatically calculated. If the startOnTick option is true, the min value might be rounded down.
Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.
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.
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.. .
On axes using categories, minor ticks are not supported.
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. This is typically used with dual or multiple axes.
An array of colored bands stretching across the plot area marking an interval on the axis.. . In a gauge, a plot band on the Y axis (value axis) will stretch along the perimeter of the gauge.
An array of lines stretching across the plot area, marking a specific value on one of the axes.
Whether to reverse the axis so that the highest number is closest to the origin. If the chart is inverted, the x axis is reversed by default.
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.
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.
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.
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 minPadding option to control the axis start.
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.
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.
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..
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.
The pixel length of the main tick marks.
If tickInterval is null this option sets the approximate pixel interval of the. tick marks. Not applicable to categorized axis. 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. The automatic tick positions are accessible through this.tickPositions and can be modified by the callback.
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.
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.
The axis title, showing next to the axis line.
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.