Sequencer

Type: Sequencer

Extends View

Script class of the Sequencer view.

Related Types

Properties

PropertyDescription
Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view.
enabled Enables/disables the view.

View Properties

Properties defined by the view that are normally editable via properties editor.

PropertyNameDescription
title Title The title of the window.
id Script ID The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts.
tooltip Tool Tip Window tool tip.

Methods

MethodDescription
callListener(eventName, [args]) Calls all event listeners for the given event name, useful for testing.
getParent() Get the parent window/view (if any) of this view.
getViewProperties() Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view.
getViewProperty(id) Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view.
on(eventName, callback) Adds an event listener for the given event name. e.g. view.on("click", function() { ... });
pxFromDimension(dimension) Convert a dimension string (e.g. "10em", "50dp", "100px") into pixel units, relative to the view object.

Returns the size in pixels.

removeAllListeners([eventName]) Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed.
removeListener(eventName, callback) Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback);
setViewProperty(id, value) Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view.
clearTrace() Clears the trace view. For long running sequences the trace window can become a performance issue.
get(name) Get the value of a sequencer variable.
gotoItem(name) Direct the sequencer to jump to the sequence item called 'name' once the current item completes.
has(name) Returns 'true' if the sequencer variable has been previously defined.
set(name, value) Set the value of a sequencer variable. The variable will be created if it does not exist.
trace(msg) Trace a message in the info area of the sequencer window.
unset(name) Deletes the sequencer variable. Following this, has(name) will return false.