Harmony
Scripting Interface Documentation
element Class Reference

The element JavaScript global object. Add, remove, modify or get information about element nodes in the scene. More...

Public Slots

Elements Data
int numberOf ()
 returns the number of elements in the scene More...
 
int id (int elementIndex)
 returns the id (key) of the element More...
 
String getNameById (int id)
 return the current element name. More...
 
String scanType (int id)
 returns a string that is the scan type of the element. The scan type is either: COLOR, GRAY_SCALE or BW More...
 
double fieldChart (int id)
 This function returns the field chart size for a given element. The element ID must be provided. The field chart is a number such as 12,16 or 24 field. More...
 
int vectorType (int id)
 This function returns the vector type for the given element. In theory, there is support for multiple types of vector drawing. In practice, only TVG has been implemented. The value 0 : indicates that the element is NOT a vector drawing. It is an IMAGE type. The value 2: indicates that the element is a TVG vector drawing. More...
 
String pixmapFormat (int id)
 returns the pixmap format for the provided element ID More...
 
String folder (int id)
 return the actual element folder. This is normally the element name (unless it has been renamed and the project is not saved) but may include the ".<element id>" in the name if multiple elements share the same name. More...
 
String completeFolder (int id)
 return the complete element folder. This is normally the element name (unless it has been renamed and the project is not saved) but may include the ".<element id>" in the name if multiple elements share the same name. More...
 
String physicalName (int id)
 return the actual name of the drawings. This is different that the element name if this one has been renamed and the changes have not yet been saved. More...
 
Element Edition
bool modify (int id, String scanType, double fieldChart, String pixmapFormat, int vectorType)
 changes the attributes of the folder of element elem More...
 
int add (String name, String scanType, double fieldChart, String fileFormat, String vectorize)
 create a new element. returns the element id of the newly added element if successful, otherwise it returns -1 More...
 
bool remove (int id, bool deleteDiskFile)
 remove given element. Also optionally delete the disk files. This function returns true when successful. More...
 
bool renameById (int id, String name)
 rename an existing element. The element ID must be provided More...
 

Detailed Description

The element JavaScript global object. Add, remove, modify or get information about element nodes in the scene.

With the Element methods, add, remove or retrieve information about the elements in your scene. Each element has an index (0..nbElements), an integer id (key of the element in the database), which is unique. They have a name (which is not guaranteed to be unique).

// Rename each element only once.
var o = Object.keys(elements);
for( var idx in o )
{
var elementKey = o[idx];
var elementName = element.getNameById(elementKey);
var newElementName = swapName(elementName);
element.renameById(elementKey, newElementName);
}
function addElement
{
var id = element.add("newDrawing", "BW", 12, "TVG", "SCAN");
}

Member Function Documentation

◆ add

int element::add ( String  name,
String  scanType,
double  fieldChart,
String  fileFormat,
String  vectorize 
)
slot

create a new element. returns the element id of the newly added element if successful, otherwise it returns -1

Parameters
namethe name of the element
scanType"Colour", "Gray_Scale", "BW" (for black and white) or "None"
fieldChart12, 16 or 24.
fileFormat"SCAN", "OPT", "PAL", "SGI", "TGA", "YUV", "OMF" or "PSD"
vectorize"TVG" or "None".

◆ completeFolder

String element::completeFolder ( int  id)
slot

return the complete element folder. This is normally the element name (unless it has been renamed and the project is not saved) but may include the ".<element id>" in the name if multiple elements share the same name.

Parameters
idthe unique id of the element

◆ fieldChart

double element::fieldChart ( int  id)
slot

This function returns the field chart size for a given element. The element ID must be provided. The field chart is a number such as 12,16 or 24 field.

Parameters
idthe unique id of the element

◆ folder

String element::folder ( int  id)
slot

return the actual element folder. This is normally the element name (unless it has been renamed and the project is not saved) but may include the ".<element id>" in the name if multiple elements share the same name.

Parameters
idthe unique id of the element

◆ getNameById

String element::getNameById ( int  id)
slot

return the current element name.

Parameters
idthe unique id of the element

◆ id

int element::id ( int  elementIndex)
slot

returns the id (key) of the element

Parameters
elementIndexAn integer from 0 to the value returned by the function element.numberOf, representing the index number of the element. The id and the index are not always the same value

◆ modify

bool element::modify ( int  id,
String  scanType,
double  fieldChart,
String  pixmapFormat,
int  vectorType 
)
slot

changes the attributes of the folder of element elem

Parameters
idthe unique id of the element
scanType"Colour", "Gray_Scale", "BW" (for black and white) or "None"
fieldChart12, 16 or 24.
pixmapFormat1 for OPT, 3 for SCAN, 4 for SGI, 5 for TGA, 7 for YUV, 9 for OMF or 10 for PSD, 11 for PNG, 12 for JPEG, 13 for BMP, 15 for TIFF
vectorType1 or 2

◆ numberOf

int element::numberOf ( )
slot

returns the number of elements in the scene

◆ physicalName

String element::physicalName ( int  id)
slot

return the actual name of the drawings. This is different that the element name if this one has been renamed and the changes have not yet been saved.

Parameters
idthe unique id of the element

◆ pixmapFormat

String element::pixmapFormat ( int  id)
slot

returns the pixmap format for the provided element ID

Parameters
idthe unique id of the element

◆ remove

bool element::remove ( int  id,
bool  deleteDiskFile 
)
slot

remove given element. Also optionally delete the disk files. This function returns true when successful.

Parameters
idthe unique id of the element
deleteDiskFileOptionally, delete the element from the disk.

◆ renameById

bool element::renameById ( int  id,
String  name 
)
slot

rename an existing element. The element ID must be provided

Parameters
idthe unique id of the element
nameThe new name of the element. This name must be unique. This operation will physically rename all the files associated to this element.

◆ scanType

String element::scanType ( int  id)
slot

returns a string that is the scan type of the element. The scan type is either: COLOR, GRAY_SCALE or BW

Parameters
idthe unique id of the element

◆ vectorType

int element::vectorType ( int  id)
slot

This function returns the vector type for the given element. In theory, there is support for multiple types of vector drawing. In practice, only TVG has been implemented. The value 0 : indicates that the element is NOT a vector drawing. It is an IMAGE type. The value 2: indicates that the element is a TVG vector drawing.

Parameters
idthe unique id of the element