Extends
Methods
clearAll() → {boolean}
- Inherited From:
Unselects all object types supported by this selection state. Return true if the selection has changed.
Returns:
- Type
- boolean
clearGroups() → {boolean}
- Inherited From:
Unselect all NoteGroupReference.
Return true if the selection has changed.
Returns:
- Type
- boolean
getIndexInParent() → {number}
- Inherited From:
Get index of the current object in its parent. In Lua, this index starts from 1. In JavaScript, this index starts from 0.
Returns:
- Type
- number
getParent() → {NestedObject|undefined}
- Inherited From:
Get the parent NestedObject. Return
undefined if the current object is not attached to a
parent.
Returns:
- Type
- NestedObject | undefined
getSelectedGroups() → {array}
- Inherited From:
Get an array of selected NoteGroupReference
following the order of selection.
Returns:
an array of NoteGroupReference
- Type
- array
hasSelectedContent() → {boolean}
- Inherited From:
Check if there's anything selected.
Returns:
- Type
- boolean
hasSelectedGroups() → {boolean}
- Inherited From:
Check if there is at least one NoteGroupReference
selected.
Returns:
- Type
- boolean
hasUnfinishedEdits() → {boolean}
- Inherited From:
Check if there's any unfinished edit on the selected objects.
For example, this will return true if the user is dragging around a few notes/control points but has not yet released the mouse.
Returns:
- Type
- boolean
isMemoryManaged() → {boolean}
- Inherited From:
Check whether or not the current object is memory managed (i.e. garbage collected by the script environment).
Returns:
- Type
- boolean
registerClearCallback(callback)
- Inherited From:
Attach a script function to be called when the selection is cleared. The callback function will receive one argument: the type of the cleared objects.
Note:
- Registering a new callback function will NOT override existing callbacks.
- To prevent callbacks from slowing down the application, multiple clear events will be coalesced and handled asynchronously. There is no guarantee that the cleared selection will stay empty by the time the callback is executed.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
registerSelectionCallback(callback)
- Inherited From:
Attach a script function to be called when objects are selected or deselected by the user. The callback function will receive two arguments: the type of the selected objects and whether this is a selection or deselection operation.
Note:
- Registering a new callback function will NOT override existing callbacks.
- To prevent callbacks from slowing down the application, multiple selection/deselection events will be coalesced and handled asynchronously. There is no guarantee that objects selected will stay selected by the time the callback is executed.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
selectGroup(reference)
- Inherited From:
Add a NoteGroupReference to
the selection.
The argument must be part of the currently open project.
Parameters:
| Name | Type | Description |
|---|---|---|
reference |
NoteGroupReference |
unselectGroup(reference) → {boolean}
- Inherited From:
Unselect a NoteGroupReference.
Return true if the selection has changed.
Parameters:
| Name | Type | Description |
|---|---|---|
reference |
NoteGroupReference |
Returns:
- Type
- boolean