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

    Internal plumbing API for layout persistence infrastructure. General consumers should use PerspectiveService instead.

    interface PerspectiveServiceInternal {
        defaultPerspectiveId: string;
        clearSavedLayouts(): void;
        getActivePerspectiveId(): string;
        getSavedLayout(
            perspectiveId: string,
        ): undefined | ApplicationShell.LayoutData;
        getSavedPerspectiveIds(): string[];
        onLayoutRestored(activePerspectiveId: string): void;
        setActivePerspectiveId(id: string): boolean;
        setSavedLayout(
            perspectiveId: string,
            layout: ApplicationShell.LayoutData,
        ): void;
    }

    Implemented by

    Index

    Properties

    defaultPerspectiveId: string

    The ID of the built-in default perspective. Plumbing API, used by ShellLayoutRestorer for legacy migration.

    Methods

    • Internal

      Returns the IDs of all perspectives that have a saved (in-memory) layout snapshot. Plumbing API, used by ShellLayoutRestorer for layout persistence.

      Returns string[]

    • Internal

      Called by ShellLayoutRestorer after restoring a persisted layout to apply chrome options (e.g., status bar visibility) for the given perspective. Plumbing API, used by ShellLayoutRestorer after layout restore.

      Parameters

      • activePerspectiveId: string

      Returns void

    • Internal

      Sets the active perspective ID (without triggering a switch). Returns true if the ID corresponds to a registered perspective, false otherwise. Plumbing API, used by ShellLayoutRestorer during layout restore.

      Parameters

      • id: string

      Returns boolean