Gets or sets the tooltip content.

The tooltip content can be specified as a string or as a function that takes a HitTestInfo object as a parameter.

When the tooltip content is a string, it may contain any of the following parameters:

• propertyName: Any property of the data object represented by the point.
• seriesName: Name of the series that contains the data point (FlexChart only).
• pointIndex: Index of the data point.
• value: Value of the data point (y-value for FlexChart, item value for FlexPie).
• x: x-value of the data point (FlexChart only).
• y: y-value of the data point (FlexChart only).
• name: Name of the data point (x-value for FlexChart or legend entry for FlexPie).

Parameters must be enclosed in single curly brackets. For example:

// 'country' and 'sales' are properties of the data object.
  chart.tooltip.content = '{country}, sales:{sales}';

The next example shows how to set the tooltip content using a function.

// Set the tooltip content
  chart.tooltip.content = function (ht) {
    return ht.name + ":" + ht.value.toFixed();
  }

Gets or sets a CSS class name to use when showing the tooltip.

Gets or sets the distance between the tooltip and the target element.

The default value for the property is 6 pixels.

Gets or sets the delay, in milliseconds, before hiding the tooltip if the mouse remains over the element.

The default value for the property is zero milliseconds, which causes the tip to remain visible until the mouse moves away from the element.

Gets or sets a value that determines whether the tooltip contents should be displayed as plain text or as HTML.

The default value for the property is true.

Gets a value that determines whether the tooltip is currently visible.

Gets or sets a value that determines whether the tooltip should be positioned with respect to the mouse position rather than the target element.

The default value for the property is false.

Gets or sets the delay, in milliseconds, before showing the tooltip after the mouse enters the target element.

The default value for the property is 500 milliseconds.

Gets or sets the maximum distance from the element to display the tooltip.

dispose(): void

Removes all tooltips associated with this Tooltip instance.

getTooltip(element: any): string

Gets the tooltip content associated with a given element.

hide(): void

Hides the tooltip if it is currently visible.

onPopup(e: TooltipEventArgs): boolean

Raises the popup event.

setTooltip(element: any, content: string): void

Assigns tooltip content to a given element on the page.

The same tooltip may be used to display information for any number of elements on the page. To remove the tooltip from an element, call setTooltip and specify null for the content.

To remove the tooltips for all elements, call the dispose method.

show(element: any, content: string, bounds?: Rect): void

Shows the tooltip with the specified content, next to the specified element.

Occurs before the tooltip content is displayed.

The event handler may customize the tooltip content or suppress the tooltip display by changing the event parameters.