IPanelPlugin
ClassPlugin base class for plugins that contribute a titled UI panel widget to the editor.
Index
Example
// IPanelPlugin is the base interface for dockable editor panels.
// Extend PanelPlugin (which implements IPanelPlugin) and override createWidget().
const root = new Widget(parent);
const layout = new BoxLayout();
layout.setDirection(Direction.TopToBottom);
root.layout = layout;
const label = new Label(root);
label.text = 'This panel implements IPanelPlugin via PanelPlugin.';
label.wordWrap = true;
layout.addWidget(label);
Extends
Extended by
Properties
id
readonlyid:string
Unique string identifier of the plugin instance.
Inherited from
title
readonlytitle:string
Read-only string displayed as the panel's title.
widget
readonlywidget:Widget
Read-only UI widget rendered inside the panel.
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