HighchartsOBVSeriesTooltipOptions class

Highcharts Options Widget.

Inheritance

Constructors

HighchartsOBVSeriesTooltipOptions.new({double? changeDecimals, String? clusterFormat, HighchartsTooltipDateTimeLabelFormatsOptions? dateTimeLabelFormats, double? distance, bool? followPointer, bool? followTouchMove, String? footerFormat, String? format, String? headerFormat, String? nullFormat, dynamic nullFormatter, String? pointFormat, dynamic pointFormatter, HighchartsTooltipPositionOptions? position, double? valueDecimals, String? valuePrefix, String? valueSuffix, String? xDateFormat})
Highcharts Options Widget.

Properties

changeDecimals ↔ double?
How many decimals to show for the point.change or the point.cumulativeSum value when the series.compare or the series.cumulative option is set. This is overridable in each series' tooltip options object.
getter/setter pair
clusterFormat ↔ String?
The HTML of the grouped point's nodes in the tooltip. Works only for Treemap series grouping and analogously to pointFormat.
getter/setter pair
dateTimeLabelFormats ↔ HighchartsTooltipDateTimeLabelFormatsOptions?
For series on datetime axes, the date format in the tooltip's header will by default be guessed based on the closest data points. This member gives the default string representations used for each unit. For an overview of the string or object configuration, see dateFormat.
getter/setter pair
distance ↔ double?
Distance from point to tooltip in pixels.
getter/setter pair
followPointer ↔ bool?
Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent. By default it behaves this way for pie, polygon, map, sankey and wordcloud series by override in the plotOptions for those series types.
getter/setter pair
followTouchMove ↔ bool?
Whether the tooltip should update as the finger moves on a touch device. If this is true and chart.panning is set,followTouchMove will take over one-finger touches, so the user needs to use two fingers for zooming and panning.
getter/setter pair
footerFormat ↔ String?
A string to append to the tooltip format.
getter/setter pair
format ↔ String?
A format string for the whole shared tooltip. When format strings are a requirement, it is usually more convenient to use headerFormat, pointFormat and footerFormat, but the format option allows combining them into one setting.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
headerFormat ↔ String?
The HTML of the tooltip header line. The context is the Point class. Variables are enclosed in curly brackets. Examples of common variables to include are x, y, series.name and series.color and other properties on the same form. The point.key variable contains the category name, x value or datetime string depending on the type of axis. For datetime axes, the point.key date format can be set using tooltip.xDateFormat.
getter/setter pair
nullFormat ↔ String?
The HTML of the null point's line in the tooltip. Works analogously to pointFormat.
getter/setter pair
nullFormatter ↔ dynamic
Callback function to format the text of the tooltip for visible null points. Works analogously to formatter.
getter/setter pair
pointFormat ↔ String?
The HTML of the point's line in the tooltip. The context is the Point class. Variables are enclosed in curly brackets. Examples of common variables to include are x, y, series.name and series.color and other properties on the same form. Furthermore, y can be extended by the tooltip.valuePrefix and tooltip.valueSuffix variables. This can also be overridden for each series, which makes it a good hook for displaying units.
getter/setter pair
pointFormatter ↔ dynamic
A callback function for formatting the HTML output for a single point in the tooltip. Like the pointFormat string, but with more flexibility.
getter/setter pair
position ↔ HighchartsTooltipPositionOptions?
Positioning options for fixed tooltip, taking effect only when tooltip.fixed is true.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
valueDecimals ↔ double?
Highcharts Options Widget.
getter/setter pair
valuePrefix ↔ String?
A string to prepend to each series' y value. Overridable in each series' tooltip options object.
getter/setter pair
valueSuffix ↔ String?
A string to append to each series' y value. Overridable in each series' tooltip options object.
getter/setter pair
xDateFormat ↔ String?
The format for the date in the tooltip header if the X axis is a datetime axis. The default is a best guess based on the smallest distance between points in the chart.
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