Mordent(isUpper)

Class representing a Mordent modification.

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

new Mordent(isUpper)
modifications/Mordent.mjs, line 16

Constructs a new Mordent modification object.

Parameters:
Name Type Description
isUpper boolean

Whether this modification represents an upper mordent

Extends

Classes

Mordent
Mordent

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/Mordent.mjs, line 80

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 mordent from the primary note

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

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

List of NoteDetails to replace the original note

Overrides:

static canModifySequence() → {boolean}
modifications/Mordent.mjs, line 61

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/Mordent.mjs, line 43

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