Turn(isUpper)

Class representing a Turn modification.

A Turn modification causes an implicit set of notes to be played after the primary printed note. In the case of an upper turn, the notes to be played are the principle note, the note above it, the principle note, the note below it, then finally the principle note again. In the case of a lower turn, the notes to be played are the principle note, the note below it, the principle note, the note above it, then finally the principle note again. The total cumulative duration of all notes in the turn is the same as the printed duration of the principle note.

new Turn(isUpper)
modifications/Turn.mjs, line 17

Constructs a new Turn modification object.

Parameters:
Name Type Description
isUpper boolean

Whether this modification represents an upper turn

Extends

Classes

Turn
Turn

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(opt details) → {Array.<NoteDetails>}
modifications/Turn.mjs, line 82

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

The details variable may contain the following two keys:

upperOffset: Upper offset value of the turn from the primary note lowerOffset: Lower offset value of the turn from the primary note

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

Details about the notes in the turn
Returns:
Array.<NoteDetails> -

List of NoteDetails to replace the original note

Overrides:

static canModifySequence() → {boolean}
modifications/Turn.mjs, line 62

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/Turn.mjs, line 44

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