v5.20192.631
|

ChartTooltip Class

Extends the Tooltip class to provide chart tooltips.

Hierarchy

Constructors

constructor

Properties

content

content: any

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();
  }

cssClass

cssClass: string

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

gap

gap: number

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

The default value for the property is 6 pixels.

hideDelay

hideDelay: number

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.

isContentHtml

isContentHtml: boolean

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.

isVisible

isVisible: boolean

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

showAtMouse

showAtMouse: boolean

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.

showDelay

showDelay: number

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.

threshold

threshold: number

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

Methods

dispose

  • dispose(): void
  • Removes all tooltips associated with this Tooltip instance.

    Returns void

getTooltip

  • getTooltip(element: any): string
  • Gets the tooltip content associated with a given element.

    Parameters

    • element: any

      Element, element ID, or control that the tooltip explains.

    Returns string

    Tooltip content associated with the given element.

hide

  • hide(): void
  • Hides the tooltip if it is currently visible.

    Returns void

onPopup

setTooltip

  • 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.

    Parameters

    • element: any

      Element, element ID, or control that the tooltip explains.

    • content: string

      Tooltip content or ID of the element that contains the tooltip content.

    Returns void

show

  • show(element: any, content: string, bounds?: Rect): void
  • Shows the tooltip with the specified content, next to the specified element.

    Parameters

    • element: any

      Element, element ID, or control that the tooltip explains.

    • content: string

      Tooltip content or ID of the element that contains the tooltip content.

    • Optional bounds: Rect

      Optional element that defines the bounds of the area that the tooltip targets. If not provided, the bounds of the element are used (as reported by the getBoundingClientRect method).

    Returns void

Events

popup

popup: Event

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.