GetEquipmentList

Get all equipment names for the current project.

Function

string[] GetEquipmentList(layerName: string)

Parameters

• layerName (string): this parameter is optional. If ’layerName’ is set to an empty (or undefined) string, all equipment names are returned. If ’layerName’ is set and is a valid layer name, all equipment in this layer will be returned.

Return Value

Returns an array of strings containing equipment names.

Examples

Prints all equipment in the project to the console.

let list = SYM3.GetEquipmentList();
for (let i = 0; i < list.length; ++i)
{
    console.log(" Equipment = " + list[i]);
}

Prints the name of all equipment on ‘Layer1’ to the console.

let list = SYM3.GetEquipmentList("Layer1");
for (let i = 0; i < list.length; ++i)
{
    console.log(" Equipment = " + list[i]);
}