Class Instrument

The <instrument> element

Parent element: <note>

The <instrument> element distinguishes between <score-instrument> elements in a <score-part>. If multiple <score-instrument> elements are specified in a <score-part>, there should be an <instrument> element for each note in the <part>. Notes that are shared between multiple <score-instrument>s can have more than one <instrument> element.

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

Hierarchy

Instrument

Implements

XMLElement<"instrument", InstrumentAttributes, InstrumentContents>

Index

Constructors

constructor

new Instrument(opts?): Instrument
Parameters
- Optional opts: {
  attributes?: Partial<InstrumentAttributes>;
  contents?: [];
  }
  - Optional attributes?: Partial<InstrumentAttributes>
  - Optional contents?: []
Returns Instrument
- Defined in generated/elements.ts:10609

Properties

attributes

attributes: InstrumentAttributes

contents: []

`Readonly` schema

schema: {
    attributes: {
        id: {
            type: "required";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
    };
    contents: readonly [];
    name: "instrument";
} = Instrument.schema

Type declaration

Readonly attributes: {
    id: {
        type: "required";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
}
- Readonly id: {
      type: "required";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
Readonly contents: readonly []
Readonly name: "instrument"

`Static` `Readonly` schema

schema: {
    attributes: {
        id: {
            type: "required";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
    };
    contents: readonly [];
    name: "instrument";
} = ...

Type declaration

Readonly attributes: {
    id: {
        type: "required";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
}
- Readonly id: {
      type: "required";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
Readonly contents: readonly []
Readonly name: "instrument"

Methods

getId

getId(): string
Gets

Returns string
- Defined in generated/elements.ts:10614

setId

setId(id): Instrument
Sets
Parameters
- id: string
Returns Instrument
- Defined in generated/elements.ts:10618

Class Instrument

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<InstrumentAttributes>; contents?: []; }

Optional attributes?: Partial<InstrumentAttributes>

Optional contents?: []

Returns Instrument

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; }

Readonly id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "required"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

Readonly contents: readonly []

Readonly name: "instrument"

Static Readonly schema

Type declaration

Readonly attributes: { id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; }

Readonly id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "required"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

Readonly contents: readonly []

Readonly name: "instrument"

Methods

getId

Returns string

setId

Parameters

id: string

Returns Instrument

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<InstrumentAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<InstrumentAttributes>

`Optional` contents?: []

`Readonly` schema

`Readonly` attributes: {
id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
}

`Readonly` id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "required"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`Readonly` contents: readonly []

`Readonly` name: "instrument"

`Static` `Readonly` schema

`Readonly` attributes: {
id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
}

`Readonly` id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "required"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`Readonly` contents: readonly []

`Readonly` name: "instrument"