Class Staff

The <staff> element

Parent elements: <direction>, <forward>, <harmony>, <note>

Staff assignment is only needed for music notated on multiple staves. Staff values are numbers, with 1 referring to the top-most staff in a part.

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

Hierarchy

Staff

Implements

XMLElement<"staff", StaffAttributes, StaffContents>

Index

Constructors

constructor

new Staff(opts?): Staff
Parameters
- Optional opts: {
  attributes?: Partial<StaffAttributes>;
  contents?: StaffContents;
  }
  - Optional attributes?: Partial<StaffAttributes>
  - Optional contents?: StaffContents
Returns Staff
- Defined in generated/elements.ts:12302

Properties

attributes

attributes: StaffAttributes

contents: StaffContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    }];
    name: "staff";
} = Staff.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    label: "value";
    type: "label";
    value: {
        type: "required";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}]
Readonly name: "staff"

`Static` `Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    }];
    name: "staff";
} = ...

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    label: "value";
    type: "label";
    value: {
        type: "required";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}]
Readonly name: "staff"

Methods

getValue

getValue(): number
Gets

Returns number
- Defined in generated/elements.ts:12308

setValue

setValue(value): Staff
Sets
Parameters
- value: number
Returns Staff
- Defined in generated/elements.ts:12312

Class Staff

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<StaffAttributes>;
contents?: StaffContents;
}

`Optional` attributes?: Partial<StaffAttributes>

`Optional` contents?: StaffContents

Returns Staff

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    label: "value";
    type: "label";
    value: {
        type: "required";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}]

`Readonly` name: "staff"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    label: "value";
    type: "label";
    value: {
        type: "required";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}]

`Readonly` name: "staff"

Methods

getValue

Returns number

setValue

Parameters

value: number

Returns Staff

Settings

Theme

On This Page

Class Staff

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<StaffAttributes>; contents?: StaffContents; }

Optional attributes?: Partial<StaffAttributes>

Optional contents?: StaffContents

Returns Staff

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ label: "value"; type: "label"; value: { type: "required"; value: { max: number; min: 1; type: "int"; }; }; }]

Readonly name: "staff"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ label: "value"; type: "label"; value: { type: "required"; value: { max: number; min: 1; type: "int"; }; }; }]

Readonly name: "staff"

Methods

getValue

Returns number

setValue

Parameters

value: number

Returns Staff

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<StaffAttributes>;
contents?: StaffContents;
}

`Optional` attributes?: Partial<StaffAttributes>

`Optional` contents?: StaffContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
label: "value";
type: "label";
value: {
type: "required";
value: {
max: number;
min: 1;
type: "int";
};
};
}]

`Readonly` name: "staff"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
label: "value";
type: "label";
value: {
type: "required";
value: {
max: number;
min: 1;
type: "int";
};
};
}]

`Readonly` name: "staff"