xsheet Class Reference

The xsheet JavaScript global object. Enables manipulation of the XSheet view from scripting. For example, allows a script to auto-advance the XSheet cell independently of the current timeline selection. More...

Public Slots

QScriptValue getCursorPosition ()
 Returns an array containing the current xsheet table cursor position and selection: [ leftColumn, topRow, rightColumn, bottomRow ]. More...
 
QScriptValue holdValue ()
 The number of frames that cells are exposed by default when editing timings. More...
 
void autoAdvance ()
 Simulates the effect of auto-advancing the cursor in the XSheet after entering values. More...
 
String visibleLinkedColumn (int i)
 Returns the column ID associated with the visible column at given index. More...
 

Detailed Description

The xsheet JavaScript global object. Enables manipulation of the XSheet view from scripting. For example, allows a script to auto-advance the XSheet cell independently of the current timeline selection.

Member Function Documentation

◆ autoAdvance

void xsheet::autoAdvance ( )
slot

Simulates the effect of auto-advancing the cursor in the XSheet after entering values.

◆ getCursorPosition

QScriptValue xsheet::getCursorPosition ( )
slot

Returns an array containing the current xsheet table cursor position and selection: [ leftColumn, topRow, rightColumn, bottomRow ].

Returns
QScriptValue

◆ holdValue

QScriptValue xsheet::holdValue ( )
slot

The number of frames that cells are exposed by default when editing timings.

Returns
QScriptValue

◆ visibleLinkedColumn

String xsheet::visibleLinkedColumn ( int  i)
slot

Returns the column ID associated with the visible column at given index.

Parameters
iVisible index of the column in the XSheet. Note that hidden columns don't count in that index.
Returns
String Column ID of the column at index i.