HCYAxisOptions class

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

Implemented types

Constructors

HCYAxisOptions({HCAxisAccessibilityOptionsObject? accessibility, bool? alignTicks, bool? allowDecimals, dynamic alternateGridColor, num? angle, dynamic borderColor, num? borderWidth, List<HCYAxisBreaksOptions>? breaks, List<String>? categories, num? ceiling, String? className, dynamic color, dynamic crosshair, num? crossing, HCAxisDateTimeLabelFormatsOptions? dateTimeLabelFormats, bool? enabled, bool? endOnTick, HCYAxisEventsOptions? events, num? floor, HCYAxisGridOptions? grid, dynamic gridLineColor, String? gridLineDashStyle, String? gridLineInterpolation, num? gridLineWidth, num? gridZIndex, dynamic height, String? id, HCYAxisLabelsOptions? labels, dynamic left, dynamic lineColor, num? lineWidth, num? linkedTo, num? margin, dynamic max, dynamic maxColor, dynamic maxLength, num? maxPadding, num? maxRange, num? maxZoom, dynamic min, dynamic minColor, dynamic minLength, dynamic minorGridLineColor, String? minorGridLineDashStyle, num? minorGridLineWidth, dynamic minorTickColor, dynamic minorTickInterval, num? minorTickLength, String? minorTickPosition, bool? minorTicks, num? minorTicksPerMajor, num? minorTickWidth, num? minPadding, num? minRange, num? minTickInterval, num? offset, bool? opposite, num? pane, bool? panningEnabled, List<HCYAxisPlotBandsOptions>? plotBands, List<HCYAxisPlotLinesOptions>? plotLines, num? range, HCYAxisResizeOptions? resize, bool? reversed, bool? reversedStacks, HCYAxisScrollbarOptions? scrollbar, bool? showEmpty, bool? showFirstLabel, bool? showLastLabel, num? softMax, num? softMin, HCYAxisStackLabelsOptions? stackLabels, HCYAxisOptions? stackShadow, num? startOfWeek, bool? startOnTick, num? staticScale, List? stops, num? tickAmount, dynamic tickColor, num? tickInterval, num? tickLength, String? tickmarkPlacement, num? tickPixelInterval, String? tickPosition, List<num>? tickPositions, num? tickWidth, HCYAxisTitleOptions? title, String? tooltipValueFormat, dynamic top, String? type, bool? uniqueNames, List? units, bool? visible, dynamic width, num? zIndex, bool? zoomEnabled})
const

Properties

accessibility → HCAxisAccessibilityOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an axis. Requires the accessibility module.
final
alignTicks → bool?
(Highcharts, Highstock, Gantt) 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.
final
allowDecimals → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
alternateGridColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) When using an alternate grid color, a band is painted across the plot area between every other grid line.
final
angle → num?
(Highcharts) 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).
final
borderColor → dynamic
(Highcharts) The color of the stackShadow border.
final
borderWidth → num?
(Highcharts) The width of the stackShadow border.
final
breaks → List<HCYAxisBreaksOptions>?
(Highcharts, Highstock, Gantt) An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.
final
categories → List<String>?
(Highcharts, Gantt) If categories are present for the xAxis, names are used instead of numbers for that axis.
final
ceiling → num?
(Highcharts, Highstock, Gantt) The highest allowed value for automatically computed axis extremes.
final
className → String?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
color → dynamic
(Highcharts) The color of the stackShadow.
final
crosshair → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Configure a crosshair that follows either the mouse pointer or the hovered point.
final
crossing → num?
(Highcharts, Highstock, Highmaps, Gantt) 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 cli
final
dateTimeLabelFormats → HCAxisDateTimeLabelFormatsOptions?
(Highcharts, Highstock, Gantt) For a datetime axis, the scale will automatically adjust to the appropriate unit. This member gives the default representations used for each unit. For easier data interpretation, hour, day, month and year units can be used and formatted as boundary tick values
final
enabled → bool?
(Highcharts) Enable or disable stackShadow.
final
endOnTick → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
final
events → HCYAxisEventsOptions?
(Highcharts, Highstock, Highmaps, Gantt) Event handlers for the axis.
final
floor → num?
(Highcharts, Highstock, Gantt) The lowest allowed value for automatically computed axis extremes.
final
grid → HCYAxisGridOptions?
(Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
final
gridLineColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Color of the grid lines extending the ticks across the plot area.
final
gridLineDashStyle → String?
(Highcharts, Highstock, Highmaps, Gantt) The dash or dot style of the grid lines. For possible values, see this demonstration.
final
gridLineInterpolation → String?
(Highcharts) 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).
final
gridLineWidth → num?
(Highcharts, Highstock, Highmaps, Gantt) 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 and gauges.
final
gridZIndex → num?
(Highcharts, Highstock, Gantt) The Z index of the grid lines.
final
hashCode → int
The hash code for this object.
no setterinherited
height → dynamic
(Highcharts, Highstock) The height of the Y axis. If it's a number, it is interpreted as pixels.
final
id → String?
(Highcharts, Highstock, Highmaps, Gantt) An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
final
labels → HCYAxisLabelsOptions?
(Highcharts, Highstock, Highmaps, Gantt) The axis labels show the number or category for each tick.
final
left → dynamic
(Highcharts, Highstock) The left position as the horizontal axis. If it's a number, it is interpreted as pixel position relative to the chart.
final
lineColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) The color of the line marking the axis itself.
final
lineWidth → num?
(Highcharts, Highstock, Highmaps, Gantt) The width of the line marking the axis itself.
final
linkedTo → num?
(Highcharts, Highstock, Gantt) 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 duplicatin
final
margin → num?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
max → dynamic
(Highcharts, Highstock, Highmaps, Gantt) The maximum value of the axis. If undefined, the max value is automatically calculated.
final
maxColor → dynamic
(Highcharts) Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.
final
maxLength → dynamic
(Highstock) Maximal size of a resizable axis. Could be set as a percent of plot area or pixel size.
final
maxPadding → num?
(Highcharts, Highstock, Gantt) 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 se
final
maxRange → num?
(Highstock, Gantt) Maximum range which can be set using the navigator's handles. Opposite of xAxis.minRange.
final
maxZoom → num?
(Highcharts, Highstock) Deprecated. Use minRange instead.
final
min → dynamic
(Highcharts, Highstock, Highmaps, Gantt) The minimum value of the axis. If undefined, the min value is automatically calculated.
final
minColor → dynamic
(Highcharts) Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.
final
minLength → dynamic
(Highstock) Minimal size of a resizable axis. Could be set as a percent of plot area or pixel size.
final
minorGridLineColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Color of the minor, secondary grid lines.
final
minorGridLineDashStyle → String?
(Highcharts, Highstock, Highmaps, Gantt) The dash or dot style of the minor grid lines. For possible values, see this demonstration.
final
minorGridLineWidth → num?
(Highcharts, Highstock, Highmaps, Gantt) Width of the minor, secondary grid lines.
final
minorTickColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Color for the minor tick marks.
final
minorTickInterval → dynamic
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
minorTickLength → num?
(Highcharts, Highstock, Highmaps, Gantt) The pixel length of the minor tick marks.
final
minorTickPosition → String?
(Highcharts, Highstock, Highmaps, Gantt) The position of the minor tick marks relative to the axis line. Can be one of inside and outside.
final
minorTicks → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
minorTicksPerMajor → num?
(Highcharts, Highstock, Highmaps, Gantt) The number of minor ticks per major tick. Works for linear, logarithmic and datetime axes.
final
minorTickWidth → num?
(Highcharts, Highstock, Highmaps, Gantt) The pixel width of the minor tick mark.
final
minPadding → num?
(Highcharts, Highstock, Gantt) 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
final
minRange → num?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
minTickInterval → num?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
offset → num?
(Highcharts, Highstock, Highmaps, Gantt) The distance in pixels from the plot area to the axis line. A positive offset moves the axis with its 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 t
final
opposite → bool?
(Highstock, Highcharts, Gantt) 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.
final
pane → num?
(Highcharts) 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.
final
panningEnabled → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to pan axis. If chart.panning is enabled, the option allows to disable panning on an individual axis.
final
plotBands → List<HCYAxisPlotBandsOptions>?
(Highcharts, Highstock, Gantt) An array of colored bands stretching across the plot area marking an interval on the axis.
final
plotLines → List<HCYAxisPlotLinesOptions>?
(Highcharts, Highstock, Gantt) An array of lines stretching across the plot area, marking a specific value on one of the axes.
final
range → num?
(Highstock) 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.
final
resize → HCYAxisResizeOptions?
(Highstock) Options for axis resizing. It adds a thick line between panes which the user can drag in order to resize the panes.
final
reversed → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to reverse the axis so that the highest number is closest to the origin.
final
reversedStacks → bool?
(Highcharts, Highstock) 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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollbar → HCYAxisScrollbarOptions?
(Highstock) An optional scrollbar to display on the Y axis in response to limiting the minimum an maximum of the axis values.
final
showEmpty → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to show the axis line and title when the axis has no data.
final
showFirstLabel → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to show the first tick label.
final
showLastLabel → bool?
(Highcharts, Highstock, Gantt) Whether to show the last tick label.
final
softMax → num?
(Highcharts, Highstock, Gantt) 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.
final
softMin → num?
(Highcharts, Highstock, Gantt) 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.
final
stackLabels → HCYAxisStackLabelsOptions?
(Highcharts) 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 ne
final
stackShadow → HCYAxisOptions?
(Highcharts) Relevant only for pictorial series. The stackShadow forms the background of stacked points. Requires series.stacking to be defined.
final
startOfWeek → num?
(Highcharts, Highstock, Gantt) For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.
final
startOnTick → bool?
(Highcharts, Highstock, Gantt) Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start.
final
staticScale → num?
(Highcharts, Highstock, Gantt) 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 removin
final
stops → List?
(Highcharts) 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, an
final
tickAmount → num?
(Highcharts, Highstock, Gantt) 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.
final
tickColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Color for the main tick marks.
final
tickInterval → num?
(Highcharts, Highstock, Highmaps, Gantt) 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
final
tickLength → num?
(Highcharts, Highstock, Highmaps, Gantt) The pixel length of the main tick marks.
final
tickmarkPlacement → String?
(Highcharts, Gantt) 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 p
final
tickPixelInterval → num?
(Highcharts, Highstock, Highmaps, Gantt) If tickInterval is null this option sets the approximate pixel interval of the tick marks. Not applicable to categorized axis.
final
tickPosition → String?
(Highcharts, Highstock, Highmaps, Gantt) The position of the major tick marks relative to the axis line. Can be one of inside and outside.
final
tickPositions → List<num>?
(Highcharts, Highstock, Highmaps, Gantt) An array defining where the ticks are laid out on the axis. This overrides the default behavior of tickPixelInterval and tickInterval.
final
tickWidth → num?
(Highcharts, Highstock, Gantt) The pixel width of the major tick marks.
final
title → HCYAxisTitleOptions?
(Highcharts, Highstock, Highmaps, Gantt) The axis title, showing next to the axis line.
final
tooltipValueFormat → String?
(Highcharts) 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:
final
top → dynamic
(Highcharts, Highstock) The top position of the Y axis. If it's a number, it is interpreted as pixel position relative to the chart.
final
type → String?
(Highcharts, Gantt) 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.
final
uniqueNames → bool?
(Highcharts, Gantt) 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. Wh
final
units → List?
(Highcharts, Highstock, Gantt) 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.
final
visible → bool?
(Highcharts, Highstock, Gantt) Whether axis, including axis title, line, ticks and labels, should be visible.
final
width → dynamic
(Highcharts, Highstock) The width as the horizontal axis. If it's a number, it is interpreted as pixels.
final
zIndex → num?
(Highcharts, Highstock, Highmaps, Gantt) The Z index for the axis group.
final
zoomEnabled → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to zoom axis. If chart.zoomType is set, the option allows to disable zooming on an individual axis.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

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