Editor Scripting API
    Preparing search index...

    Class IDockManager

    Manages the states of Lens Studio panels.

    import CoreService from 'LensStudio:CoreService';
    import * as serialization from 'LensStudio:Serialization';

    export class DockManager extends CoreService {
        static descriptor() {
            return {
                id: 'Snap.Test.DockManager',
                name: 'DockManager',
                description: 'DockManager',
                interfaces: CoreService.descriptor().interfaces,
                dependencies: [Editor.Dock.IDockManager]
            };
        }

        constructor(pluginSystem) {
            super(pluginSystem);
            this.guards = [];
        }

        start() {
            const layoutStr = 'dock:\n' +
    d: false\n' +
                '  main:\n' +
                '    items:\n' +
                '      - items:\n';

            // Simply test that reader and writer can be created and used without throwing
            let reader = serialization.Yaml.createReader(layoutStr);
            const writer = serialization.Yaml.createWriter();

            const dockManager = this.pluginSystem.findInterface(Editor.Dock.IDockManager);
            dockManager.write(writer);
            const writtenContent = writer.getString();
            reader = serialization.Yaml.createReader(writtenContent);
        }

        stop() {
        }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    interfaceId panels

    Methods

    activate activatePanels add containsPanels findPanel getTypeName highlight highlightPanels isOfType isSame read remove removePanels write

    Constructors

    Properties

    interfaceId: InterfaceId

    Interface identifier for the dock manager.

    panels: IPanelPlugin[]

    Array of panels currently in the dock.

    Methods

    • Activate panels by group ID.

      Parameters

      • id: string

      Returns void

    • Check if panels with the given group ID exist in the dock.

      Parameters

      • id: string

      Returns boolean

    • Highlight panels by group ID.

      Parameters

      • id: string

      Returns void

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

      Parameters

      • type: string

      Returns boolean

    • Beta

      Reads the current state of the DockManager.

      Parameters

      Returns void

    • Remove panels by group ID from the dock.

      Parameters

      • id: string

      Returns void

    • Beta

      Writes to the Dock Manager.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods