Provides a pop-up window that displays additional information about elements on the page.
The Tooltip class can be used in two modes:
Automatic Mode: Use the setTooltip method to connect the Tooltip to one or more elements on the page. The Tooltip will automatically monitor events and display the tooltips when the user performs actions that trigger the tooltip. For example:
```typescript import { Tooltip } from '@grapecity/wijmo'; var tt = new Tooltip(); tt.setTooltip('#menu', 'Select commands.'); tt.setTooltip('#tree', 'Explore the hierarchy.'); tt.setTooltip('#chart', '#idChartTooltip'); ```
Manual Mode: The caller is responsible for showing and hiding the tooltip using the show and hide methods. For example:
```typescript import { Tooltip } from '@grapecity/wijmo'; var tt = new Tooltip(); element.addEventListener('click', function () { if (tt.isVisible) { tt.hide(); } else { tt.show(element, 'This is an important element!'); } }); ```
The example below shows how you can use the Tooltip class to add Excel-style notes to cells in a FlexGrid control:
{@sample Grid/CustomCells/CellNotes/purejs Example}
constructor(options?: any): Tooltip
Initializes a new instance of the Tooltip class.
JavaScript object containing initialization data for 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 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.
getTooltip(element: any): string
Gets the tooltip content associated with a given element.
Element, element ID, or control that the tooltip explains.
hide(): void
Hides the tooltip if it is currently visible.
onPopup(e: TooltipEventArgs): boolean
Raises the popup event.
TooltipEventArgs that contains the event data.
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.
Element, element ID, or control that the tooltip explains.
Tooltip content or ID of the element that contains the tooltip content.
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).
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.