C

QueryToolTipEventArgs

Event argument that can be used to query the text to display when the mouse hovers over the given point in world coordinate space.

Members

Show:

Constructors

Initializes a new instance of the QueryToolTipEventArgs class.

Parameters

context: IInputModeContext
The context of the query.
queryLocation: Point
The query location.

Properties

Gets the context for the current event.
readonlyfinal

Property Value

The context.
Gets or sets a value indicating whether this QueryToolTipEventArgs has been handled.

Handlers which handle this QueryToolTipEventArgs should always test first, whether this property is set to true and, if so, exit without doing anything.

This property is automatically set to true if the toolTip or toolTipAsync property has been assigned a value.

final

Property Value

true if handled; false otherwise.
Gets the query location in world coordinates.
readonlyfinal

Property Value

The query location.
Gets or sets the tooltip content to use.

If a non-null value is set, that value will be displayed as tooltip.

This property can be set to either a text string for simple text, or an HTMLElement for rich HTML structures. This allows embedding dynamically rendered components from third-party libraries.

Setting this property will set the handled property to true.

final

Property Value

The tooltip content or null if no tooltip should be displayed.

See Also

Developer's Guide
API
toolTipAsync
Gets or sets a Promise<T> that provides the tooltip content to use.

If a non-null value is set, its provided value will be displayed when the Promise<T> resolves.

Setting this property will set the handled property to true.

final

Property Value

A Promise providing the tooltip content or null if no tooltip should be displayed.

See Also

API
toolTip