section

Last updated 9 months ago

Controls sections for the CommandPost menu.

API Overview

API Documentation

Constants

Signature

plugins.core.menu.manager.section.DEFAULT_PRIORITY -> number

Type

Constant

Description

The default priority

Signature

plugins.core.menu.manager.section.WARNING_LIMIT -> number

Type

Constant

Description

The limit of how much time a menu item takes to load before we post warnings to the Error Log

Methods

Signature

plugins.core.menu.manager.section:_addGenerator() -> section

Type

Method

Description

A private method for registering a generator. This should not be called directly.

Parameters

Returns

addItem

Signature

plugins.core.menu.manager.section:addItem(priority, itemFn) -> section

Type

Method

Description

Registers a function which will generate a single table item.

Parameters

Returns

addItems

Signature

plugins.core.menu.manager.section:addItems(priority, itemsFn) -> section

Type

Method

Description

Registers a function which will generate multiple table items.

Parameters

Returns

addMenu

Signature

plugins.core.menu.manager.section:addMenu(priority, titleFn) -> section

Type

Method

Description

Adds a new sub-menu with the specified priority. The section that will contain

Parameters

Returns

Signature

plugins.core.menu.manager.section:addSection(priority, itemFn) -> section

Type

Method

Description

Adds a new sub-section with the specified priority. The new sub-section is returned.

Parameters

Returns

Signature

plugins.core.menu.manager.section:addSeparator(priority) -> section

Type

Method

Description

Adds a new seperator with specified priority.

Parameters

Returns

Signature

plugins.core.menu.manager.section:generateTable() -> table

Type

Method

Description

Generates a new menu table based on the registered items and sections inside this section.

Parameters

Returns

Signature

plugins.core.menu.manager.section:isDisabled() -> voolean

Type

Method

Description

Gets the disabled status

Parameters

Returns

new

Signature

plugins.core.menu.manager.section:new() -> section

Type

Method

Description

Creates a new menu section, which can have items and sub-menus added to it.

Parameters

Returns

Signature

plugins.core.menu.manager.section:setDisabledFn(disabledFn) -> none

Type

Method

Description

Sets the Disabled Function

Parameters

Returns