HighchartsYAxisLabelsOptions class

Highcharts Options Widget.

Inheritance

Constructors

HighchartsYAxisLabelsOptions.new({String? align, bool? allowOverlap, List<double>? autoRotation, double? autoRotationLimit, dynamic distance, bool? enabled, String? format, dynamic formatter, double? indentation, List<HighchartsYAxisLabelsLevelsOptions>? levels, double? maxStaggerLines, String? overflow, double? padding, String? position3d, bool? reserveSpace, double? rotation, bool? skew3d, double? staggerLines, double? step, HighchartsXAxisLabelsStyleOptions? style, HighchartsYAxisLabelsSymbolOptions? symbol, bool? useHTML, double? x, double? y, double? zIndex})
Highcharts Options Widget.

Properties

align ↔ String?
What part of the string the given position is anchored to. Can be one of "left", "center" or "right". The exact position also depends on the labels.x setting.
getter/setter pair
allowOverlap ↔ bool?
Whether to allow the axis labels to overlap. When false, overlapping labels are hidden.
getter/setter pair
autoRotation ↔ List<double>?
For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels. If there is enough space, labels are not rotated. As the chart gets narrower, it will start rotating the labels -45 degrees, then remove every second label and try again with rotations 0 and -45 etc. Set it to undefined to disable rotation, which will cause the labels to word-wrap if possible. Defaults to [-45]`` on bottom and top axes, undefined` on left and right axes.
getter/setter pair
autoRotationLimit ↔ double?
When each category width is more than this many pixels, we don't apply auto rotation. Instead, we lay out the axis label with word wrap. A lower limit makes sense when the label contains multiple short words that don't extend the available horizontal space for each label.
getter/setter pair
distance ↔ dynamic
The label's pixel distance from the perimeter of the plot area. On cartesian charts, this is overridden if the labels.y setting is set.
getter/setter pair
enabled ↔ bool?
Enable or disable the axis labels.
getter/setter pair
format ↔ String?
A format string for the axis label. The context is available as format string variables. For example, you can use {text} to insert the default formatted text. The recommended way of adding units for the label is using text, for example {text} km.
getter/setter pair
formatter ↔ dynamic
Callback JavaScript function to format the label. The value is given by this.value. Additional properties for this are axis, chart, isFirst, isLast and text which holds the value of the default formatter.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
indentation ↔ double?
The number of pixels to indent the labels per level in a treegrid axis.
getter/setter pair
levels ↔ List<HighchartsYAxisLabelsLevelsOptions>?
Set options on specific levels in a tree grid axis. Takes precedence over labels options.
getter/setter pair
maxStaggerLines ↔ double?
Horizontal axis only. When staggerLines is not set, maxStaggerLines defines how many lines the axis is allowed to add to automatically avoid overlapping X labels. Set to 1 to disable overlap detection.
getter/setter pair
overflow ↔ String?
How to handle overflowing labels on horizontal axis. If set to "allow", it will not be aligned at all. By default it "justify" labels inside the chart area. If there is room to move it, it will be aligned to the edge, else it will be removed.
getter/setter pair
padding ↔ double?
The pixel padding for axis labels, to ensure white space between them. Defaults to 4 for horizontal axes, 1 for vertical.
getter/setter pair
position3d ↔ String?
Defines how the labels are be repositioned according to the 3D chart orientation.
getter/setter pair
reserveSpace ↔ bool?
Whether to reserve space for the labels. By default, space is reserved for the labels in these cases:
getter/setter pair
rotation ↔ double?
Rotation of the labels in degrees. When undefined, the autoRotation option takes precedence.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skew3d ↔ bool?
If enabled, the axis labels will skewed to follow the perspective.
getter/setter pair
staggerLines ↔ double?
Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels. 0 disables staggering.
getter/setter pair
step ↔ double?
To show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label.
getter/setter pair
style ↔ HighchartsXAxisLabelsStyleOptions?
CSS styles for the label. Use lineClamp to control wrapping of category labels. Use textOverflow: 'none' to prevent ellipsis (dots).
getter/setter pair
symbol ↔ HighchartsYAxisLabelsSymbolOptions?
The symbol for the collapse and expand icon in a treegrid.
getter/setter pair
useHTML ↔ bool?
Whether to use HTML to render the labels.
getter/setter pair
x ↔ double?
The x position offset of all labels relative to the tick positions on the axis. Defaults to -15 for left axis, 15 for right axis.
getter/setter pair
y ↔ double?
The y position offset of all labels relative to the tick positions on the axis. For polar and radial axis consider the use of the distance option.
getter/setter pair
zIndex ↔ double?
The Z index for the axis labels.
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