The rest object

Type: Dictionary

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


Name Type Required? Description
"staffPosition" staff position object No If provided, this specifies the vertical position of the rest on the staff. If not provided, the rest should be positioned automatically according to convention.

This vertical position is the "origin point" from which the rest symbol's SMuFL glyph is drawn. For example, a quarter rest is drawn from its vertical midpoint. See the SMuFL rests documentation for more.


This object is used in the following examples:

Beams, Beams (across barlines), Beams (secondary beam breaks), Beams (with inner grace notes), Multimeasure rests, Organ layout, Parts, Rest positions, Three-note chord and half rest