Grace(isAppoggiatura)

Class representing a Grace note modification.

A Grace note modification causes a note to either begin sounding earlier than anticipated (an acciaccatura) or to rob time from the duration of the next note (an appoggiatura). An appoggiatura will also be lightly accented in loudness, while an accacciatura will be slightly deaccented.

new Grace(isAppoggiatura)

Constructs a new Grace modification object.

Parameters:
Name Type Description
isAppoggiatura boolean

Whether this modification represents an appoggiatura (vs. an accacciatura)

Extends

Classes

Grace

Members

key :Key

Overrides:

tempo :Tempo

Overrides:

unmodifiedDetails :NoteDetails

Overrides:

Methods

getModifiedNoteDetails(details) → {Array.<NoteDetails>}

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

The details variable must contain the following key:

graceNoteValue: MIDI note number of the grace note

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

Information about the grace note value

Returns:
Array.<NoteDetails> -

List of NoteDetails to replace the original note

Overrides:

static canModifySequence() → {boolean}

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>>>}

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