Dockview
    Preparing search index...

    Interface ILayoutHistoryHost

    The narrow surface the layout-history service needs from the host (DockviewComponent). It reads/writes whole-layout snapshots and listens to the mutation-transaction boundary, the only place a pre-image can be taken before a mutation runs.

    interface ILayoutHistoryHost {
        onDidLayoutChange: DockviewEvent<void>;
        onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
        onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
        options: DockviewComponentOptions;
        popoutRestorationPromise: Promise<void>;
        fromJSON(
            data: SerializedDockview,
            options?: { reuseExistingPanels: boolean },
        ): void;
        toJSON(): SerializedDockview;
    }

    Implemented by

    Index

    Properties

    onDidLayoutChange onDidMutateLayout onWillMutateLayout options popoutRestorationPromise

    Methods

    fromJSON toJSON

    Properties

    onDidLayoutChange: DockviewEvent<void>

    Coalesced (microtask-buffered) ping after any layout change; the only signal for sash resize, which does not go through the mutation boundary.

    onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>

    Fires after a structural mutation; used to capture the post-image.

    onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>

    Fires before a structural mutation; used to capture the pre-image.

    options: DockviewComponentOptions
    popoutRestorationPromise: Promise<void>

    Settles once any in-flight popout-window restoration (from fromJSON) completes. Popouts re-open asynchronously, so undo/redo holds its guard until this resolves. Already-resolved when nothing is restoring.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods