Harmony
Scripting Interface Documentation
CompositionItem Class Reference

The JavaScript class for getting the composition information of a node. Obtain one from the compositionOrder global object. More...

Properties

String node
 name of this node ( see node interface ) More...
 
bool isNodeRoot
 true when this node is a root (it has no parent). More...
 
bool isNodeNormal
 true when this node is a normal node and has a parent. More...
 
bool isNodeBroken
 true when this node has a parent but the parent is not present in the composition. Some modules, such as composite module, are never listed in the composition, however, they can be the parent of some other modules that will be listed in the composition. More...
 
bool isNodeSubnodeRoot
 parent less node that is within a child group. More...
 
unsigned numChildren READ
 number of children listed in the composition attached to node. More...
 
unsigned depth READ
 depth level of this node. Depths starts at zero for parent less node and increases for every level of parent this node has. More...
 

Detailed Description

The JavaScript class for getting the composition information of a node. Obtain one from the compositionOrder global object.

Represent a single entry in the composition order. The composition order is an array of composition items. The composition is an array of composition items. Each item contains all the information for rebuilding the composition.

Property Documentation

◆ isNodeBroken

bool CompositionItem::isNodeBroken
read

true when this node has a parent but the parent is not present in the composition. Some modules, such as composite module, are never listed in the composition, however, they can be the parent of some other modules that will be listed in the composition.

◆ isNodeNormal

bool CompositionItem::isNodeNormal
read

true when this node is a normal node and has a parent.

◆ isNodeRoot

bool CompositionItem::isNodeRoot
read

true when this node is a root (it has no parent).

◆ isNodeSubnodeRoot

bool CompositionItem::isNodeSubnodeRoot
read

parent less node that is within a child group.

◆ node

String CompositionItem::node
read

name of this node ( see node interface )

◆ READ [1/2]

unsigned numChildren CompositionItem::READ

number of children listed in the composition attached to node.

◆ READ [2/2]

unsigned depth CompositionItem::READ

depth level of this node. Depths starts at zero for parent less node and increases for every level of parent this node has.