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

Inherits BaseObject.

Properties

string ClusterFormat [get, set]
 The HTML of the cluster point's in the tooltip. Works only withmarker-clusters module and analogously topointFormat.The cluster tooltip can be also formatted usingtooltip.formatter callback function and point.isCluster flag. More...
 
Hashtable DateTimeLabelFormats [get, set]
 For series on datetime axes, the date format in the tooltip'sheader will by default be guessed based on the closest data points.This member gives the default string representations used foreach unit. For an overview of the replacement codes, seedateFormat. More...
 
double Distance [get, set]
 Distance from point to tooltip in pixels. More...
 
bool FollowPointer [get, set]
 Whether the tooltip should follow the mouse as it moves acrosscolumns, pie slices and other point types with an extent.By default it behaves this way for pie, polygon, map, sankeyand wordcloud series by override in the plotOptionsfor those series types.Does not apply if split is true.For touch moves to behave the same way, followTouchMove must be true also. More...
 
bool FollowTouchMove [get, set]
 Whether the tooltip should update as the finger moves on a touchdevice. If this is true and chart.panning isset,followTouchMove will take over one-finger touches, so the userneeds to use two fingers for zooming and panning.Note the difference to followPointer thatonly defines the position of the tooltip. If followPointer isfalse in for example a column series, the tooltip will show above orbelow the column, but as followTouchMove is true, the tooltip willjump from column to column as the user swipes across the plot area. More...
 
string FooterFormat [get, set]
 A string to append to the tooltip format. More...
 
string Format [get, set]
 A format stringfor the whole tooltip. When format strings are a requirement, it isusually more convenient to use headerFormat, pointFormat andfooterFormat, but the format option allows combining them intoone setting.The context of the format string is the same as that of theformatter callback. More...
 
string HeaderFormat [get, set]
 The HTML of the tooltip header line. Variables are enclosed bycurly brackets. Available variables are point.key, series.name,series.color and other members from the point and seriesobjects. The point.key variable contains the category name, xvalue or datetime string depending on the type of axis. For datetimeaxes, the point.key date format can be set usingtooltip.xDateFormat. More...
 
string NullFormat [get, set]
 The HTML of the null point's line in the tooltip. Works analogouslyto pointFormat. More...
 
string NullFormatter [get, set]
 Callback function to format the text of the tooltip forvisible null points.Works analogously to formatter. More...
 
string PointFormat [get, set]
 The HTML of the point's line in the tooltip. Variables are enclosedby curly brackets. Available variables are point.x, point.y,series.name and series.color and other properties on the sameform. Furthermore, point.y can be extended by thetooltip.valuePrefix and tooltip.valueSuffix variables. This canalso be overridden for each series, which makes it a good hook fordisplaying units.In styled mode, the dot is colored by a class name ratherthan the point color. More...
 
string PointFormatter [get, set]
 A callback function for formatting the HTML output for a single pointin the tooltip. Like the pointFormat string, but with moreflexibility. More...
 
double ValueDecimals [get, set]
 How many decimals to show in each series' y value. This isoverridable in each series' tooltip options object. The default is topreserve all decimals. More...
 
string ValuePrefix [get, set]
 A string to prepend to each series' y value. Overridable in eachseries' tooltip options object. More...
 
string ValueSuffix [get, set]
 A string to append to each series' y value. Overridable in eachseries' tooltip options object. More...
 
string XDateFormat [get, set]
 The format for the date in the tooltip header if the X axis is adatetime axis. The default is a best guess based on the smallestdistance between points in the chart. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ ClusterFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.ClusterFormat
getset

The HTML of the cluster point's in the tooltip. Works only withmarker-clusters module and analogously topointFormat.The cluster tooltip can be also formatted usingtooltip.formatter callback function and point.isCluster flag.

◆ DateTimeLabelFormats

Hashtable Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.DateTimeLabelFormats
getset

For series on datetime axes, the date format in the tooltip'sheader will by default be guessed based on the closest data points.This member gives the default string representations used foreach unit. For an overview of the replacement codes, seedateFormat.

◆ Distance

double Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.Distance
getset

Distance from point to tooltip in pixels.

◆ FollowPointer

bool Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.FollowPointer
getset

Whether the tooltip should follow the mouse as it moves acrosscolumns, pie slices and other point types with an extent.By default it behaves this way for pie, polygon, map, sankeyand wordcloud series by override in the plotOptionsfor those series types.Does not apply if split is true.For touch moves to behave the same way, followTouchMove must be true also.

◆ FollowTouchMove

bool Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.FollowTouchMove
getset

Whether the tooltip should update as the finger moves on a touchdevice. If this is true and chart.panning isset,followTouchMove will take over one-finger touches, so the userneeds to use two fingers for zooming and panning.Note the difference to followPointer thatonly defines the position of the tooltip. If followPointer isfalse in for example a column series, the tooltip will show above orbelow the column, but as followTouchMove is true, the tooltip willjump from column to column as the user swipes across the plot area.

◆ FooterFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.FooterFormat
getset

A string to append to the tooltip format.

◆ Format

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.Format
getset

A format stringfor the whole tooltip. When format strings are a requirement, it isusually more convenient to use headerFormat, pointFormat andfooterFormat, but the format option allows combining them intoone setting.The context of the format string is the same as that of theformatter callback.

◆ HeaderFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.HeaderFormat
getset

The HTML of the tooltip header line. Variables are enclosed bycurly brackets. Available variables are point.key, series.name,series.color and other members from the point and seriesobjects. The point.key variable contains the category name, xvalue or datetime string depending on the type of axis. For datetimeaxes, the point.key date format can be set usingtooltip.xDateFormat.

◆ NullFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.NullFormat
getset

The HTML of the null point's line in the tooltip. Works analogouslyto pointFormat.

◆ NullFormatter

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.NullFormatter
getset

Callback function to format the text of the tooltip forvisible null points.Works analogously to formatter.

◆ PointFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.PointFormat
getset

The HTML of the point's line in the tooltip. Variables are enclosedby curly brackets. Available variables are point.x, point.y,series.name and series.color and other properties on the sameform. Furthermore, point.y can be extended by thetooltip.valuePrefix and tooltip.valueSuffix variables. This canalso be overridden for each series, which makes it a good hook fordisplaying units.In styled mode, the dot is colored by a class name ratherthan the point color.

◆ PointFormatter

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.PointFormatter
getset

A callback function for formatting the HTML output for a single pointin the tooltip. Like the pointFormat string, but with moreflexibility.

◆ ValueDecimals

double Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.ValueDecimals
getset

How many decimals to show in each series' y value. This isoverridable in each series' tooltip options object. The default is topreserve all decimals.

◆ ValuePrefix

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.ValuePrefix
getset

A string to prepend to each series' y value. Overridable in eachseries' tooltip options object.

◆ ValueSuffix

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.ValueSuffix
getset

A string to append to each series' y value. Overridable in eachseries' tooltip options object.

◆ XDateFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSeriesTooltip.XDateFormat
getset

The format for the date in the tooltip header if the X axis is adatetime axis. The default is a best guess based on the smallestdistance between points in the chart.


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