ToolTip

Displays a string or any HTML element as tooltip.

Inheritance Hierarchy

ToolTip

Remarks

Usually, there is no need to instantiate this class directly. Tooltips can be conveniently set with the QueryItemToolTip event. See also Tooltips in the Developer's Guide.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.view.ToolTip

Constructors

ToolTip

()

Creates a new instance.

Remarks

This implementation calls createToolTip to create the HTML element to display as tooltip.

Usually, there is no need to instantiate this class directly. Tooltips can be conveniently set with the QueryItemToolTip event. See also Tooltips in the Developer's Guide.

Properties

content

: any

Gets or sets the content of this tooltip.

Remarks

The content can be either a string or any HTML element.

This setter invokes the method onContentChanged if the content is changed.

desiredSize

: Size

Gets the desired size of this tooltip.

Remarks

This property returns the offsetWidth and offsetHeight of the div

div

: HTMLDivElement

Gets the div element that represents this ToolTip.

horizontalOffset

: number

Gets the left position of the tool tip.

isOpen

: boolean

Specifies whether the tool tip is visible.

verticalOffset

: number

Gets the top position of the tool tip.

Methods

createToolTip

() : HTMLDivElement

Creates the HTML element in which the content is displayed.

Remarks

This implementation creates a simple HTML div element with the CSS class yfiles-tooltip.

Returns

↪HTMLDivElement: A HTML div element.

onContentChanged

(oldContent: Object, newContent: Object)

Sets the content to the HTML element that is displayed as tool tip.

Remarks

This implementation adds a string as innerHTML of the div. A HTMLElement is added as child to the div.

Subclasses which intend to use a more complex element as tool tip have to override this method to set the content properly.

Parameters

options - Object
A map of options to pass to the method.

oldContent - Object: The content to remove.
newContent - Object: The content to add.

updateLocation

()

Updates the current tooltip location in the page.

Remarks

Call this method to update the tooltip location when the content changes while it is open.

Calling this method re-evaluates desiredSize of this tooltip before calculating the new position.