HighchartsBoostOptions class

Options for the Boost module. The Boost module allows certain series types to be rendered by WebGL instead of the default SVG. This allows hundreds of thousands of data points to be rendered in milliseconds. In addition to the WebGL rendering it saves time by skipping processing and inspection of the data wherever possible. This introduces some limitations to what features are available in boost mode. See the docs for details.

In addition to the global boost option, each series has a boostThreshold that defines when the boost should kick in.

Requires the modules/boost.js module.

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

Inheritance

Constructors

HighchartsBoostOptions.new({bool? allowForce, HighchartsBoostDebugOptions? debug, bool? enabled, double? pixelRatio, double? seriesThreshold, bool? useGPUTranslations, bool? usePreallocated})
Options for the Boost module. The Boost module allows certain series types to be rendered by WebGL instead of the default SVG. This allows hundreds of thousands of data points to be rendered in milliseconds. In addition to the WebGL rendering it saves time by skipping processing and inspection of the data wherever possible. This introduces some limitations to what features are available in boost mode. See the docs for details.

Properties

allowForce ↔ bool?
The chart will be boosted, if one of the series crosses its threshold and all the series in the chart can be boosted.
getter/setter pair
debug ↔ HighchartsBoostDebugOptions?
Debugging options for boost. Useful for benchmarking, and general timing.
getter/setter pair
enabled ↔ bool?
Enable or disable boost on a chart.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
pixelRatio ↔ double?
The pixel ratio for the WebGL content. If 0, the window.devicePixelRatio is used. This ensures sharp graphics on high DPI displays like Apple's Retina, as well as when a page is zoomed.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seriesThreshold ↔ double?
Set the series threshold for when the boost should kick in globally.
getter/setter pair
useGPUTranslations ↔ bool?
Enable or disable GPU translations. GPU translations are faster than doing the translation in JavaScript.
getter/setter pair
usePreallocated ↔ bool?
Enable or disable pre-allocation of vertex buffers.
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