Class Overlay

A concrete implementation of IOverlay.

This is the default overlay implementation for a dock panel.

Hierarchy

Overlay

Implements

IOverlay

Index

Constructors

constructor

Properties

Methods

hide
show

Constructors

constructor

new Overlay(): Overlay

- Defined in dockpanel.ts:1096
Construct a new overlay.

Returns Overlay

Properties

Private _hidden

_hidden: boolean = true

Private _timer

_timer: number = -1

node

node: HTMLDivElement

The DOM node for the overlay.

Methods

hide

hide(delay: number): void

Implementation of IOverlay.hide
- Defined in dockpanel.ts:1147
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

show

show(geo: IOverlayGeometry): void

Implementation of IOverlay.show
- Defined in dockpanel.ts:1117
Show the overlay using the given overlay geometry.

Parameters
- geo: IOverlayGeometry
  
  The desired geometry for the overlay.
Returns void

Generated using TypeDoc