Class Overlay

A concrete implementation of IOverlay.

This is the default overlay implementation for a dock panel.

Implements

IOverlay

Index

Constructors

Properties

_hidden _timer node

Methods

Constructors

constructor

new Overlay(): Overlay
Construct a new overlay.

Returns Overlay
- Defined in widgets/src/dockpanel.ts:1283

Properties

`Private` _hidden

_hidden: boolean = true

`Private` _timer

_timer: number = -1

`Readonly` node

node: HTMLDivElement

The DOM node for the overlay.

Methods

hide

hide(delay): void
Hide the overlay node.
Parameters
- delay: number
  The delay (in ms) before hiding the overlay. A delay value <= 0 will hide the overlay immediately.
Returns void
Implementation of IOverlay.hide
- Defined in widgets/src/dockpanel.ts:1331

show

show(geo): void
Show the overlay using the given overlay geometry.
Parameters
- geo: IOverlayGeometry
  The desired geometry for the overlay.
Returns void
Implementation of IOverlay.show
- Defined in widgets/src/dockpanel.ts:1301