HighchartsCaptionOptions class

The chart's caption, which will render below the chart and will be part of exported charts. The caption can be updated after chart initialization through the Chart.update or Chart.caption.update methods.

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

Inheritance

Constructors

HighchartsCaptionOptions.new({String? align, bool? floating, double? margin, HighchartsCaptionStyleOptions? style, String? text, bool? useHTML, String? verticalAlign, double? x, double? y})
The chart's caption, which will render below the chart and will be part of exported charts. The caption can be updated after chart initialization through the Chart.update or Chart.caption.update methods.

Properties

align ↔ String?
The horizontal alignment of the caption. Can be one of "left", "center" and "right".
getter/setter pair
floating ↔ bool?
When the caption 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
margin ↔ double?
The margin between the caption and the plot area.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style ↔ HighchartsCaptionStyleOptions?
CSS styles for the caption.
getter/setter pair
text ↔ String?
The caption text 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 caption. Can be one of "top", "middle" and "bottom". When middle, the caption behaves as floating.
getter/setter pair
x ↔ double?
The x position of the caption relative to the alignment within chart.spacingLeft and chart.spacingRight.
getter/setter pair
y ↔ double?
The y position of the caption relative to the alignment within chart.spacingTop and chart.spacingBottom.
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