Skip to main content

IPanelPlugin

Class

Plugin 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

readonly id: string

Unique string identifier of the plugin instance.

Inherited from

IPlugin.id


title

readonly title: string

Read-only string displayed as the panel's title.


widget

readonly widget: Widget

Read-only UI widget rendered inside the panel.

Methods

getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

IPlugin.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

IPlugin.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

IPlugin.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

IPlugin.isSame