Editor Scripting API
    Preparing search index...

    Class IWorkspaceManager

    Interface for workspace management.

        // IWorkspaceManager manages workspace layouts and presets.
        // Access via gui.workspaces property.
        const gui = this.pluginSystem.findInterface(IGui.interfaceId) as IGui;
        const mgr: IWorkspaceManager = gui.workspaces;
        console.log('Workspace count:', mgr.all.length);

        this.connections.push(
          mgr.onActivated.connect((ws) => {
            console.log('Workspace activated:', ws.metadata.name);
          })
        );
        // Methods: create(descriptor), register(descriptor), unregister(handle)
        // Properties: all (readonly Workspaces.Workspace[])

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    all onAboutToBeActivated onAboutToBeAdded onAboutToBeDeactivated onAboutToBeRemoved onActivated onAdded onCreated onDeactivated onRemoved

    Methods

    create getTypeName isOfType isRegistered isSame readDescriptor register unregister

    Constructors

    Properties

    all: Workspace[]

    Array of all available workspaces.

    onAboutToBeActivated: signal1<Workspace, void>

    Emitted just before a workspace becomes the current active workspace during setCurrent(). Allows listeners to prepare for activation.

    onAboutToBeAdded: signal1<Workspace, void>

    Emitted just before a workspace is inserted into the manager's list. Fires during add() before the workspace is added to the internal collection.

    onAboutToBeDeactivated: signal1<Workspace, void>

    Emitted just before the current workspace is deactivated when switching to another workspace. Allows listeners to save state or cleanup.

    onAboutToBeRemoved: signal1<Workspace, void>

    Emitted just before a workspace is removed from the manager. Fires during remove() before the workspace is ejected from the list, allowing state saving.

    onActivated: signal1<Workspace, void>

    Emitted after a workspace has been successfully activated and is now current. Fires after the tab index is set and the workspace is ready for use.

    onAdded: signal1<Workspace, void>

    Emitted after a workspace has been successfully added to the manager and its tab created. Fires after the workspace is inserted into the internal list.

    onCreated: signal1<Workspace, void>

    Emitted after a workspace is fully initialized with its layout loaded and panel properties deserialized. Indicates the workspace is ready for interaction.

    onDeactivated: signal1<Workspace, void>

    Emitted after a workspace has been deactivated and is no longer current. Fires after another workspace is activated.

    onRemoved: signal1<Metadata, void>

    Emitted after a workspace is successfully removed from the manager. Passes the workspace's metadata (not the object itself, as it may be destroyed).

    Methods

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Unregister a workspace by its preset handle.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods