Group
Defined in: system/group.ts:31
Class for combining several Items into a group
Basic Usage
Section titled “Basic Usage”var XJS = require('xjs');var myScene;var Group = XJS.Group;xjs.Scene.getActiveScene().then(function(scene) { myScene = scene; return myScene.getItems();}).then(function(items) { var newGroup = new Group(items); newGroup.addToScene();})Implements
Section titled “Implements”Addable
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Group(
itemArray?):Group
Defined in: system/group.ts:34
Parameters
Section titled “Parameters”itemArray?
Section titled “itemArray?”string[] | Item[]
Returns
Section titled “Returns”Group
Methods
Section titled “Methods”addToScene()
Section titled “addToScene()”addToScene(
value?):Promise<any>
Defined in: system/group.ts:64
param: (value?: number | Scene)
return: Promise<any>Adds this group to the current scene by default. Accepts an optional parameter value, which, when supplied, points to the scene where item will be added instead. If ready config {listenToItemAdd: true} it returns item id, else returns boolean.
Note: There is yet no way to detect error responses for this action.
Parameters
Section titled “Parameters”value?
Section titled “value?”number | Scene
Returns
Section titled “Returns”Promise<any>
Implementation of
Section titled “Implementation of”Addable.addToScene
toStringArray()
Section titled “toStringArray()”toStringArray():
string[]
Defined in: system/group.ts:38
Returns
Section titled “Returns”string[]