Preparing search index...

    Configuration descriptor for a PanelPlugin, holding metadata such as id, name, description, and dependencies.

        // PanelPlugin Descriptor configures panel behavior:
    // id, name, description — plugin identity
    // defaultDockState — DockState.Attached or .Detached
    // defaultSize / minimumSize — initial and minimum panel Size
    // isUnique — only one instance allowed
    // menuActionHierarchy — menu path to open the panel
    // toolbarConfig — optional panel header toolbar
    const root = new Widget(parent);
    const layout = new BoxLayout();
    layout.setDirection(Direction.TopToBottom);
    layout.spacing = 4;
    root.layout = layout;

    const title = new Label(root);
    title.text = 'Descriptor Fields';
    title.fontRole = FontRole.TitleBold;
    layout.addWidget(title);

    const fields = [
    'id: com.docs.PanelPluginDescriptorExample',
    'name: Descriptor Demo',
    'defaultDockState: DockState.Detached',
    'defaultSize: Size(400, 250)',
    'minimumSize: Size(200, 150)',
    'isUnique: true',
    'menuActionHierarchy: [Window, Examples, Descriptor Demo]',
    ];
    for (const f of fields) {
    const l = new Label(root);
    l.text = f;
    l.fontRole = FontRole.Monospace;
    layout.addWidget(l);
    }

    Hierarchy (View Summary)

    Index

    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[]

    Array of interface IDs that this plugin requires to function.

    description: string

    Human-readable description of the plugin shown in the plugin manager.

    id: string

    Unique identifier for the plugin, typically in reverse domain notation.

    interfaces: InterfaceId[]

    Array of interface IDs that this plugin provides or implements.

    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