Class Attributes

The <attributes> element

Parent elements: <measure> (partwise), <part> (timewise)

The <attributes> element contains musical information that typically changes on measure boundaries. This includes key and time signatures, clefs, transpositions, and staving. When attributes are changed mid-measure, it affects the music in score order, not in MusicXML document order.

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

Hierarchy

Attributes

Implements

XMLElement<"attributes", AttributesAttributes, AttributesContents>

Constructors

constructor

new Attributes(opts?): Attributes
Parameters
- Optional opts: {
  attributes?: Partial<AttributesAttributes>;
  contents?: AttributesContents;
  }
  - Optional attributes?: Partial<AttributesAttributes>
  - Optional contents?: AttributesContents
Returns Attributes
- Defined in generated/elements.ts:51567

Properties

attributes

attributes: AttributesAttributes

contents: AttributesContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }, {
        type: "optional";
        value: typeof Divisions;
    }, {
        label: "keys";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof Key;
        };
    }, {
        label: "times";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof Time;
        };
    }, {
        type: "optional";
        value: typeof Staves;
    }, {
        type: "optional";
        value: typeof PartSymbol;
    }, {
        type: "optional";
        value: typeof Instruments;
    }, {
        label: "clefs";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof Clef;
        };
    }, {
        label: "staff-details";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffDetails;
        };
    }, {
        label: "transpositions";
        type: "label";
        value: {
            choices: readonly [{
                label: "transposes";
                type: "label";
                value: {
                    type: "zeroOrMore";
                    value: typeof Transpose;
                };
            }, {
                label: "for-parts";
                type: "label";
                value: {
                    type: "zeroOrMore";
                    value: typeof ForPart;
                };
            }];
            type: "choices";
        };
    }, {
        label: "directives";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof Directive;
        };
    }, {
        label: "measure-styles";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof MeasureStyle;
        };
    }];
    name: "attributes";
} = Attributes.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "optional";
    value: typeof Footnote;
}, {
    type: "optional";
    value: typeof Level;
}, {
    type: "optional";
    value: typeof Divisions;
}, {
    label: "keys";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Key;
    };
}, {
    label: "times";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Time;
    };
}, {
    type: "optional";
    value: typeof Staves;
}, {
    type: "optional";
    value: typeof PartSymbol;
}, {
    type: "optional";
    value: typeof Instruments;
}, {
    label: "clefs";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Clef;
    };
}, {
    label: "staff-details";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof StaffDetails;
    };
}, {
    label: "transpositions";
    type: "label";
    value: {
        choices: readonly [{
            label: "transposes";
            type: "label";
            value: {
                type: "zeroOrMore";
                value: typeof Transpose;
            };
        }, {
            label: "for-parts";
            type: "label";
            value: {
                type: "zeroOrMore";
                value: typeof ForPart;
            };
        }];
        type: "choices";
    };
}, {
    label: "directives";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Directive;
    };
}, {
    label: "measure-styles";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof MeasureStyle;
    };
}]
Readonly name: "attributes"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "optional";
    value: typeof Footnote;
}, {
    type: "optional";
    value: typeof Level;
}, {
    type: "optional";
    value: typeof Divisions;
}, {
    label: "keys";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Key;
    };
}, {
    label: "times";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Time;
    };
}, {
    type: "optional";
    value: typeof Staves;
}, {
    type: "optional";
    value: typeof PartSymbol;
}, {
    type: "optional";
    value: typeof Instruments;
}, {
    label: "clefs";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Clef;
    };
}, {
    label: "staff-details";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof StaffDetails;
    };
}, {
    label: "transpositions";
    type: "label";
    value: {
        choices: readonly [{
            label: "transposes";
            type: "label";
            value: {
                type: "zeroOrMore";
                value: typeof Transpose;
            };
        }, {
            label: "for-parts";
            type: "label";
            value: {
                type: "zeroOrMore";
                value: typeof ForPart;
            };
        }];
        type: "choices";
    };
}, {
    label: "directives";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Directive;
    };
}, {
    label: "measure-styles";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof MeasureStyle;
    };
}]
Readonly name: "attributes"

Methods

getClefs

getClefs(): Clef[]
Gets

Returns Clef[]
- Defined in generated/elements.ts:51645

getDirectives

getDirectives(): Directive[]
Gets

Returns Directive[]
- Defined in generated/elements.ts:51672

getDivisions

getDivisions(): null | Divisions
Gets

Returns null | Divisions
- Defined in generated/elements.ts:51591

getFootnote

getFootnote(): null | Footnote
Gets

Returns null | Footnote
- Defined in generated/elements.ts:51573

getInstruments

getInstruments(): null | Instruments
Gets

Returns null | Instruments
- Defined in generated/elements.ts:51636

getKeys

getKeys(): Key[]
Gets

Returns Key[]
- Defined in generated/elements.ts:51600

getLevel

getLevel(): null | Level
Gets

Returns null | Level
- Defined in generated/elements.ts:51582

getMeasureStyles

getMeasureStyles(): MeasureStyle[]
Gets

Returns MeasureStyle[]
- Defined in generated/elements.ts:51681

getPartSymbol

getPartSymbol(): null | PartSymbol
Gets

Returns null | PartSymbol
- Defined in generated/elements.ts:51627

getStaffDetails

getStaffDetails(): StaffDetails[]
Gets

Returns StaffDetails[]
- Defined in generated/elements.ts:51654

getStaves

getStaves(): null | Staves
Gets

Returns null | Staves
- Defined in generated/elements.ts:51618

getTimes

getTimes(): Time[]
Gets

Returns Time[]
- Defined in generated/elements.ts:51609

getTranspositions

getTranspositions(): Transposes | ForParts
Gets

Returns Transposes | ForParts
- Defined in generated/elements.ts:51663

setClefs

setClefs(clefs): Attributes
Sets
Parameters
- clefs: Clef[]
Returns Attributes
- Defined in generated/elements.ts:51649

setDirectives

setDirectives(directives): Attributes
Sets
Parameters
- directives: Directive[]
Returns Attributes
- Defined in generated/elements.ts:51676

setDivisions

setDivisions(divisions): Attributes
Sets
Parameters
- divisions: null | Divisions
Returns Attributes
- Defined in generated/elements.ts:51595

setFootnote

setFootnote(footnote): Attributes
Sets
Parameters
- footnote: null | Footnote
Returns Attributes
- Defined in generated/elements.ts:51577

setInstruments

setInstruments(instruments): Attributes
Sets
Parameters
- instruments: null | Instruments
Returns Attributes
- Defined in generated/elements.ts:51640

setKeys

setKeys(keys): Attributes
Sets
Parameters
- keys: Key[]
Returns Attributes
- Defined in generated/elements.ts:51604

setLevel

setLevel(level): Attributes
Sets
Parameters
- level: null | Level
Returns Attributes
- Defined in generated/elements.ts:51586

setMeasureStyles

setMeasureStyles(measureStyles): Attributes
Sets
Parameters
- measureStyles: MeasureStyle[]
Returns Attributes
- Defined in generated/elements.ts:51685

setPartSymbol

setPartSymbol(partSymbol): Attributes
Sets
Parameters
- partSymbol: null | PartSymbol
Returns Attributes
- Defined in generated/elements.ts:51631

setStaffDetails

setStaffDetails(staffDetails): Attributes
Sets
Parameters
- staffDetails: StaffDetails[]
Returns Attributes
- Defined in generated/elements.ts:51658

setStaves

setStaves(staves): Attributes
Sets
Parameters
- staves: null | Staves
Returns Attributes
- Defined in generated/elements.ts:51622

setTimes

setTimes(times): Attributes
Sets
Parameters
- times: Time[]
Returns Attributes
- Defined in generated/elements.ts:51613

setTranspositions

setTranspositions(transpositions): Attributes
Sets
Parameters
- transpositions: Transposes | ForParts
Returns Attributes
- Defined in generated/elements.ts:51667

Class Attributes

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<AttributesAttributes>; contents?: AttributesContents; }

Optional attributes?: Partial<AttributesAttributes>

Optional contents?: AttributesContents

Returns Attributes

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly name: "attributes"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly name: "attributes"

Methods

getClefs

Returns Clef[]

getDirectives

Returns Directive[]

getDivisions

Returns null | Divisions

getFootnote

Returns null | Footnote

getInstruments

Returns null | Instruments

getKeys

Returns Key[]

getLevel

Returns null | Level

getMeasureStyles

Returns MeasureStyle[]

getPartSymbol

Returns null | PartSymbol

getStaffDetails

Returns StaffDetails[]

getStaves

Returns null | Staves

getTimes

Returns Time[]

getTranspositions

Returns Transposes | ForParts

setClefs

Parameters

clefs: Clef[]

Returns Attributes

setDirectives

Parameters

directives: Directive[]

Returns Attributes

setDivisions

Parameters

divisions: null | Divisions

Returns Attributes

setFootnote

Parameters

footnote: null | Footnote

Returns Attributes

setInstruments

Parameters

instruments: null | Instruments

Returns Attributes

setKeys

Parameters

keys: Key[]

Returns Attributes

setLevel

Parameters

level: null | Level

Returns Attributes

`Optional` opts: {
attributes?: Partial<AttributesAttributes>;
contents?: AttributesContents;
}

`Optional` attributes?: Partial<AttributesAttributes>

`Optional` contents?: AttributesContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` name: "attributes"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` name: "attributes"