Trill(isUpper)

Class representing a Trill modification.

A Trill modification causes an implicit set of notes to be played after the primary printed note. In the case of an upper trill, the notes to be played are the principle note and the note above it, repeated for the printed duration of the principle note. In the case of a lower trill, the notes to be played are the principle note and the note below it, repeated for the printed duration of the principle note.

new Trill(isUpper)
modifications/Trill.mjs, line 15

Constructs a new Trill modification object.

Parameters:
Name Type Description
isUpper boolean

Whether this modification represents an upper trill

Extends

Classes

Trill
Trill

Members

key :Key
modifications/ModificationBase.mjs, line 34

Overrides:

tempo :Tempo
modifications/ModificationBase.mjs, line 32

Overrides:

unmodifiedDetails :NoteDetails
modifications/ModificationBase.mjs, line 36

Overrides:

Methods

getModifiedNoteDetails(details) → {Array.<NoteDetails>}
modifications/Trill.mjs, line 79

Returns a list of all modified notes, durations, and velocities as generated by the corresponding modification class.

The details variable may contain the following optional key:

offset: Integer offset of the trill from the primary note

Parameters:
Name Type Description
details Object.<string, number>

Information about the note value of the trill
Returns:
Array.<NoteDetails> -

List of NoteDetails to replace the original note

Overrides:

static canModifySequence() → {boolean}
modifications/Trill.mjs, line 60

Returns whether this modification can be used to modify a sequence of notes.

Returns:
boolean -

Whether this modification can be used to modify a sequence of notes

static getParameters() → {Object.<string, Object.<string, Array.<string>>>}
modifications/Trill.mjs, line 42

Returns a list of all parameters available for use in this modification, including whether the parameter is required or optional when playing back either a "sequence" or just a single "note".

Returns:
Object.<string, Object.<string, Array.<string>>> -

List of modification-specific parameter keys and when they are required