plugins.core.setup.panel.md

docs » plugins.core.setup.panel

---

CommandPost Setup Window Panel.

API Overview

• Functions - API calls offered directly by the extension
• panelCount
• panelNumber
• panelQueue
• Constructors - API calls which return an object, typically one that offers API methods
• new
• Methods - API calls which can only be made on an object returned by a constructor
• addButton
• addCheckbox
• addContent

API Documentation

Functions

panelCount

Signature	plugins.core.setup.panelCount() -> number
Type	Function
Description	The number of panels currently being processed in this session.
Parameters	None
Returns	The number of panels.

panelNumber

Signature	plugins.core.setup.panelNumber() -> number
Type	Function
Description	The number of the panel currently being viewed.
Parameters	None
Returns	the current panel number, or 0 if no panels are registered.

panelQueue

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	None
Returns	The table of panels remaining to be processed.

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	priority - Defines the order in which the panel appears. id - The unique ID for the panel.

Methods

addButton

Signature	plugins.core.setup.panel:addButton(params) -> panel
Type	Method
Description	Adds a button with the specified priority and parameters.
Parameters	priority - Defines the order in which the panel appears. params - The list of parameters.
Returns	The same panel.
Notes	The params table may contain: ** id - (optional) the unique ID for the button. If none is provided, one is generated. ** value - The value of the button. This is sent to the onclick function. ** label - The text label for the button. Defaults to the value if not provided. ** width - The width of the button in pixels. ** onclick - the function to execute when the button is clicked. The function should have the signature of function(id, value), where id is the id of the button that was clicked, and value is the value of the button.

addCheckbox

Signature	plugins.core.setup.panel:addCheckbox(params) -> panel
Type	Method
Description	Adds a checkbox to the panel with the specified priority and params.
Parameters	priority - The priority number for the checkbox. params - The set of parameters for the checkbox.
Returns	The panel. Notes: * The params can contain the following fields: ** id - (optional) The unique ID. If none is provided, one will be generated. ** name - (optional) The name of the checkbox field. ** label - (optional) The text label to display after the checkbox. ** onchange - (optional) a function that will get called when the checkbox value changes. It will be passed two parameters, id and params, the latter of which is a table containing the value and checked values of the checkbox. ** class - (optional) the CSS class list to apply to the checkbox.
Notes	* The params can contain the following fields: ** id - (optional) The unique ID. If none is provided, one will be generated. ** name - (optional) The name of the checkbox field. ** label - (optional) The text label to display after the checkbox. ** onchange - (optional) a function that will get called when the checkbox value changes. It will be passed two parameters, id and params, the latter of which is a table containing the value and checked values of the checkbox. ** class - (optional) the CSS class list to apply to the checkbox.

addContent

Signature	plugins.core.setup.panel:addContent(content) -> panel
Type	Method
Description	Adds the specified content to the panel, with the specified priority order.
Parameters	* priority - the priority order of the content. * content - a value that can be converted to a string. * unescaped - if true, the content will not be escaped. Defaults to true.
Returns	* The panel.