Class Rest

The <rest> element

Parent element: `

The <rest> element indicates notated rests or silences. A element is usually empty, but placement on the staff can be specified using <display-step> and <display-octave> elements.

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:10317

Properties

attributes

attributes: RestAttributes

contents: RestContents

`Readonly` schema

schema: {
    attributes: {
        measure: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: {
            label: "value";
            type: "label";
            value: readonly [{
                type: "required";
                value: typeof DisplayStep;
            }, {
                type: "required";
                value: typeof DisplayOctave;
            }];
        };
    }];
    name: "rest";
} = Rest.schema

Type declaration

Readonly attributes: {
    measure: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
}
- Readonly measure: {
      type: "optional";
      value: {
          choices: readonly ["yes", "no"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["yes", "no"];
    type: "choices";
    }
    - Readonly choices: readonly ["yes", "no"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "optional";
    value: {
        label: "value";
        type: "label";
        value: readonly [{
            type: "required";
            value: typeof DisplayStep;
        }, {
            type: "required";
            value: typeof DisplayOctave;
        }];
    };
}]
Readonly name: "rest"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    measure: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
}
- Readonly measure: {
      type: "optional";
      value: {
          choices: readonly ["yes", "no"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["yes", "no"];
    type: "choices";
    }
    - Readonly choices: readonly ["yes", "no"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "optional";
    value: {
        label: "value";
        type: "label";
        value: readonly [{
            type: "required";
            value: typeof DisplayStep;
        }, {
            type: "required";
            value: typeof DisplayOctave;
        }];
    };
}]
Readonly name: "rest"

Methods

getMeasure

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

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

getValue

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

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

setMeasure

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

setValue

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

Class Rest

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

Type declaration

Readonly attributes: { measure: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }; }

Readonly measure: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["yes", "no"]; type: "choices"; }

Readonly choices: readonly ["yes", "no"]

Readonly type: "choices"

Readonly contents: readonly [{ type: "optional"; value: { label: "value"; type: "label"; value: readonly [{ type: "required"; value: typeof DisplayStep; }, { type: "required"; value: typeof DisplayOctave; }]; }; }]

Readonly name: "rest"

Static Readonly schema

Type declaration

Readonly attributes: { measure: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }; }

Readonly measure: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["yes", "no"]; type: "choices"; }

Readonly choices: readonly ["yes", "no"]

Readonly type: "choices"

Readonly contents: readonly [{ type: "optional"; value: { label: "value"; type: "label"; value: readonly [{ type: "required"; value: typeof DisplayStep; }, { type: "required"; value: typeof DisplayOctave; }]; }; }]

Readonly name: "rest"

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

`Readonly` attributes: {
measure: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
};
}

`Readonly` measure: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["yes", "no"];
type: "choices";
}

`Readonly` choices: readonly ["yes", "no"]

`Readonly` type: "choices"

`Readonly` contents: readonly [{
type: "optional";
value: {
label: "value";
type: "label";
value: readonly [{
type: "required";
value: typeof DisplayStep;
}, {
type: "required";
value: typeof DisplayOctave;
}];
};
}]

`Readonly` name: "rest"

`Static` `Readonly` schema

`Readonly` attributes: {
measure: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
};
}

`Readonly` measure: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["yes", "no"];
type: "choices";
}

`Readonly` choices: readonly ["yes", "no"]

`Readonly` type: "choices"

`Readonly` contents: readonly [{
type: "optional";
value: {
label: "value";
type: "label";
value: readonly [{
type: "required";
value: typeof DisplayStep;
}, {
type: "required";
value: typeof DisplayOctave;
}];
};
}]

`Readonly` name: "rest"