HighchartsXAxisTitleOptions class
The axis title, showing next to the axis line.
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsXAxisTitleOptions
Constructors
- HighchartsXAxisTitleOptions.new({String? align, bool? enabled, double? margin, double? offset, String? position3d, bool? reserveSpace, double? rotation, bool? skew3d, HighchartsXAxisTitleStyleOptions? style, String? text, String? textAlign, bool? useHTML, double? x, double? y})
- The axis title, showing next to the axis line.
Properties
- align ↔ String?
-
Alignment of the title relative to the axis values. Possible
values are "low", "middle" or "high".
getter/setter pair
- enabled ↔ bool?
-
Deprecated. Set the
text
toundefined
to disable the title.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- margin ↔ double?
-
The pixel distance between the axis labels or line and the title.
Defaults to 0 for horizontal axes, 10 for vertical
getter/setter pair
- offset ↔ double?
-
The distance of the axis title from the axis line. By default,
this distance is computed from the offset width of the labels,
the labels' distance from the axis and the title's margin.
However when the offset option is set, it overrides all this.
getter/setter pair
- position3d ↔ String?
-
Defines how the title is repositioned according to the 3D chart
orientation.
getter/setter pair
- reserveSpace ↔ bool?
-
Whether to reserve space for the title when laying out the axis.
getter/setter pair
- rotation ↔ double?
-
The rotation of the text in degrees. 0 is horizontal, 270 is
vertical reading from bottom to top. Defaults to 0 for horizontal
axes, 270 for left-side axes and 90 for right-side axes.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- skew3d ↔ bool?
-
If enabled, the axis title will skewed to follow the perspective.
getter/setter pair
- style ↔ HighchartsXAxisTitleStyleOptions?
-
CSS styles for the title. If the title text is longer than the
axis length, it will wrap to multiple lines by default. This can
be customized by setting the
lineClamp
property, by setting a specificwidth
or by settingwhiteSpace: 'nowrap'
.getter/setter pair - text ↔ String?
-
The actual text of the axis title. It can contain basic HTML tags
like
b
,i
andspan
with style.getter/setter pair - textAlign ↔ String?
-
Alignment of the text, can be
"left"
,"right"
or"center"
. Default alignment depends on the title.align:getter/setter pair - useHTML ↔ bool?
-
Whether to use HTML
to render the axis title.
getter/setter pair
- x ↔ double?
-
Horizontal pixel offset of the title position.
getter/setter pair
- y ↔ double?
-
Vertical pixel offset of the title position.
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