addGroup()

Adds a group of shapes or a layout to a panel.

Synopsis

shape addGroup(shape panel, string groupType, string groupName);

shape addGroup(string moduleName, string panelName, string groupType, string groupName);

Parameter

Parameter Description
panel Panel as shape object to which the group should be added.
groupType Type of the group. Can be either "SHAPE_GROUP" or "LAYOUT_GROUP"
groupName Name of the group.
moduleName Name of the module in which the group should be added.
panelName Name of the panel in which the group should be added.

Return Value

The function returns a pointer to the newly created group or layout.

In case of an error a 0 shape is returned.

Errors

Missing arguments in the function, unknown module or panel, unknown groupType.

Description

Adds a new group of shapes or a layout into the given panel. The panel can either be addressed by a "shape" pointer, e.g.

shape panel = getShape("Module.Panel:");

or via moduleName/panelName as string.

  • The given groupName is currently not checked for duplicate name entries in the addressed panel.

  • Currently new shapes or groups can only be added into a LAYOUT_GROUP.

Assignment

Graphics function

Availability

UI, CTRL

See also

addShape(), removeGroup()