LensStudio:PanelPlugin.Descriptor
ClassConfiguration descriptor for a PanelPlugin, holding metadata such as id, name, description, and dependencies.
Index
Properties
Methods
Example
// 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);
}
Extends
Constructors
Constructor
new Descriptor():
Descriptor
Constructs a new PanelPlugin descriptor used to plugin metadata such as id, name, description, and dependencies.
Returns
Descriptor
Overrides
PanelDescriptor.constructor
Properties
defaultDockState
defaultDockState:
DockState
Initial dock state of the panel when first opened.
Inherited from
PanelDescriptor.defaultDockState
defaultSize
defaultSize:
Size
Default size of the panel when first created.
Inherited from
dependencies
dependencies:
InterfaceId[]
Array of interface IDs that this plugin requires to function.
Inherited from
description
description:
string
Human-readable description of the plugin shown in the plugin manager.
Inherited from
id
id:
string
Unique identifier for the plugin, typically in reverse domain notation.
Inherited from
intendedPlatforms
intendedPlatforms:
TargetPlatform[]
Array of target platforms (Snapchat, Spectacles) where this plugin is intended to run.
Inherited from
PanelDescriptor.intendedPlatforms
interfaces
interfaces:
InterfaceId[]
Array of interface IDs that this plugin provides or implements.
Inherited from
isUnique
isUnique:
boolean
Whether only one instance of this panel can exist at a time.
Inherited from
menuActionHierarchy
menuActionHierarchy:
string[]
Menu path segments used to place this panel in the application menu.
Inherited from
PanelDescriptor.menuActionHierarchy
minimumSize
minimumSize:
Size
Minimum allowed size of the panel.
Inherited from
name
name:
string
Display name of the plugin.
Inherited from
toolbarConfig?
optionaltoolbarConfig?:ToolbarConfig
Optional toolbar configuration to display in the panel.
Inherited from
Methods
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean