The note object

Type: Dictionary

The note object defines a single note within an event, along with other information pertaining to the note itself rather than to its containing event.

Keys

Name Type Required? Description
accidentalDisplay accidental display No Information about the displayed accidental for this note.

This value is optional. If it's missing, consuming software should do the following, based on the value of the top-level "useAccidentalDisplay" key:

* If useAccidentalDisplay is true, then this note's accidentalDisplay should be interpreted as {"show": false}.

* If useAccidentalDisplay is false, then this note's accidentalDisplay should be determined according to its own algorithms.
class style class No
id ID No
perform perform options No Controls whether this note is performed by consuming software.
pitch pitch Yes The note's sounded pitch.
smuflFont smufl font No The SMuFL-compliant font to be used when rendering this note.

The primary purpose of this attribute is to override a global font assignment.
staff staff number No A specific staff index for this note. If not provided, the value is inherited from any ancestor element that specified it. If no ancestor did so, the value is determined automatically according to the implementation’s rendering rules.

The primary purpose of this attribute is to override a default staff assignment at the sequence or event level — as in cross-staff keyboard notation.
ties An array of tie objects No If this note starts a tie, this object encodes the tie.

This is an array, because it's possible for a single note to be tied to multiple end notes, in the case of jumps and alternate endings. The order of the elements of this array is undefined.

Parent objects

This object is used by the following parent objects:

Examples

This object is used in the following examples:

Accidentals, Articulations, Beams, Beams (across barlines), Beams (hooks), Beams (secondary beam breaks), Beams (with inner grace notes), Clef changes, Dotted notes (augmentation dots), Grace note, Grace notes (beamed), Grand staff piano music, Jumps (D.S. al Fine), Jumps (Dal Segno), Key signatures, Lyric line metadata, Lyrics (basic), Lyrics (multi-line), Multimeasure rests, Multiple layouts, Multiple voices, Organ layout, Ottavas (8va), Parts, Repeats, Repeats (more than once repeated), Repeats (with alternate endings, advanced), Repeats (with alternate endings, simple), Repeats (with implied start repeat), Rest positions, Slurs, Slurs (for chords), Slurs (incomplete slurs), Slurs (targeting specific notes), Styling elements (basic), Styling via a class (basic), Tempo markings, Three-note chord and half rest, Ties, Time signatures, Tremolos (single-note), Tuplets, Two-bar C major scale, “Hello world”