getDecorationToolTip MethodOptional

If Decorator.testDecorationHit returned true, implement this method to return the tooltip message for this Decorator.

getDecorationToolTip(hit: HitDetail): Promise<HTMLElement | string>

Parameter Type Description
hit HitDetail The HitDetail about the decoration that was picked.

Returns - Promise<HTMLElement | string>

A promise with the HTMLElement or string (that may contain HTML) with the tooltip message.

Defined in

Last Updated: 13 June, 2024