Highcharts .NET  11.3.0
Highsoft.Web.Mvc.Charts.Boost Class Reference

Inherits BaseObject.

Properties

bool AllowForce [get, set]
 The chart will be boosted, if one of the series crosses its threshold and allthe series in the chart can be boosted. More...
 
BoostDebug Debug [get, set]
 Debugging options for boost.Useful for benchmarking, and general timing. More...
 
bool Enabled [get, set]
 Enable or disable boost on a chart. More...
 
double PixelRatio [get, set]
 The pixel ratio for the WebGL content. If 0, the window.devicePixelRatio isused. This ensures sharp graphics on high DPI displays like Apple's Retina,as well as when a page is zoomed.The default is left at 1 for now, as this is a new feature that has thepotential to break existing setups. Over time, when it has been battletested, the intention is to set it to 0 by default.Another use case for this option is to set it to 2 in order to make exportedand upscaled charts render sharp.One limitation when using the pixelRatio is that the line width of graphsis scaled down. Since the Boost module currently can only render 1px linewidths, it is scaled down to a thin 0.5 pixels on a Retina display. More...
 
double SeriesThreshold [get, set]
 Set the series threshold for when the boost should kick in globally.Setting to e.g. 20 will cause the whole chart to enter boost modeif there are 20 or more series active. When the chart is in boost mode,every series in it will be rendered to a common canvas. This offersa significant speed improvment in charts with a very highamount of series. More...
 
bool UseGPUTranslations [get, set]
 Enable or disable GPU translations. GPU translations are faster than doingthe translation in JavaScript.This option may cause rendering issues with certain datasets.Namely, if your dataset has large numbers with small increments (such astimestamps), it won't work correctly. This is due to floating pointprecission. More...
 
bool UsePreallocated [get, set]
 Enable or disable pre-allocation of vertex buffers.Enabling this will make it so that the binary data arrays required forstoring the series data will be allocated prior to transforming the datato a WebGL-compatible format.This saves a copy operation on the order of O(n) and so is significantly moreperformant. However, this is currently an experimental option, and may causevisual artifacts with some datasets.As such, care should be taken when using this setting to make sure thatit doesn't cause any rendering glitches with the given use-case. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ AllowForce

bool Highsoft.Web.Mvc.Charts.Boost.AllowForce
getset

The chart will be boosted, if one of the series crosses its threshold and allthe series in the chart can be boosted.

◆ Debug

BoostDebug Highsoft.Web.Mvc.Charts.Boost.Debug
getset

Debugging options for boost.Useful for benchmarking, and general timing.

◆ Enabled

bool Highsoft.Web.Mvc.Charts.Boost.Enabled
getset

Enable or disable boost on a chart.

◆ PixelRatio

double Highsoft.Web.Mvc.Charts.Boost.PixelRatio
getset

The pixel ratio for the WebGL content. If 0, the window.devicePixelRatio isused. This ensures sharp graphics on high DPI displays like Apple's Retina,as well as when a page is zoomed.The default is left at 1 for now, as this is a new feature that has thepotential to break existing setups. Over time, when it has been battletested, the intention is to set it to 0 by default.Another use case for this option is to set it to 2 in order to make exportedand upscaled charts render sharp.One limitation when using the pixelRatio is that the line width of graphsis scaled down. Since the Boost module currently can only render 1px linewidths, it is scaled down to a thin 0.5 pixels on a Retina display.

◆ SeriesThreshold

double Highsoft.Web.Mvc.Charts.Boost.SeriesThreshold
getset

Set the series threshold for when the boost should kick in globally.Setting to e.g. 20 will cause the whole chart to enter boost modeif there are 20 or more series active. When the chart is in boost mode,every series in it will be rendered to a common canvas. This offersa significant speed improvment in charts with a very highamount of series.

◆ UseGPUTranslations

bool Highsoft.Web.Mvc.Charts.Boost.UseGPUTranslations
getset

Enable or disable GPU translations. GPU translations are faster than doingthe translation in JavaScript.This option may cause rendering issues with certain datasets.Namely, if your dataset has large numbers with small increments (such astimestamps), it won't work correctly. This is due to floating pointprecission.

◆ UsePreallocated

bool Highsoft.Web.Mvc.Charts.Boost.UsePreallocated
getset

Enable or disable pre-allocation of vertex buffers.Enabling this will make it so that the binary data arrays required forstoring the series data will be allocated prior to transforming the datato a WebGL-compatible format.This saves a copy operation on the order of O(n) and so is significantly moreperformant. However, this is currently an experimental option, and may causevisual artifacts with some datasets.As such, care should be taken when using this setting to make sure thatit doesn't cause any rendering glitches with the given use-case.


The documentation for this class was generated from the following file: