HighchartsYAxisOptions class

The Y axis or value axis. Normally this is the vertical axis, though if the chart is inverted this is the horizontal axis. In case of multiple axes, the yAxis node is an array of configuration objects.

See the Axis object for programmatic access to the axis.

API Docs: https://api.highcharts.com/highcharts/yAxis

Inheritance

Constructors

HighchartsYAxisOptions.new({HighchartsXAxisAccessibilityOptions? accessibility, bool? alignTicks, bool? allowDecimals, String? alternateGridColor, double? angle, List<HighchartsXAxisBreaksOptions>? breaks, List<String>? categories, double? ceiling, String? className, HighchartsXAxisCrosshairOptions? crosshair, double? crossing, HighchartsXAxisDateTimeLabelFormatsOptions? dateTimeLabelFormats, bool? endOnTick, HighchartsXAxisEventsOptions? events, double? floor, HighchartsXAxisGridOptions? grid, String? gridLineColor, String? gridLineDashStyle, String? gridLineInterpolation, double? gridLineWidth, double? gridZIndex, dynamic height, String? id, HighchartsYAxisLabelsOptions? labels, dynamic left, String? lineColor, double? lineWidth, double? linkedTo, double? margin, dynamic max, String? maxColor, dynamic maxLength, double? maxPadding, double? maxRange, double? maxZoom, dynamic min, String? minColor, dynamic minLength, double? minPadding, double? minRange, double? minTickInterval, String? minorGridLineColor, String? minorGridLineDashStyle, double? minorGridLineWidth, String? minorTickColor, String? minorTickInterval, double? minorTickLength, String? minorTickPosition, double? minorTickWidth, bool? minorTicks, double? minorTicksPerMajor, double? offset, bool? opposite, double? pane, bool? panningEnabled, List<HighchartsYAxisPlotBandsOptions>? plotBands, List<HighchartsYAxisPlotLinesOptions>? plotLines, double? range, HighchartsYAxisResizeOptions? resize, bool? reversed, bool? reversedStacks, HighchartsYAxisScrollbarOptions? scrollbar, bool? showEmpty, bool? showFirstLabel, bool? showLastLabel, double? softMax, double? softMin, HighchartsYAxisStackLabelsOptions? stackLabels, HighchartsYAxisStackShadowOptions? stackShadow, double? startOfWeek, bool? startOnTick, double? staticScale, List<List>? stops, double? tickAmount, String? tickColor, double? tickInterval, double? tickLength, double? tickPixelInterval, String? tickPosition, dynamic tickPositioner, List<double>? tickPositions, double? tickWidth, String? tickmarkPlacement, HighchartsYAxisTitleOptions? title, String? tooltipValueFormat, dynamic top, String? type, bool? uniqueNames, List<List>? units, bool? visible, dynamic width, double? zIndex, bool? zoomEnabled})
The Y axis or value axis. Normally this is the vertical axis, though if the chart is inverted this is the horizontal axis. In case of multiple axes, the yAxis node is an array of configuration objects.

Properties

accessibility ↔ HighchartsXAxisAccessibilityOptions?
Accessibility options for an axis. Requires the accessibility module.
getter/setter pair
alignTicks ↔ bool?
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.
getter/setter pair
allowDecimals ↔ bool?
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.
getter/setter pair
alternateGridColor ↔ String?
When using an alternate grid color, a band is painted across the plot area between every other grid line.
getter/setter pair
angle ↔ double?
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).
getter/setter pair
breaks ↔ List<HighchartsXAxisBreaksOptions>?
An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.
getter/setter pair
categories ↔ List<String>?
If categories are present for the xAxis, names are used instead of numbers for that axis.
getter/setter pair
ceiling ↔ double?
The highest allowed value for automatically computed axis extremes.
getter/setter pair
className ↔ String?
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.
getter/setter pair
crosshair ↔ HighchartsXAxisCrosshairOptions?
Configure a crosshair that follows either the mouse pointer or the hovered point.
getter/setter pair
crossing ↔ double?
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.
getter/setter pair
dateTimeLabelFormats ↔ HighchartsXAxisDateTimeLabelFormatsOptions?
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.
getter/setter pair
endOnTick ↔ bool?
Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
getter/setter pair
events ↔ HighchartsXAxisEventsOptions?
Event handlers for the axis.
getter/setter pair
floor ↔ double?
The lowest allowed value for automatically computed axis extremes.
getter/setter pair
grid ↔ HighchartsXAxisGridOptions?
Set grid options for the axis labels. Requires Highcharts Gantt.
getter/setter pair
gridLineColor ↔ String?
Color of the grid lines extending the ticks across the plot area.
getter/setter pair
gridLineDashStyle ↔ String?
The dash or dot style of the grid lines. For possible values, see this demonstration.
getter/setter pair
gridLineInterpolation ↔ String?
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).
getter/setter pair
gridLineWidth ↔ double?
Highcharts Options Widget.
getter/setter pair
gridZIndex ↔ double?
The Z index of the grid lines.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ dynamic
The height of the Y axis. If it's a number, it is interpreted as pixels.
getter/setter pair
id ↔ String?
An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
getter/setter pair
labels ↔ HighchartsYAxisLabelsOptions?
Highcharts Options Widget.
getter/setter pair
left ↔ dynamic
The left position as the horizontal axis. If it's a number, it is interpreted as pixel position relative to the chart.
getter/setter pair
lineColor ↔ String?
The color of the line marking the axis itself.
getter/setter pair
lineWidth ↔ double?
Highcharts Options Widget.
getter/setter pair
linkedTo ↔ double?
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.
getter/setter pair
margin ↔ double?
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.
getter/setter pair
max ↔ dynamic
Highcharts Options Widget.
getter/setter pair
maxColor ↔ String?
Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.
getter/setter pair
maxLength ↔ dynamic
Maximal size of a resizable axis. Could be set as a percent of plot area or pixel size.
getter/setter pair
maxPadding ↔ double?
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.
getter/setter pair
maxRange ↔ double?
Maximum range which can be set using the navigator's handles. Opposite of xAxis.minRange.
getter/setter pair
maxZoom ↔ double?
Deprecated. Use minRange instead.
getter/setter pair
min ↔ dynamic
Highcharts Options Widget.
getter/setter pair
minColor ↔ String?
Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.
getter/setter pair
minLength ↔ dynamic
Minimal size of a resizable axis. Could be set as a percent of plot area or pixel size.
getter/setter pair
minorGridLineColor ↔ String?
Color of the minor, secondary grid lines.
getter/setter pair
minorGridLineDashStyle ↔ String?
The dash or dot style of the minor grid lines. For possible values, see this demonstration.
getter/setter pair
minorGridLineWidth ↔ double?
Width of the minor, secondary grid lines.
getter/setter pair
minorTickColor ↔ String?
Color for the minor tick marks.
getter/setter pair
minorTickInterval ↔ String?
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.
getter/setter pair
minorTickLength ↔ double?
The pixel length of the minor tick marks.
getter/setter pair
minorTickPosition ↔ String?
The position of the minor tick marks relative to the axis line. Can be one of inside and outside.
getter/setter pair
minorTicks ↔ bool?
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.
getter/setter pair
minorTicksPerMajor ↔ double?
The number of minor ticks per major tick. Works for linear, logarithmic and datetime axes.
getter/setter pair
minorTickWidth ↔ double?
The pixel width of the minor tick mark.
getter/setter pair
minPadding ↔ double?
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.
getter/setter pair
minRange ↔ double?
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.
getter/setter pair
minTickInterval ↔ double?
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.
getter/setter pair
offset ↔ double?
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.
getter/setter pair
opposite ↔ bool?
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.
getter/setter pair
pane ↔ double?
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.
getter/setter pair
panningEnabled ↔ bool?
Whether to pan axis. If chart.panning is enabled, the option allows to disable panning on an individual axis.
getter/setter pair
plotBands ↔ List<HighchartsYAxisPlotBandsOptions>?
Highcharts Options Widget.
getter/setter pair
plotLines ↔ List<HighchartsYAxisPlotLinesOptions>?
Highcharts Options Widget.
getter/setter pair
range ↔ double?
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.
getter/setter pair
resize ↔ HighchartsYAxisResizeOptions?
Options for axis resizing. It adds a thick line between panes which the user can drag in order to resize the panes.
getter/setter pair
reversed ↔ bool?
Whether to reverse the axis so that the highest number is closest to the origin.
getter/setter pair
reversedStacks ↔ bool?
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.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollbar ↔ HighchartsYAxisScrollbarOptions?
An optional scrollbar to display on the Y axis in response to limiting the minimum an maximum of the axis values.
getter/setter pair
showEmpty ↔ bool?
Whether to show the axis line and title when the axis has no data.
getter/setter pair
showFirstLabel ↔ bool?
Whether to show the first tick label.
getter/setter pair
showLastLabel ↔ bool?
Whether to show the last tick label.
getter/setter pair
softMax ↔ double?
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.
getter/setter pair
softMin ↔ double?
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.
getter/setter pair
stackLabels ↔ HighchartsYAxisStackLabelsOptions?
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.
getter/setter pair
stackShadow ↔ HighchartsYAxisStackShadowOptions?
Relevant only for pictorial series. The stackShadow forms the background of stacked points. Requires series.stacking to be defined.
getter/setter pair
startOfWeek ↔ double?
For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.
getter/setter pair
startOnTick ↔ bool?
Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start.
getter/setter pair
staticScale ↔ double?
For vertical axes only. Setting the static scale ensures that each tick unit is translated into a fixed pixel height. For example, setting the static scale to 24 results in each Y axis category taking up 24 pixels, and the height of the chart adjusts. Adding or removing items will make the chart resize.
getter/setter pair
stops ↔ List<List>?
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.
getter/setter pair
tickAmount ↔ double?
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.
getter/setter pair
tickColor ↔ String?
Color for the main tick marks.
getter/setter pair
tickInterval ↔ double?
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.
getter/setter pair
tickLength ↔ double?
The pixel length of the main tick marks.
getter/setter pair
tickmarkPlacement ↔ String?
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.
getter/setter pair
tickPixelInterval ↔ double?
Highcharts Options Widget.
getter/setter pair
tickPosition ↔ String?
The position of the major tick marks relative to the axis line. Can be one of inside and outside.
getter/setter pair
tickPositioner ↔ dynamic
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.
getter/setter pair
tickPositions ↔ List<double>?
An array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval.
getter/setter pair
tickWidth ↔ double?
The pixel width of the major tick marks.
getter/setter pair
title ↔ HighchartsYAxisTitleOptions?
Highcharts Options Widget.
getter/setter pair
tooltipValueFormat ↔ String?
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:
getter/setter pair
top ↔ dynamic
The top position of the Y axis. If it's a number, it is interpreted as pixel position relative to the chart.
getter/setter pair
type ↔ String?
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.
getter/setter pair
uniqueNames ↔ bool?
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.
getter/setter pair
units ↔ List<List>?
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.
getter/setter pair
visible ↔ bool?
Whether axis, including axis title, line, ticks and labels, should be visible.
getter/setter pair
width ↔ dynamic
The width as the horizontal axis. If it's a number, it is interpreted as pixels.
getter/setter pair
zIndex ↔ double?
The Z index for the axis group.
getter/setter pair
zoomEnabled ↔ bool?
Whether to zoom axis. If chart.zoomType is set, the option allows to disable zooming on an individual axis.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited