showHTMLElement Method

Show an HTML element at a particular location.

showHTMLElement(_displayElement: HTMLElement, _location: XAndY, _offset: XAndY, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean

@returns true if the display element was displayed, false if the display element could not be displayed.

Parameter Type Description
_displayElement HTMLElement The HTMLElement to display
_location XAndY Location of the tool settings, relative to the origin of anchorElement or the window
_offset XAndY Offset of the display element from the location
_onCancel OnCancelFunc Function invoked when the Escape key is pressed or a click occurs outside the display element
_relativePosition RelativePosition Position relative to the given location. Defaults to TopRight.
_anchorElement HTMLElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.

Returns - boolean

true if the display element was displayed, false if the display element could not be displayed.

Defined in

Last Updated: 05 February, 2026