HighchartsSubtitleOptions class

The chart's subtitle. This can be used both to display a subtitle below the main title, and to display random text anywhere in the chart. The subtitle can be updated after chart initialization through the Chart.setTitle method.

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

Inheritance

Constructors

HighchartsSubtitleOptions.new({String? align, bool? floating, HighchartsSubtitleStyleOptions? style, String? text, bool? useHTML, String? verticalAlign, double? x, double? y})
The chart's subtitle. This can be used both to display a subtitle below the main title, and to display random text anywhere in the chart. The subtitle can be updated after chart initialization through the Chart.setTitle method.

Properties

align ↔ String?
The horizontal alignment of the subtitle. Can be one of "left", "center" and "right". Since v12, it defaults to undefined, meaning the actual alignment is inherited from the alignment of the main title.
getter/setter pair
floating ↔ bool?
When the subtitle is floating, the plot area will not move to make space for it.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style ↔ HighchartsSubtitleStyleOptions?
CSS styles for the title.
getter/setter pair
text ↔ String?
The subtitle of the chart.
getter/setter pair
useHTML ↔ bool?
Whether to use HTML to render the text.
getter/setter pair
verticalAlign ↔ String?
The vertical alignment of the title. Can be one of "top", "middle" and "bottom". When middle, the subtitle behaves as floating.
getter/setter pair
x ↔ double?
The x position of the subtitle relative to the alignment within chart.spacingLeft and chart.spacingRight.
getter/setter pair
y ↔ double?
The y position of the subtitle relative to the alignment within chart.spacingTop and chart.spacingBottom. By default the subtitle is laid out below the title unless the title is floating.
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