Editor Scripting API
    Preparing search index...

    Class PanelDescriptor

    Descriptor object used to configure and register a panel plugin with Lens Studio.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    defaultDockState defaultSize dependencies description id interfaces isUnique menuActionHierarchy minimumSize name toolbarConfig?

    Methods

    getTypeName isOfType isSame

    Constructors

    Properties

    defaultDockState: DockState

    Initial dock state of the panel when first opened.

    defaultSize: Size

    Default size of the panel when first created.

    dependencies: InterfaceId[]
    description: string

    Human-readable description of the plugin.

    id: string

    Unique identifier string for the plugin.

    interfaces: InterfaceId[]

    List of interface IDs that this plugin implements or exposes.

    isUnique: boolean

    Whether only one instance of this panel can exist at a time.

    menuActionHierarchy: string[]

    Menu path segments used to place this panel in the application menu.

    minimumSize: Size

    Minimum allowed size of the panel.

    name: string

    Display name of the plugin.

    toolbarConfig?: ToolbarConfig

    Optional toolbar configuration to display in the panel.

    Methods

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

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods