Class Rest

The <rest> element.

The rest element indicates notated rests or silences. Rest elements are usually empty, but placement on the staff can be specified using display-step and display-octave elements. If the measure attribute is set to yes, this indicates this is a complete measure rest.

See

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/rest/

Hierarchy

Rest

Implements

XMLElement<"rest", RestAttributes, RestContents>

Index

Constructors

constructor

new Rest(opts?): Rest
Parameters
- Optional opts: {
  attributes?: Partial<RestAttributes>;
  contents?: RestContents;
  }
  - Optional attributes?: Partial<RestAttributes>
  - Optional contents?: RestContents
Returns Rest
- Defined in generated/elements.ts:7804

Properties

attributes

attributes: RestAttributes

contents: RestContents

`Readonly` schema

schema: XMLElementSchema<"rest"> = Rest.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"rest"> = schema.Rest

Methods

getMeasure

getMeasure(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:7809

getValue

getValue(): null | [DisplayStep, DisplayOctave]
Gets

Returns null | [DisplayStep, DisplayOctave]
- Defined in generated/elements.ts:7818

setMeasure

setMeasure(measure): Rest
Sets
Parameters
- measure: null | "yes" | "no"
Returns Rest
- Defined in generated/elements.ts:7813

setValue

setValue(value): Rest
Sets
Parameters
- value: null | [DisplayStep, DisplayOctave]
Returns Rest
- Defined in generated/elements.ts:7822

Class Rest

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<RestAttributes>;
contents?: RestContents;
}

`Optional` attributes?: Partial<RestAttributes>

`Optional` contents?: RestContents

Returns Rest

Properties

attributes

contents

`Readonly` schema

`Static` `Readonly` schema

Methods

getMeasure

Returns null | "yes" | "no"

getValue

Returns null | [DisplayStep, DisplayOctave]

setMeasure

Parameters

measure: null | "yes" | "no"

Returns Rest

setValue

Parameters

value: null | [DisplayStep, DisplayOctave]

Returns Rest

Settings

Theme

On This Page

Class Rest

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<RestAttributes>; contents?: RestContents; }

Optional attributes?: Partial<RestAttributes>

Optional contents?: RestContents

Returns Rest

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getMeasure

Returns null | "yes" | "no"

getValue

Returns null | [DisplayStep, DisplayOctave]

setMeasure

Parameters

measure: null | "yes" | "no"

Returns Rest

setValue

Parameters

value: null | [DisplayStep, DisplayOctave]

Returns Rest

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<RestAttributes>;
contents?: RestContents;
}

`Optional` attributes?: Partial<RestAttributes>

`Optional` contents?: RestContents

`Readonly` schema

`Static` `Readonly` schema