The arpeggio object

Type: Dictionary

Represents an arpeggio marking (the vertical marking that communicates that several notes with the same rhythmic position are to be performed as an arpeggio).

Note an arpeggio marking might consist of notes across several staves. This is valid, as long as those staves are in the same part.

Attributes

Name	Type	Required?	Description
arrow	boolean	No	Whether an arrow should be drawn at the end of the arpeggio marking. This visually communicates the direction of the arpeggio, though some published music chooses not to display an arrow as a matter of style. If not specified, the default value is false.
direction	up, down or auto	No	The direction that this arpeggio's notes are arpeggiated. "up" means from lower-pitched notes to higher-pitched notes, and "down" means the opposite. "auto" means consuming applications are free to decide automatically. If not specfiied, the default value is "auto".
position	rhythmic position	Yes	The arpeggio's position within the bar.
span	ID pair	Yes	The IDs of the two notes that comprise this arpeggio. The "start" ID is the first-played note, and the "end" ID represents the last-played note. This provides the necessary information to draw the arpeggio marking and interpret its playback. Both notes must be in the same rhythmic position within the same bar and same part. Note they're not required to be in the same sequence; cross-sequence (aka cross-voice) and cross-staff arpeggios are supported, as long as the sequences and staves are in the same part. All inner notes (i.e., any other notes that are encoded at this rhythmic position and whose pitch lies between the "start" and "end" notes) are interpreted as being within the arpeggio; they are not explicitly encoded.

Plus globally available attributes: _c, _x, id

Parent objects

This object is used by the following parent objects:

part measure: "arpeggios"