Group object

A group is a basic logical element that associates a set of logical tags.

Group object methods

Methods that can be used with group objects.

getTag

object getTag( TagName )

Gets the tag specified by TagName from the group object.

Parameter Description
TagName String representing the tag name
Return value

An object that is the value of the tag or, if tag value is an array, the complete array. If you need to retrieve an element of the array, check the method getTag available in the project object. Undefined is returned if tag is invalid.

var group = new Group();

project.getGroup("GroupName", group);

var value = group.getTag("Tag1");

(Available on web pages)

getCount

number getCount()

Returns total number of tags in this group.

var group = new Group();

project.getGroup("GroupName", group);

var value = group.getCount();

(Available on web pages)

getTags

object getTags()

Returns the list of all tags in group.

function {

var group = new Group();

project.getGroup("enginesettings", group);

var tagList = group.getTags();

for(var i = 0; i < tagList.length; i++){

var tagName = tagList[i];

//do something…

};

(Available on web pages)