Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOverlay

An object which manages the overlay node for a dock panel.

Hierarchy

  • IOverlay

Implemented by

Index

Properties

Methods

Properties

node

node: HTMLDivElement

The DOM node for the overlay.

Methods

hide

  • hide(delay: number): void
  • Hide the overlay node.

    Parameters

    • delay: number

      The delay (in ms) before hiding the overlay. A delay value <= 0 should hide the overlay immediately.

      Notes

      This is called whenever the overlay node should been hidden.

    Returns void

show

  • Show the overlay using the given overlay geometry.

    Parameters

    • geo: IOverlayGeometry

      The desired geometry for the overlay.

      Notes

      The given geometry values assume the node will use absolute positioning.

      This is called on every mouse move event during a drag in order to update the position of the overlay. It should be efficient.

    Returns void

Generated using TypeDoc