setup

Last updated 2 months ago

Manager for the CommandPost Setup Screen.

Submodules

API Overview

API Documentation

Constants

Signature

plugins.core.setup.DEFAULT_HEIGHT -> number

Type

Constant

Description

The default panel height.

Signature

plugins.core.setup.DEFAULT_TITLE -> string

Type

Constant

Description

The default panel title.

Signature

plugins.core.setup.DEFAULT_WIDTH -> number

Type

Constant

Description

The default panel width.

enabled

Signature

plugins.core.setup.enabled <cp.prop: boolean>

Type

Constant

Description

Set to true if the manager is enabled. Defaults to false.

Signature

plugins.core.setup.FIRST_PRIORITY -> number

Type

Constant

Description

The first panel priority.

Signature

plugins.core.setup.LAST_PRIORITY -> number

Type

Constant

Description

The last panel priority.

visible

Signature

plugins.core.setup.visible <cp.prop: boolean; read-only>

Type

Constant

Description

A property indicating if the welcome window is visible on screen.

Variables

Signature

plugins.core.setup.onboardingRequired <cp.prop: boolean>

Type

Variable

Description

Set to true if on-boarding is required otherwise false. Defaults to true.

position

Signature

plugins.core.setup.position <cp.prop: table>

Type

Variable

Description

The last known position of the Setup Window as a frame.

Functions

addPanel

Signature

plugins.core.setup.addPanel(newPanel) -> panel

Type

Function

Description

Adds the new panel to the manager. Panels are created via the

Parameters

Returns

Signature

plugins.core.setup.currentPanel() -> string

Type

Function

Description

The Current Panel

Parameters

Returns

delete

Signature

plugins.core.setup.delete() -> none

Type

Function

Description

Deletes the Setup Panels.

Parameters

Returns

focus

Signature

plugins.core.setup.focus() -> none

Type

Function

Description

Focuses on the Setup Panels window.

Parameters

Returns

getLabel

Signature

plugins.core.setup.getLabel() -> string

Type

Function

Description

Returns the Webview label.

Parameters

Returns

init

Signature

plugins.core.setup.init(env) -> module

Type

Function

Description

Initialises the module.

Parameters

Returns

Signature

plugins.core.setup.injectScript(script) -> none

Type

Function

Description

Injects JavaScript into the Setup Panels.

Parameters

Returns

new

Signature

plugins.core.setup.new() -> none

Type

Function

Description

Creates the Setup Panels.

Parameters

Returns

nextPanel

Signature

plugins.core.setup.nextPanel() -> boolean

Type

Function

Description

Moves to the next panel. If the window is visible, the panel will be updated.

Parameters

Returns

Signature

plugins.core.setup.setPanelRenderer(renderer) -> none

Type

Function

Description

Sets a Panel Renderer

Parameters

Returns

show

Signature

plugins.core.setup.show() -> none

Type

Function

Description

Shows the Setup Panels.

Parameters

Returns

update

Signature

plugins.core.setup.update() -> none

Type

Function

Description

Updates the Setup Panels.

Parameters

Returns