group

Represents a Tangent Group. Groups can also be used to enable/disable multiple Parameters/Actions/Menus by enabling/disabling the containing group.

API Overview

  • Functions - API calls offered directly by the extension

  • Constructors - API calls which return an object, typically one that offers API methods

  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Functions

is

Signature

plugins.core.tangent.manager.group.is(otherThing) -> boolean

Type

Function

Description

Checks if the otherThing is a group.

Parameters

Returns

Constructors

new

Signature

plugins.core.tangent.manager.group.new(name, parent, controls)

Type

Constructor

Description

Creates a new Group instance.

Parameters

Methods

action

Signature

plugins.core.tangent.manager.group:action(id[, name]) -> action

Type

Method

Description

Adds an action to this group.

Returns

binding

Signature

plugins.core.tangent.manager.group:binding(id[, name]) -> binding

Type

Method

Description

Adds an binding to this group.

Returns

controls

Signature

plugins.core.tangent.manager.group:controls() -> controls

Type

Method

Description

Retrieves the controls for this group. May be nil if the group was created independently.

Parameters

Returns

group

Signature

plugins.core.tangent.manager.group:group(name) -> group

Type

Method

Description

Adds a subgroup to this group.

Returns

Signature

plugins.core.tangent.manager.group:menu(id[, name]) -> menu

Type

Method

Description

Adds an menu to this group.

Returns

parameter

Signature

plugins.core.tangent.manager.group:parameter(id[, name]) -> parameter

Type

Method

Description

Adds an parameter to this group.

Returns

parent

Signature

`plugins.core.tangent.manager.group:parent() -> group

controls` </span>

Type

Method

Description

Returns the parent of the group, which should be either a group, controls or nil.

Parameters

Returns

reset

Signature

plugins.core.tangent.manager.group:reset() -> self

Type

Method

Description

This will remove all parameters, actions, menus and bindings from

Parameters

Returns

xml

Signature

plugins.core.tangent.manager.group:xml() -> cp.web.xml

Type

Method

Description

Returns the xml configuration for the Group, sorted alphabetically.

Parameters

Returns