Skip to content

getOverlays(filter?) ​

getOverlays get overlay information.

Reference ​

typescript
(
  filter?: {
    id?: string
    name?: string
    groupId?: string
    paneId?: string
  }
) => Overlay[]

Parameters ​

  • filter Filter conditions.
    • id Overlay id.
    • name Overlay name.
    • groupId Group id.
    • paneId Pane id.

Returns ​

getOverlays returns Overlay[] .

Usage ​

Basic usage ​