Skip to main content
Version: 4.x

Type Alias: HtmlOverlayOptions

HtmlOverlayOptions: object

Options for an overlay added using HtmlOverlayTool.add.

Type declaration

positionUpdatedCallback?

optional positionUpdatedCallback: HtmlOverlayPositionUpdatedDelegate

Callback that is triggered whenever the position of the overlay is updated. Optional.

userData?

optional userData: any

Optional user specified data that is provided to the HtmlOverlayCreateClusterDelegate and HtmlOverlayPositionUpdatedDelegate.

Defined in

packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:42