Harmony 24 Scripting Interface

https://docs.toonboom.com/help/harmony-24/scripting/script
Admin
Harmony 24 Scripting Interface provides a Qt Script-based API for creating tools, macros, and...
Tokens:452,688
Snippets:4,944
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### TextEdit Usage Example

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classTextEdit.html

Example demonstrating how to create a TextEdit widget within a Dialog, set its initial text, and retrieve user input.

```javascript
var myDialog = new Dialog();
myDialog.title = "TextEdit Example";
var userInput = new TextEdit();
userInput.text = "Tell us how you feel about this tutorial."
myDialog.add( userInput );
if ( myDialog.exec() )
{
var inputText = userInput.text;
MessageLog.trace( inputText );
}
```

--------------------------------

### Example Usage

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classColorType.html

An example demonstrating how to create a new color using one of the ColorType constants.

```APIDOC
## Detailed Description
The JavaScript class for defining the different color types. Obtain it from Constants.
The constants can be used in Palette and Color methods.
myPalette.createNewColor(PaletteObjectManager.Constants.ColorType.SOLID_COLOR, "myPaletteName", { r : 255, g: 0, b: 0, a : 255 });
```

--------------------------------

### Get Source Node Information and Use with dstNode

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classnode.html

This example demonstrates how to use `node.srcNodeInfo` to get details about a connected source node and then use those details with `node.dstNode` to retrieve the destination node. It also shows how to get the parent node and compare it with the source node.

```javascript
var exNode = selection.selectedNode(0);
var numInput = node.numberOfInputPorts(exNode);
var source = node.srcNodeInfo(exNode, 0);
//Note: This source node is different than the parent node. The source node is the node connected to one of the input ports of the node. The parent is the parent group of the node.
var parent = node.parentNode(exNode);
MessageLog.trace(node.equals(parent, source.node)); //This will print false
//You can use the 3 properties of the source object to use dstNode()
var destination = node.dstNode(source.node, source.port, source.link);
MessageLog.trace(node.equals(destination, exNode)); //This will print true
```

--------------------------------

### SpinBox Example Usage

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classSpinBox.html

This example demonstrates how to create and use a SpinBox widget within a Dialog, set its properties, and retrieve the user's input.

```APIDOC
## Detailed Description

The **SpinBox** JavaScript class. A simplified version of the SpinBox Qt widget. 

```javascript
var myDialog = new Dialog();
myDialog.title = "SpinBox Example";
var userInput = new SpinBox();
userInput.label = "Pick a number: ";
userInput.maximum = 100;
userInput.minimum = 1;
myDialog.add( userInput );
if ( myDialog.exec() )
    MessageLog.trace("The chosen number is: " + userInput.value + ".");
```
```

--------------------------------

### Get Destination Node Path and Port Information

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classnode.html

This example demonstrates how to use dstNodeInfo to get the destination node's path and the specific port it's connected to. It also shows how to use the returned information with srcNode to verify the connection.

```javascript
var exNode = selection.selectedNode(0);
var destination = node.dstNodeInfo(exNode, 0, 0);
//You can use the 2 properties of the source object to use srcNode()
var source = node.srcNode(destination.node, destination.port);
MessageLog.trace(node.equals(source, exNode)); //This will print true
```

--------------------------------

### fromFrame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classExportVideoDlg.html

Gets the starting frame index for the export.

```APIDOC
## fromFrame

### Description
Gets the begin index frame used for export.

### Property Type
int

### Access
Read
```

--------------------------------

### startFrame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_func_s.html

Gets the start frame information for columns, selection, or write nodes.

```APIDOC
## startFrame()

### Description
Gets the start frame information for columns, selection, or write nodes.

### Method
N/A (Function call)

### Parameters
None

### Response
- **columnMarkers, selection, WriteNode** (object) - Information about the start frame.
```

--------------------------------

### CheckBox Usage Example

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classCheckBox.html

Example demonstrating how to create, configure, and use a CheckBox within a Dialog.

```APIDOC
## Detailed Description
The **CheckBox** JavaScript class. A simplified version of the CheckBox Qt widget.
var myDialog = new Dialog();
myDialog.title = "CheckBox Example";
var userInput = new CheckBox();
userInput.text = "Is this guide helpful?"
myDialog.add( userInput );
if ( myDialog.exec() )
{
if( userInput.checked );
MessageLog.trace( "The guide is helpful!" );
}

```

--------------------------------

### Example Usage

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classDrawingToolParams.html

Demonstrates how to instantiate and use the DrawingToolParams class.

```APIDOC
## Detailed Description
The **DrawingToolParams** JavaScript class. Set or unset the "apply on all drawings" setting of the DrawingTools methods.

```javascript
var params = new DrawingToolParams;
params.applyAllDrawings = true;
DrawingTools.extractCenterline(DrawingTools.lineArt, DrawingTools.colourArt, params);
```
```

--------------------------------

### getStartFrame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_g.html

Retrieves the start frame of the scene.

```APIDOC
## getStartFrame()

### Description
Gets the starting frame number for the current scene.

### Method
Not Applicable (Function Call)

### Parameters
None

### Response
#### Success Response
- **scene**: An object representing scene information, including the start frame.
```

--------------------------------

### Vectorize Drawings Example

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classDrawingTools.html

A detailed example demonstrating how to vectorize drawings for a selected node. It includes checks for node type, line art mode, and destination node existence, and iterates through frames.

```javascript
function vectorizeExample()
{
if (selection.numberOfNodesSelected() != 1)
{
MessageLog.trace("Please select one Element Node");
return;
}
var n = selection.selectedNode(0);
if (node.type(n) != "READ")
{
MessageLog.trace("The selected node is NOT an Element Node. " );
return;
}
var attrType = node.getTextAttr(n, 1, "lineArtDrawingMode");
if (attrType != "Bitmap")
{
MessageLog.trace("The selected node must be an Element Node with bitmap line art.");
return;
}
var destination = n + "_vect";
if (!node.getName(destination))
{
MessageLog.trace("Please make sure there is a node named " + node.getName(n) + "_vect in the same group as the selected node" );
}
var options = {
no_break : true,
thresh : 0.01,
rmv_hairs : 5
};
var optionsLine = "-no_break -thresh 0.01 -rmv_hairs 5";
scene.beginUndoRedoAccum("Vectorize drawings of " + node.getName(n) + " to " + node.getName(destination));
for(var i=1 ; i<frame.numberOf() ; ++i)
{
var keySrc = Drawing.Key({ node: n , frame : i});
var keyDst = Drawing.Key({ node: destination , frame : i});
if (keySrc.isNull || keyDst.isNull)
{
continue;
}
var r = DrawingTools.vectorize(keySrc, keyDst, options);
}
scene.endUndoRedoAccum();
}
```

--------------------------------

### Create and Configure a Button

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classButton.html

This example demonstrates how to create a button, set its label, and assign a callback function to be executed when the button is pressed. The callback function 'colourSetter' is expected to be defined elsewhere.

```javascript
var setter = new Button();
setter.label = "Set Colour";
setter.callback = "colourSetter";
```

--------------------------------

### Get Scene Start Frame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classscene.html

Retrieves the starting frame number of the scene.

```javascript
scene.getStartFrame()
```

--------------------------------

### help()

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classDrawingTools_1_1vectorize.html

Returns the complete help documentation for the vectorize function.

```APIDOC
## help()

### Description
Returns the complete vectorize help.

### Method
String

### Endpoint
DrawingTools::vectorize::help()
```

--------------------------------

### Get Selected Start Frame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classselection.html

Returns the starting frame number of the current selection. This is a direct getter for the selection's start frame.

```javascript
selection.startFrame()
```

--------------------------------

### Create Directories with Dir

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classDir.html

Use the Dir class to create directories. Set the path property and then call mkdirs() to create the directory and any necessary parent directories.

```javascript
var dir = new Dir;
dir.path = this._exportDir;
dir.mkdirs();
```

--------------------------------

### scene::currentResolutionY

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classscene.html

Gets the Y-component (height) of the current preview resolution. For example, in a 720x540 resolution, this would return 540.

```APIDOC
## scene::currentResolutionY

### Description
Returns the Y value of the current preview resolution.
For example, when the current resolution is 720x540 pixels this function will return 540.

### Returns
- Integer: The Y value of the current preview resolution.
```

--------------------------------

### launchAndDetach(String &name, String &program, StringList &args, QScriptValue &additionalEnvironmentMap=QScriptValue())

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classSCR__ProcessManagerWrapper-members.html

Launches a new process in a detached state, optionally with additional environment variables.

```APIDOC
## launchAndDetach(String &name, String &program, StringList &args, QScriptValue &additionalEnvironmentMap=QScriptValue())

### Description
Launches a program as a new process and detaches it from the current session. This allows the process to continue running even after the parent script has finished.

### Method
slot

### Parameters
#### Path Parameters
- **name** (String) - The name to assign to the launched process.
- **program** (String) - The path to the executable program to launch.
- **args** (StringList) - A list of command-line arguments to pass to the program.
- **additionalEnvironmentMap** (QScriptValue, Optional) - A map of additional environment variables to set for the new process. Defaults to an empty map if not provided.

### Response
#### Success Response (200)
- Indicates successful launch of the process.
```

--------------------------------

### scene::currentResolutionX

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classscene.html

Gets the X-component (width) of the current preview resolution. For example, in a 720x540 resolution, this would return 720.

```APIDOC
## scene::currentResolutionX

### Description
Returns the X value of the current preview resolution.
For example, when the current resolution is 720x540 pixels this function will return 720.

### Returns
- Integer: The X value of the current preview resolution.
```

--------------------------------

### setStartFrame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classMovieImport.html

Sets the starting frame for the import. Frames are 1-bound.

```APIDOC
## setStartFrame

### Description
Sets the starting frame for the import. Frames are 1-bound. This affects the `doImport()` command by limiting the frames considered.

### Method
void

### Parameters
#### Path Parameters
- **startFrame** (int) - Required - The starting frame number. Defaults to 1.
```

--------------------------------

### Create and Execute a Sample Dialog

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classDialog.html

Demonstrates how to create a new dialog, set its title, add a LineEdit widget, and execute the dialog modally. The input text is logged if the dialog is accepted.

```javascript
function sampleDialog()
{
var d = new Dialog();
d.title = "Sample Dialog";
var inputL = new LineEdit;
inputL.label = "Sample Line Edit";
d.add( inputL );
if ( d.exec() )
{
var sampleText = inputL.text;
MessageLog.trace("The input text is " + sampleText + ".");
}
}
```

--------------------------------

### Create and Launch Process from Arguments

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classProcess2.html

Instantiates a Process2 object using separate arguments for the command and its parameters, then launches it.

```javascript
p2 = new Process2( "rndr", "-t", "file.rib" ); // create process using separate arguments
p2.launch();
```

--------------------------------

### Get Drawing Key Properties from Element Node

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classDrawing.html

This example demonstrates how to retrieve drawing key properties from an element node, handling both synced layers and non-synced layers.

```javascript
var elementNode = "Top/MyDrawing";
// Get the name of the synced layer.
var layerAttr = node.getAttr(elementNode, frame.current(), "DRAWING.ELEMENT.LAYER");
var layerName = layerAttr.textValue();
var elementId = node.getElementId(elementNode);
var drawingColumn = node.linkedColumn(elementNode, "DRAWING.ELEMENT");
var exposure = column.getEntry(drawingColumn, 1, frame.current());
var drawingKey;
if(layerName.length)
{
drawingKey = Drawing.Key(elementId, exposure, layerName);
}
else
{
// The given node isn't a synced layer, do not specify the layer name.
drawingKey = Drawing.Key(elementId, exposure);
}
```

--------------------------------

### Get Node Height for Layout

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classnode.html

Returns the height of a given node, used for calculating node positions in the Node View. The example demonstrates stacking two nodes vertically.

```javascript
function nodeLine(node1, node2) //node1 and node2 are paths of 2 nodes
{
var x = node.coordX(node1);
var y = node.coordY(node1);
y -= node.height(node1);
node.setCoord(node2, x,y);
}
```

--------------------------------

### applicationPath

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classabout.html

Gets the path to the application's GUI folder.

```APIDOC
## ◆ applicationPath

### Description
Returns the path to the application's GUI folder. This may differ from binFolder on Mac.

### Method
about::applicationPath

### Returns
- String: The path to the application's GUI folder.
```

--------------------------------

### Export Movie with OpenH264 Codec

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classexporter.html

Renders the current scene and exports it as a .mov file using the OpenH264 codec. This example demonstrates setting the start and end frames, destination path, and resolution.

```javascript
var filename = scene.currentProjectPathRemapped() + "/frames/my-export.mov"; 
try
{
exporter.exportMovie({
codec : "openH264",
startFrame: 1,
lastFrame: frame.numberOf(),
dstPath: filename,
resX: 1920,
resY: 1080
})
}
catch (err)
{
MessageBox.critical(err.message);
}
```

--------------------------------

### init

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classExportVideoDlg.html

Initializes the dialog and its settings for export.

```APIDOC
## init

### Description
Initialize dialog and settings for export.
```

--------------------------------

### subSelectionIdFromAttribute

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classselection.html

Get the sub selection id corresponding to the given Attribute object. The attribute has to be selectable. For example, the subnode animation module's subnode transformation attributes. Note: The parent node of the attribute needs to be selected.

```APIDOC
## subSelectionIdFromAttribute

### Description
Get the sub selection id corresponding to the given Attribute object. The attribute has to be selectable. For example, the subnode animation module's subnode transformation attributes.

Note: The parent node of the attribute needs to be selected.

### Method Signature
`int selection::subSelectionIdFromAttribute(QScriptValue & _attribute_)`

### Parameters
#### Path Parameters
- **_attribute_** (QScriptValue &) - Required - An Attribute of a selected node.

### Returns
- **int** - Returns the sub selection id corresponding to the attribute.

### Example Usage
```javascript
var selectedNode = selection.selectedNode(0);
if(selectedNode == "" || node.type(selectedNode) != "SubNodeAnimation")
return;
var attributeType = "SUB_NODE_TRANSFORMATION";
var attributeName = "my_subnode_Key";
var linkable = false; // not used
node.createDynamicAttr(selectedNode, attributeType, attributeName, attributeName, linkable);
var nameAttribute = node.getAttr(selectedNode, frame.current, attributeName + ".NODE_NAME");
nameAttribute.setValue(attributeName);
var addedAttribute = node.getAttr(selectedNode, frame.current(), attributeName);
var attributeSelectionId = selection.subSelectionIdFromAttribute(addedAttribute);
selection.clearSubSelectionForNode(selectedNode);
var subSelectionIdArray = [];
subSelectionIdArray[0] = attributeSelectionId;
selection.addSubSelectionForNode(selectedNode, subSelectionIdArray);
MessageLog.trace("Added attribute " + addedAttribute.name() + " with sub selection id: " + attributeSelectionId);
```
```

--------------------------------

### Sample Dialog with All Formatting Options

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/Dialog.html

Demonstrates the combined use of various dialog formatting options including labels, spacing, group boxes, columns, and tabs.

```javascript
function dialogBoxFormatting()
{
var sampleDialog = new Dialog();
sampleDialog.title = "This Is a Sample Dialog";
var bodyText = new Label();
bodyText.text = "This is some text to display in the body of the dialog.";
sampleDialog.add( bodyText );
sampleDialog.addSpace( 15 );
var moreText = new Label();
moreText.text = "And here is some more!";
sampleDialog.add( moreText );
sampleDialog.addSpace( 15 );
var groupBox = new GroupBox();
groupBox.title = "Group One";
var groupText = new Label();
groupText.text = "This text is in a group box.";
groupBox.add( groupText );
groupBox.newColumn();
var columnText = new Label();
columnText.text = "This is a second column.";
groupBox.add( columnText );
sampleDialog.add( groupBox );
sampleDialog.addSpace( 15 );
sampleDialog.newTab("First tab");
var tabText = new Label();
tabText.text = "This is a tab.";
sampleDialog.add( tabText );
sampleDialog.newTab("Second tab");
var tab2Text = new Label();
tab2Text.text = "This is another tab.";
sampleDialog.add( tab2Text );
sampleDialog.okButtonText = "OK Button";
sampleDialog.cancelButtonText = "Cancel Button";
sampleDialog.exec();
}
```

--------------------------------

### Get Slider Value from Peg Attribute

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classSliderWidget.html

A helper function to calculate a slider's value based on a 'Peg' attribute's X position. This example demonstrates how to retrieve and process attribute data to drive slider behavior.

```javascript
// Helper function to get the slider value from a Peg value. Completely arbitrary.
function getSliderValueFromPeg()
{
// slider max slider value * (peg position x + 1 (field)) * 2 (fields)
return 100 * ( (node.getAttr("Top/MyPeg_A", frame.current(), "POSITION.X").doubleValue() + 1) / 2 + min slider value (0));
}
```

--------------------------------

### Process2 Constructors

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classProcess2.html

Demonstrates how to create new Process2 objects using different constructor signatures.

```APIDOC
## Process2 Constructors

### Description
Creates a new Process2 object. Processes can be instantiated from a command line string, separate arguments, or an existing process ID.

### Methods
- `Process2(int pid)`: Creates a new Process2 object for an existing process identified by its PID. Functions like `terminate()` and `isAlive()` can be called on such objects.
- `Process2(String name, ...)`: Creates a new Process2 object with the specified command and arguments.
- `Process2(String name, StringList list)`: Creates a new Process2 object with the specified command and a list of arguments.
- `Process2(String commandLine)`: Creates a new Process2 object from a single command line string.

### Examples
```javascript
// Create process from single string
let p1 = new Process2( "rndr -t file.rib" );

// Create process using separate arguments
let p2 = new Process2( "rndr", "-t", "file.rib" );

// Create a process from a specified PID
let p4 = new Process2( 1234 );
```
```

--------------------------------

### Get Sub Selection ID from Attribute

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classselection.html

Retrieves the sub selection ID for a given attribute of a selected node. The attribute must be selectable, and its parent node must be selected. This example demonstrates creating a dynamic attribute and then obtaining its sub selection ID.

```javascript
var selectedNode = selection.selectedNode(0);
if(selectedNode == "" || node.type(selectedNode) != "SubNodeAnimation")
return;
var attributeType = "SUB_NODE_TRANSFORMATION";
var attributeName = "my_subnode_Key";
var linkable = false; // not used
node.createDynamicAttr(selectedNode, attributeType, attributeName, attributeName, linkable);
var nameAttribute = node.getAttr(selectedNode, frame.current, attributeName + ".NODE_NAME");
nameAttribute.setValue(attributeName);
var addedAttribute = node.getAttr(selectedNode, frame.current(), attributeName);
var attributeSelectionId = selection.subSelectionIdFromAttribute(addedAttribute);
selection.clearSubSelectionForNode(selectedNode);
var subSelectionIdArray = [];
subSelectionIdArray[0] = attributeSelectionId;
selection.addSubSelectionForNode(selectedNode, subSelectionIdArray);
MessageLog.trace("Added attribute " + addedAttribute.name() + " with sub selection id: " + attributeSelectionId);
```

--------------------------------

### Exec

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classExportVideoDlg.html

Opens the dialog widget, allowing the user to configure and initiate video export. Returns 1 on success.

```APIDOC
## Exec

### Description
Open the dialog widget.

### Method
int

### Returns
Returns '1' if successful to match the QDialog::Accepted value.
```

--------------------------------

### Instantiate and Configure TranslationXWidget

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classTranslationXWidget.html

Demonstrates how to create a new TranslationXWidget instance, set its properties, and register it with the Controller. This is typically done during the control display initialization.

```javascript
Controller.onShowControl = function()
{
// Set the widget properties at its creation.
var translationWidget = new TranslationXWidget(
{
data : "TranslationX",
min : 0.5,
width : 1,
color : ColorRGBA(155,0,0),
selection_color : ColorRGBA(255,0,0)
} );
// Set the widget initial value.
translationWidget.data().setValue(3);
// Register a callback for when a transformation tool value changes.
translationWidget.valueChanged.connect(translationXChanged);
// Register a callback for when the widget is beginning to be dragged
translationWidget.dragStarted.connect(translationDragStart);
// Register the widget in the Controller
Controller.controls = [];
Controller.controls.push(translationWidget);
}
```

--------------------------------

### Palette Override Example

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classPaletteManager.html

Demonstrates how to use PaletteManager to get and set palette override attributes for a selected node. This includes clearing the list, adding palettes by path, and retrieving palette names and counts. Use this when you need to programmatically manage palette overrides.

```javascript
function paletteOverrideExample()
{
if (selection.numberOfNodesSelected() != 1)
return;
// not strictly necessary, depends on whether each setTextAttr() call should be undoable individually
scene.beginUndoRedoAccum("Palette Overrides");
var node = selection.selectedNode(0);
// return the number of palettes in the palette override list
var num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
// return the first (top-most) palette name in the palette override list (will be "" if the list is empty).
// note that no palette number is supplied in this example, so 0 is assumed (equivalent to "PALETTES.0")
var palette = node.getTextAttr(node, 1, "PALETTES");
// clear (empty) the list
node.setTextAttr(node, "PALETTES.CLEAR", 1, "");
// should be 0
num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
// add a palette to the palette override list
var curpath = PaletteManager.getCurrentPalettePath();
node.setTextAttr(node, "PALETTES.ADD", 1, curpath);
// can also specify a full path for the palette
// node.setTextAttr(node, "PALETTES.ADD", 1, "/usadata000/.../example.plt");
// return the first two palette names (we added one, so one should be non-empty)
palette = node.getTextAttr(node, 1, "PALETTES.0");
// this one should be "", only one in the list
var palette1 = node.getTextAttr(node, 1, "PALETTES.1");
// return the name of the last palette that we added
num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
var index = parseInt(num);
index--;
var attr = "PALETTES." + index;
palette = node.getTextAttr(node, 1, attr);
// remove one from the list
node.setTextAttr(node, "PALETTES.REMOVE", 1, palette);
num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
scene.endUndoRedoAccum();
}
```

--------------------------------

### Print Timeline Layer Information

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classTimeline.html

Iterates through all layers to print information about node and column layers. Also logs the number and starting frame of selected frames, and details about selected node and column layers. Use this to get a comprehensive overview of layer and selection status.

```javascript
function printTimelineLayerInformation()
{
//
// Print out information for all layers
//
var numLayers = Timeline.numLayers;
for ( var i = 0; i < numLayers;i++ )
{
if ( Timeline.layerIsNode( i ) )
MessageLog.trace(i + ": is a node named " + Timeline.layerToNode(i));
if ( Timeline.layerIsColumn(i ) )
MessageLog.trace( " " + i + ": also has an xsheet column named " + Timeline.layerToColumn(i) );
}
MessageLog.trace("number of frames selected is " + Timeline.numFrameSel + " starting at " + Timeline.firstFrameSel);
//
// Print out information on selected layers
//
var numSelLayers = Timeline.numLayerSel;
for ( var i = 0; i < numSelLayers; i++ )
{
if ( Timeline.selIsNode( i ) )
MessageLog.trace(" " + i + ": is a SELECTED node layer with name " + Timeline.selToNode(i));
if ( Timeline.selIsColumn(i ) )
MessageLog.trace( i + ": SELECTED layer name is " + Timeline.selToColumn(i) );
}
}
```

--------------------------------

### Create and Configure Line2dDisplayWidget

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classLine2dDisplayWidget.html

Instantiate and configure a Line2dDisplayWidget with two Point2dWidget instances. This example demonstrates setting the data, size, and color properties of the line widget.

```javascript
Controller.onShowControl = function()
{
Controller.controls = [];
var myPointWidgetA = new Point2dWidget();
var myPointWidgetB = new Point2dWidget();
var myLine2dDisplayWidget = new Line2dDisplayWidget( 
{
data : [myPointWidgetA.data(), myPointWidgetB.data()],
size : 0.05,
color : ColorRGBA(20, 20, 20)
} );
myLine2dDisplayWidget.data(0).setValue(new Point2d(2,2));
myLine2dDisplayWidget.data(1).setValue(new Point2d(-2,-2));
Controller.controls.push(myPointWidgetA);
Controller.controls.push(myPointWidgetB);
Controller.controls.push(myLine2dDisplayWidget);

```

--------------------------------

### Create and Launch Process from String

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classProcess2.html

Instantiates a Process2 object from a single command line string and launches it.

```javascript
p1 = new Process2( "rndr -t file.rib" ); // create process from single string
p1.launch();
```

--------------------------------

### startExport

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classExportVideoDlg.html

Initiates the video export process, opening a dialog for progress tracking.

```APIDOC
## startExport

### Description
Opens a dialog for the export frame progress.

### Method
void ExportVideoDlg::startExport()
```

--------------------------------

### Class Members starting with 'd'

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_d.html

This section details class members that start with the letter 'd', providing their names and the classes they belong to.

```APIDOC
## Class Members starting with 'd'

### Description
This section details class members that start with the letter 'd', providing their names and the classes they belong to.

### Members
- **data** : Controller , WidgetBase
- **database** : specialFolders
- **databaseMode** : about
- **date** : DateEdit
- **debug()** : MessageLog
- **decimals** : NumberEdit
- **defaultCameraName** : CopyOptions , PasteOptions
- **defaultResolutionFOV()** : scene
- **defaultResolutionName()** : scene
- **defaultResolutionX()** : scene
- **defaultResolutionY()** : scene
- **deformerReset()** : SceneChangeNotifier
- **deformerResetCurrentFrame()** : SceneChangeNotifier
- **degreeAngle()** : Vector2d
- **deleteDrawingAt()** : column
- **deleteFrameMarker()** : Timeline
- **deleteMarker()** : TimelineMarker
- **deleteMode** : PasteOptions
- **deleteNode()** : node
- **deleteWaypoint()** : waypoint
- **demoVersion** : about
- **description()** : scene
- **Dir()** : Dir
- **Dirs** : DirSpec
- **DirsFirst** : DirSpec
- **disableAVButtons()** : ExportVideoDlg
- **disableResolution()** : ExportVideoDlg
- **disconnect()** : RemoteCmd , render
- **disconnectAll()** : SceneChangeNotifier , SessionChangeNotifier
- **display** : ExportVideoDlg
- **distance()** : Point2d , Point3d
- **distanceSq()** : Point2d , Point3d
- **DMY** : DateEditEnum
- **doImport()** : MovieImport
- **dot()** : Vector2d , Vector3d
- **doubleValue()** : Attribute
- **doubleValueAt()** : Attribute
- **dpiScale()** : Uiloader
- **drag()** : WidgetBase
- **dragEnded()** : WidgetBase
- **dragObject()** : DragObject
- **DragObject()** : DragObject
- **dragPoint()** : DragContext
- **dragStarted()** : WidgetBase
- **drawingFileMode** : PasteOptions
- **drawingPasteAction** : PasteOptions
- **drawingSubstitution** : PasteOptions
- **Drives** : DirSpec
- **dstNode()** : node
- **dstNodeInfo()** : node
- **duplicateColor()** : Palette
- **duplicateDrawingAt()** : column
```

--------------------------------

### Initialize and Set Controller Controls

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classController.html

Demonstrates how to initialize the controls array for a Controller and set values for individual widgets.

```javascript
Controller.controls = [];
Controller.controls.push(new SliderWidget());
Controller.controls.push(new SliderWidget());
// Use the standard default value.
Controller.controls[0].data().setValue(25);
Controller.controls[1].data().setValue(60);
```

--------------------------------

### File::created

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classFile.html

Gets the creation date and time of the file.

```APIDOC
## File::created

### Description
Date when the file was created.

### Method
QDateTime

### Parameters
None
```

--------------------------------

### Create and Configure a ComboBox

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classComboBox.html

This snippet demonstrates how to create a ComboBox, set its label, make it editable, populate its item list, and add it to a dialog. It then displays the dialog and logs the user's selection.

```javascript
var myDialog = new Dialog();
myDialog.title = "ComboBox Example";
var userInput = new ComboBox();
userInput.label = "What is your favourite colour?"
userInput.editable = true;
userInput.itemList = ["Red", "Green", "Blue", "Yellow", "White", "Pink", "Orange", "Purple", "Black"];
myDialog.add( userInput );
if ( myDialog.exec() )
MessageLog.trace("The user’s favourite colour is " + userInput.currentItem + ".");
```

--------------------------------

### RadioButton Example

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classRadioButton.html

Demonstrates how to create a dialog with two RadioButton options and log the user's selection. The dialog must be executed using exec() before checking the 'checked' property.

```javascript
var myDialog = new Dialog();
myDialog.title = "RadioButton Example";
var optionOne = new RadioButton();
optionOne.text = "Pick me!";
var optionTwo = new RadioButton();
optionTwo.text = "No, pick me!";
myDialog.add( optionOne );
myDialog.newColumn();
myDialog.add( optionTwo );
if ( myDialog.exec() )
{
if( optionOne.checked )
MessageLog.trace( "You picked the first option." );
else if ( optionTwo.checked )
MessageLog.trace( "You picked the second option." );
else
MessageLog.trace( "Neither option was selected." );
}
```

--------------------------------

### Functions starting with 'e'

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_func_e.html

This section details functions that start with the letter 'e', categorized by their respective classes. Each function includes its return type and a brief description.

```APIDOC
## Functions starting with 'e'

### Description
This section lists functions available in the Harmony 24 Scripting Interface that begin with the letter 'e'.

### Functions

*   **enabled()** : SubnodeData
    *   Description: Checks if a subnode is enabled.
*   **enableProgress()** : ExportVideoDlg
    *   Description: Enables progress reporting for video export.
*   **endExport()** : ExportVideoDlg
    *   Description: Finalizes the video export process.
*   **endUndoRedoAccum()** : scene
    *   Description: Ends the accumulation of undo/redo operations for the scene.
*   **entryList()** : Dir
    *   Description: Retrieves a list of entries within a directory.
*   **equals()** : node
    *   Description: Compares two nodes for equality.
*   **error()** : MessageLog
    *   Description: Retrieves an error message from the message log.
*   **errorCode()** : Process2
    *   Description: Gets the error code from a process.
*   **errorMessage()** : Process2
    *   Description: Gets the error message from a process.
*   **exec()** : Dialog
    *   Description: Executes a dialog.
*   **Exec()** : ExportVideoDlg
    *   Description: Executes the video export dialog.
*   **exec()** : Uiloader
    *   Description: Executes the UI loader.
*   **execDialog()** : LayoutExport
    *   Description: Executes the layout export dialog.
*   **exists()** : FileWrapper
    *   Description: Checks if a file exists.
*   **explodeElementSymbolsInGroups()** : node
    *   Description: Explodes element symbols within groups.
*   **explodeGroup()** : node
    *   Description: Explodes a group.
*   **exportAllCameraFrame()** : LayoutExportParams
    *   Description: Exports all camera frames according to layout export parameters.
*   **exportCameraFrame()** : LayoutExportParams
    *   Description: Exports a camera frame according to layout export parameters.
*   **exportCameraFrameLabel()** : LayoutExportParams
    *   Description: Exports a camera frame label according to layout export parameters.
*   **exportCanceled()** : ExportVideoDlg
    *   Description: Indicates if the video export was canceled.
*   **exportedFrames()** : LayoutExportParams
    *   Description: Retrieves the number of exported frames.
*   **exportGIF()** : exporter
    *   Description: Exports content as a GIF.
*   **exportMovie()** : exporter
    *   Description: Exports content as a movie.
*   **exportMovieFromFiles()** : WebCCExporter
    *   Description: Exports a movie from a list of files using WebCCExporter.
*   **exportMovieFromWriteModule()** : WebCCExporter
    *   Description: Exports a movie from a write module using WebCCExporter.
*   **exportMovieFromWriteModules()** : WebCCExporter
    *   Description: Exports a movie from multiple write modules using WebCCExporter.
*   **exportMultipleFiles()** : LayoutExportParams
    *   Description: Exports multiple files according to layout export parameters.
*   **exportOGLToQuicktime()** : exporter
    *   Description: Exports OpenGL content to Quicktime.
*   **exportPenstyleListToString()** : PenstyleManager
    *   Description: Exports a list of penstyles to a string.
*   **exportPenstyleToString()** : PenstyleManager
    *   Description: Exports a penstyle to a string.
*   **exportSound()** : WriteNode
    *   Description: Exports sound data.
*   **exportToProRes()** : exporter
    *   Description: Exports content in ProRes format.
*   **exportToQuicktime()** : exporter
    *   Description: Exports content to Quicktime.
*   **extendSelectionWithColumn()** : selection
    *   Description: Extends the current selection with a column.
*   **extension()** : FileWrapper
    *   Description: Retrieves the file extension.
*   **extractCenterline()** : DrawingTools
    *   Description: Extracts the centerline from drawing tools.
*   **extractPosition()** : Matrix4x4
    *   Description: Extracts the position from a 4x4 matrix.
*   **extractRotation()** : Matrix4x4
    *   Description: Extracts the rotation from a 4x4 matrix.
*   **extractScale()** : Matrix4x4
    *   Description: Extracts the scale from a 4x4 matrix.
*   **extractSkew()** : Matrix4x4
    *   Description: Extracts the skew from a 4x4 matrix.

```

--------------------------------

### startExport

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_func_s.html

Initiates the video export process.

```APIDOC
## startExport()

### Description
Initiates the video export process.

### Method
N/A (Function call)

### Parameters
None

### Response
- **ExportVideoDlg** (ExportVideoDlg) - The video export dialog object.
```

--------------------------------

### CheckBox Example with Dialog

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classCheckBox.html

Demonstrates creating a dialog with a CheckBox, capturing user input, and logging a message based on the CheckBox state. Requires the Dialog and MessageLog modules.

```javascript
var myDialog = new Dialog();
myDialog.title = "CheckBox Example";
var userInput = new CheckBox();
userInput.text = "Is this guide helpful?"
myDialog.add( userInput );
if ( myDialog.exec() )
{
if( userInput.checked );
MessageLog.trace( "The guide is helpful!" );
}
```

--------------------------------

### Scene Start Frame

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classscene.html

This function sets the scene start frame. The value is validated to be below the number of frames, the stop frame is adjusted too if the specified value is bigger.

```APIDOC
## setStartFrame

### Description
Sets the scene start frame.

### Method
N/A (Scripting Function)

### Parameters
- **frame** (int) - The start frame number

### Returns
- **bool** - True if successful, false otherwise.
```

--------------------------------

### Functions starting with 'w'

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_func_w.html

This section lists functions that start with the letter 'w'. It includes the function name and its return type, indicating the object or data type it produces.

```APIDOC
## Functions starting with 'w'

### Description
Lists functions that begin with the letter 'w', along with their return types.

### Functions

*   **warning()** : MessageBox
*   **wasCanceled()** : DrawingToolParams
*   **whiteBackground()** : LayoutExportParams
*   **width()** : node
*   **workingCopy()** : Cel
*   **workingCopyAs()** : Cel
*   **write()** : File , FileWrapper
*   **writeByte()** : File
*   **writeFile()** : FileWrapper
*   **writeLayeredFile()** : CELIO
*   **writeLine()** : File , FileWrapper
```

--------------------------------

### Functions starting with 'i'

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_func_i.html

This section lists functions available in the Harmony 24 Scripting Interface that start with the letter 'i'. Each entry includes the function signature and the class(es) it belongs to.

```APIDOC
## Functions starting with 'i'

### Description
This section lists functions available in the Harmony 24 Scripting Interface that start with the letter 'i'. Each entry includes the function signature and the class(es) it belongs to.

### Functions

- **id()** : element
- **image()** : MovieImport
- **imageFile()** : Cel
- **imageFileAs()** : Cel
- **imageFiles()** : WriteNode
- **imageFilesPattern()** : WriteNode
- **importPaletteAtLocation()** : PaletteLocator
- **importPenstyleListFromString()** : PenstyleManager
- **importSound()** : column
- **information()** : MessageBox
- **init()** : ExportVideoDlg
- **insert()** : frame
- **insertPalette()** : PaletteList
- **insertPaletteAtLocation()** : PaletteList
- **instance()** : ProcessManager , SessionSocketManager
- **interpolate()** : NodeState , Point2d , Point3d , RigState
- **interpolate2d()** : NodeState , RigState
- **intValue()** : Attribute
- **intValueAt()** : Attribute
- **inverse()** : Matrix4x4
- **isAlive()** : Process2
- **IsAlternatePressed()** : KeyModifiers
- **isAncestorOf()** : Timeline
- **isAudioFileCreated()** : MovieImport
- **isCel3D()** : Cel
- **isClose()** : FileWrapper
- **isColorPalette()** : Palette
- **isControlCenterApp()** : about
- **IsControlPressed()** : KeyModifiers
- **isControlShown()** : node
- **isDatabaseMode()** : about
- **isDebug()** : MessageLog
- **isDeformationShown()** : deformation
- **isDemoVersion()** : about
- **isDirty()** : scene
- **isEducVersion()** : about
- **isEmpty()** : Matrix4x4
- **isEqual()** : Point3d , Quaternion , Vector2d , Vector3d
- **isExists()** : Drawing
- **isFullVersion()** : about
- **isGameStoryboard()** : about
- **isGameStudio()** : about
- **isGroup()** : node
- **isHarmony()** : about
- **isIdentity()** : Quaternion
- **isInteractiveApp()** : about
- **isKeyFrame()** : column
- **isLinked()** : node
- **isLinuxArch()** : about
- **isLoaded()** : Palette , PaletteList
- **isMacArch()** : about
- **isMacIntelArch()** : about
- **isMacPpcArch()** : about
- **isMainApp()** : about
- **isNotEqual()** : Point3d , Quaternion , Vector2d , Vector3d
- **isNotFound()** : Palette
- **isOpen()** : FileWrapper
- **isOrigin()** : Point3d
- **isPaintMode()** : about
- **isRunning()** : ProcessManager , SCR_ProcessManagerWrapper
- **isScanApp()** : about
- **isSelectionRange()** : selection
- **IsShiftPressed()** : KeyModifiers
- **IsSpacePressed()** : KeyModifiers
- **isStage()** : about
- **isStageAdvanced()** : about
- **isStageEssentials()** : about
- **isStoryboard()** : about
- **isSupportingCache()** : node
- **isTexturePalette()** : Palette
- **isUnicode()** : sound
- **isValid()** : Palette , PaletteList
- **isWindowsArch()** : about
- **isXsheetMode()** : about
- **isZero()** : Vector2d , Vector3d
```

--------------------------------

### Instantiate and Connect RotationXWidget

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classRotationXWidget.html

Demonstrates how to create a RotationXWidget instance with custom properties and connect its valueChanged signal to a callback function. This is typically done within a Controller.onShowControl function.

```javascript
Controller.onShowControl = function()
{
Controller.controls = [];
var myRotationXdWidget = new RotationXWidget(
{
data : "myRotation",
radius : 2,
width : 0.05,
color : ColorRGBA(255,0,0, 120),
selected_color : ColorRGBA(255,128,128, 120)
} );
// Register a callback for when a transformation tool value changes.
myRotationXdWidget.valueChanged.connect(myRotationChanged);
Controller.controls.push(myRotationXdWidget);
}
```

--------------------------------

### Initialize and Use LayoutExportParams

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/classLayoutExportParams.html

Demonstrates how to create instances of LayoutExport and LayoutExportParams, execute the export dialog, and save the export settings. Use this pattern to programmatically control layout exports.

```javascript
var le = new LayoutExport;
var params = new LayoutExportParams;
// Fetch export values from dialog
if (le.execDialog(params, true, true, translator.tr("Export Layout Images from Selection")) == false)
return;
if (le.save(params))
{
le.saveXli(params);
MessageLog.trace( le.outputFilePath(params) + " was successfully exported." );
}
```

--------------------------------

### Functions starting with 'n'

Source: https://docs.toonboom.com/help/harmony-24/scripting/script/functions_func_n.html

This section lists functions available in the Harmony 24 scripting API that start with the letter 'n'. For each function, the return type and the classes it is associated with are provided.

```APIDOC
## Functions starting with 'n'

### Description
Lists functions available in the Harmony 24 scripting API that start with the letter 'n'. For each function, the return type and the classes it is associated with are provided.

### Functions

*   **name()** : Attribute, Drawing, SubnodeData
*   **namedResolutions()** : scene
*   **namedResolutionX()** : scene
*   **namedResolutionY()** : scene
*   **negate()** : Vector2d, Vector3d
*   **networkChanged()** : SceneChangeNotifier
*   **newColumn()** : Dialog, GroupBox
*   **newTab()** : Dialog
*   **nextDeformMatrix()** : deformation
*   **nextRestMatrix()** : deformation
*   **node()** : LayoutExportParams
*   **nodeChanged()** : SceneChangeNotifier
*   **nodeCount()** : RigState
*   **nodeFrameReady()** : render
*   **nodeMetadataChanged()** : SceneChangeNotifier
*   **nodes()** : Backdrop
*   **noNode()** : node
*   **normalize()** : Matrix4x4, Vector2d, Vector3d
*   **numberOf()** : column, Drawing, element, frame
*   **numberOfColumnsSelected()** : selection
*   **numberOfFrames()** : selection
*   **numberOfImages()** : MovieImport
*   **numberOfInputPorts()** : node
*   **numberOfNodesSelected()** : selection
*   **numberOfOutputLinks()** : node
*   **numberOfOutputPorts()** : node
*   **numberOfPoints()** : func
*   **numberOfPointsPath3d()** : func
*   **numberOfSubNodes()** : node
*   **numberOfTemplatesSelected()** : library
*   **numberOfUnitsX()** : scene
*   **numberOfUnitsY()** : scene
*   **numberOfUnitsZ()** : scene
*   **numFrameSel()** : Timeline
*   **numLayers()** : Timeline
*   **numLayerSel()** : Timeline
```
Tokens:
Raw