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.
Attributes
| Name | Type | Required? | Description |
|---|---|---|---|
| staff position | 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. On a five-line staff, the conventional position of most rests is staffPosition: 0 (i.e., vertically centered within the staff). Whole rests and half rests are notable special cases, because their SMuFL glyph origin points are at the edge of the glyph instead of the center. On a five-line staff, the conventional position for whole rests is staffPosition: 2, and the conventional position for half rests is staffPosition: 0. |
Plus globally available attributes: _c, _x, id
Parent objects
This object is used by the following parent objects:
- event: "rest"
Examples
This object is used in the following examples: