A specialized subclass of QueryToolTipEventArgs that carries the item for which the tool tip is queried.
Type Parameters
- TModelItem
- The type of the model
.
Type Details
- yFiles module
- view
Constructors
Initializes a new instance of the QueryItemToolTipEventArgs<TModelItem> class.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context to yield the tool tip for.
- queryLocation - Point
- The query location.
- item - TModelItem
- The item for which the tool tip is queried.
Properties
Gets the context for the current event.
Gets or sets a value indicating whether this QueryToolTipEventArgs has been handled.
Remarks
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.
Property Value
true if handled; false otherwise.Defined in
Gets the query location in world coordinates.
Gets or sets the tooltip content to use.
Remarks
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.
Property Value
null if no tooltip should be displayed.See Also
Defined in
Gets or sets a Promise<T> that provides the tooltip content to use.