panel

Last updated 9 months ago

CommandPost Setup Window Panel.

API Overview

API Documentation

Constants

Signature

plugins.core.setup.panel.WEBVIEW_LABEL -> string

Type

Constant

Description

The ID for the Webview

Functions

Signature

plugins.core.setup.panelCount() -> number

Type

Function

Description

The number of panels currently being processed in this session.

Parameters

Returns

Signature

plugins.core.setup.panelNumber() -> number

Type

Function

Description

The number of the panel currently being viewed.

Parameters

Returns

Signature

plugins.core.setup.panelQueue() -> table of panels

Type

Function

Description

The table of panels remaining to be processed. Panels are removed from the queue

Parameters

Returns

Constructors

new

Signature

plugins.core.setup.panel.new(id, priority) -> plugins.core.setup.panel

Type

Constructor

Description

Constructs a new panel with the specified priority and ID.

Parameters

Methods

addButton

Signature

plugins.core.setup.panel:addButton(params) -> panel

Type

Method

Description

Adds a button to the panel.

Parameters

Returns

Notes

Signature

plugins.core.setup.panel:addCheckbox(params) -> panel

Type

Method

Description

Adds a checkbox to the panel with the specified priority and params.

Parameters

Returns

Notes

Signature

plugins.core.setup.panel:addContent(content[, escaped]) -> panel

Type

Method

Description

Adds the specified content to the panel.

Parameters

Returns

addFooter

Signature

plugins.core.setup.panel:addFooter(content, unescaped) -> panel

Type

Method

Description

Adds the specified content to the panel's footer.

Parameters

Returns

Signature

plugins.core.setup.panel:addHandler(event, id, handlerFn, keys) -> none

Type

Method

Description

Gets a handler from an Handler ID

Parameters

Returns

Signature

plugins.core.setup.panel:addHeading(text) -> panel

Type

Method

Description

Adds a heading to the panel

Parameters

Returns

addIcon

Signature

plugins.core.setup.panel:addIcon(src) -> panel

Type

Method

Description

Adds an icon to the panel.

Parameters

Returns

Signature

plugins.core.setup.panel:addParagraph(content[, escaped[, class]]) -> panel

Type

Method

Description

Adds a Paragraph to the panel

Parameters

Returns

Signature

plugins.core.setup.panel:addPassword(params) -> panel

Type

Method

Description

Adds a password text-box to the panel.

Parameters

Returns

addSelect

Signature

plugins.core.setup.panel:addSelect(params) -> panel

Type

Method

Description

Adds a select to the panel.

Parameters

Returns

Signature

plugins.core.setup.panel:addSubHeading(text) -> panel

Type

Method

Description

Adds a sub-heading to the panel

Parameters

Returns

Signature

plugins.core.setup.panel:addTextbox(params) -> panel

Type

Method

Description

Adds a text-box to the panel

Parameters

Returns

Signature

plugins.core.setup.panel:getHandler(id) -> handler

Type

Method

Description

Gets a handler from an Handler ID

Parameters

Returns