Theia API Documentation v1.65.0
    Preparing search index...

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

    interface IOverlay {
        node: HTMLDivElement;
        hide(delay: number): void;
        show(geo: IOverlayGeometry): void;
    }

    Implemented by

    Index

    Properties

    Methods

    Properties

    node: HTMLDivElement

    The DOM node for the overlay.

    Methods

    • Hide the overlay node.

      Parameters

      • delay: number

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

        This is called whenever the overlay node should been hidden.

      Returns void

    • Show the overlay using the given overlay geometry.

      Parameters

      • geo: IOverlayGeometry

        The desired geometry for the overlay.

        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