HCCaptionOptions class

(Highcharts, Highstock, Highmaps, Gantt) 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.

Implemented types

Constructors

HCCaptionOptions({String? align, bool? floating, num? margin, dynamic style, String? text, bool? useHTML, String? verticalAlign, num? x, num? y})
const

Properties

align → String?
(Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of the caption. Can be one of "left", "center" and "right".
final
floating → bool?
(Highcharts, Highstock, Highmaps, Gantt) When the caption is floating, the plot area will not move to make space for it.
final
hashCode → int
The hash code for this object.
no setterinherited
margin → num?
(Highcharts, Highstock, Highmaps, Gantt) The margin between the caption and the plot area.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → dynamic
(Highcharts, Highstock, Highmaps, Gantt) CSS styles for the caption.
final
text → String?
(Highcharts, Highstock, Highmaps, Gantt) The caption text of the chart.
final
useHTML → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render the text.
final
verticalAlign → String?
(Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the caption. Can be one of "top", "middle" and "bottom". When middle, the caption behaves as floating.
final
x → num?
(Highcharts, Highstock, Highmaps, Gantt) The x position of the caption relative to the alignment within chart.spacingLeft and chart.spacingRight.
final
y → num?
(Highcharts, Highstock, Highmaps, Gantt) The y position of the caption relative to the alignment within chart.spacingTop and chart.spacingBottom.
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