#Tooltip

##Properties

Datatype Property name Property description Default Value
Animation Animation Enable or disable animation of the tooltip. In slow legacy IE browsers the animation is disabled by default. Default: true null
BackColorOrGradient BackgroundColor The background color or gradient for the tooltip. Default: rgba(255, 255, 255, 0.85) null
Nullable BorderColor The color of the tooltip border. When null, the border takes the color of the corresponding series or point. Default: auto null
Nullable BorderRadius The radius of the rounded border corners. Default: 3 null
Nullable BorderWidth The pixel width of the tooltip border. Default: 1 null
Crosshairs Crosshairs Display crosshairs to connect the points with their corresponding axis values. The crosshairs can be defined as a boolean, an array of booleans or an object. <dl><dt>Boolean</dt><dd>If the crosshairs option is true, a single crosshair relating to the x axis will be shown.</dd><dt>Array of booleans</dt><dd>In an array of booleans, the first value turns on the x axis crosshair and the second value to the y axis crosshair. Use [true, true] to show complete crosshairs.</dd><dt>Array of objects</dt><dd>In an array of objects, the first value applies to the x axis crosshair and the second value to the y axis crosshair. For each dimension, a width, color, dashStyle and zIndex can be given.</dd></dl> Defaults to null. null
DateTimeLabel DateTimeLabelFormats <p>For series on a 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 replacement codes, see dateFormat.</p><p>Defaults to:<pre>{ millisecond: '%H:%M:%S.%L', second: '%H:%M:%S', minute: '%H:%M', hour: '%H:%M', day: '%e. %b', week: '%e. %b', month: '%b '%y', year: '%Y'}</pre></p> null
Nullable Enabled Enable or disable the tooltip. Default: true null
Nullable FollowPointer <p>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 scatter, bubble and pie series by override in the plotOptions for those series types. </p><p>For touch moves to behave the same way, followTouchMove must be true also.</p> Default: false null
Nullable FollowTouchMove Whether the tooltip should follow the finger as it moves on a touch device. The default value of false causes a touch move to scroll the web page, as is default behaviour on touch devices. Setting it to true may cause the user to be trapped inside the chart and unable to scroll away, so it should be used with care. Default: false null
String FooterFormat A string to append to the tooltip format. Default: false null
String Formatter <p>Callback function to format the text of the tooltip. Return false to disable tooltip for a specific point on series.</p><p>A subset of HTML is supported. The HTML of the tooltip is parsed and converted to SVG, therefore this isn't a complete HTML renderer. The following tabs are supported: <b>, <strong>, <i>, <em>, <br/>, <span>. Spans can be styled with a style attribute, but only text-related CSS that is shared with SVG is handled. </p><p>Since version 2.1 the tooltip can be shared between multiple series through the shared option. The available data in the formatter differ a bit depending on whether the tooltip is shared or not. In a shared tooltip, all properties except x, which is common for all points, are kept in an array, this.points.</p><p>Available data are:</p><dl><dt>this.percentage (not shared) / this.points[i].percentage (shared)</dt><dd>Stacked series and pies only. The point's percentage of the total.</dd><dt>this.point (not shared) / this.points[i].point (shared)</dt><dd>The point object. The point name, if defined, is available through this.point.name.</dd><dt>this.points</dt><dd>In a shared tooltip, this is an array containing all other properties for each point.</dd><dt>this.series (not shared) / this.points[i].series (shared)</dt><dd>The series object. The series name is available through this.series.name.</dd><dt>this.total (not shared) / this.points[i].total (shared)</dt><dd>Stacked series only. The total value at this point's x value.</dd><dt>this.x</dt><dd>The x value. This property is the same regardless of the tooltip being shared or not.</dd><dt>this.y (not shared) / this.points[i].y (shared)</dt><dd>The y value.</dd></dl> null
String HeaderFormat <p>The HTML of the tooltip header line. Variables are enclosed by curly brackets. Available variablesare point.key, series.name, series.color and other members from the point and series objects. 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.</p><p>Defaults to <span style='font-size: 10px'>{point.key}</span><br/></p> null
Nullable HideDelay The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart. Default: 500 null
String PointFormat <p>The HTML of the point's line in the tooltip. Variables are enclosed by curly brackets. Available variables are point.x, point.y, series.name and series.color and other properties on the same form. Furthermore, point.y can be extended by the tooltip.yPrefix and tooltip.ySuffix variables. This can also be overridden for each series, which makes it a good hook for displaying units.</p><p>Defaults to <span style='color:{series.color}'>{series.name}</span>: <b>{point.y}</b><br/></p> null
String Positioner <p>A callback function to place the tooltip in a default position. The callback receives three parameters: labelWidth, labelHeight and point, where point contains values for plotX and plotY telling where the reference point is in the plot area. Add chart.plotLeft and chart.plotTop to get the full coordinates.</p><p>The return should be an object containing x and y values, for example { x: 100, y: 100 }.</p> null
Nullable Shadow Whether to apply a drop shadow to the tooltip. Default: true null
Nullable Shared When the tooltip is shared, the entire plot area will capture mouse movement. Tooltip texts for series types with ordered data (not pie, scatter, flags etc) will be shown in a single bubble. This is recommended for single series charts and for tablet/mobile optimized charts. Default: false null
Nullable Snap Proximity snap for graphs or single points. Does not apply to bars, columns and pie slices. It defaults to 10 for mouse-powered devices and 25 for touch devices. null
String Style CSS styles for the tooltip. The tooltip can also be styled through the CSS class .highcharts-tooltip. Default value:<pre>style: { color: '#333333', fontSize: '12px', padding: '8px'}</pre> null
Nullable UseHTML Use HTML to render the contents of the tooltip instead of SVG. Using HTML allows advanced formatting like tables and images in the tooltip. It is also recommended for rtl languages as it works around rtl bugs in early Firefox. Default: false null
Nullable ValueDecimals How many decimals to show in each series' y value. This is overridable in each series' tooltip options object. The default is to preserve all decimals. null
String ValuePrefix A string to prepend to each series' y value. Overridable in each series' tooltip options object. null
String ValueSuffix A string to append to each series' y value. Overridable in each series' tooltip options object. null
String XDateFormat 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. null

##Methods

###Equals(System.Object) Determines whether the specified System.Object is equal to the current System.Object.

Parameters:

Returns:

true if the specified System.Object is equal to the current System.Object; otherwise, false.

###GetHashCode() Serves as a hash function for a particular type.

Returns:

A hash code for the current System.Object.

###GetType() Gets the System.Type of the current instance.

Returns:

The System.Type instance that represents the exact runtime type of the current instance.

###ToString() Returns a System.String that represents the current System.Object.

Returns:

A System.String that represents the current System.Object.

Izenda Logo