Class Attributes

The <attributes> element.

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.

See

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

Properties

attributes

attributes: AttributesAttributes

contents: AttributesContents

`Readonly` schema

schema: XMLElementSchema<"attributes"> = Attributes.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"attributes"> = schema.Attributes

Methods

getClefs

getClefs(): Clef[]
Gets

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

getDirectives

getDirectives(): Directive[]
Gets

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

getDivisions

getDivisions(): null | Divisions
Gets

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

getFootnote

getFootnote(): null | Footnote
Gets

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

getInstruments

getInstruments(): null | Instruments
Gets

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

getKeys

getKeys(): Key[]
Gets

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

getLevel

getLevel(): null | Level
Gets

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

getMeasureStyles

getMeasureStyles(): MeasureStyle[]
Gets

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

getPartSymbol

getPartSymbol(): null | PartSymbol
Gets

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

getStaffDetails

getStaffDetails(): StaffDetails[]
Gets

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

getStaves

getStaves(): null | Staves
Gets

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

getTimes

getTimes(): Time[]
Gets

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

getTranspositions

getTranspositions(): Transposes | ForParts
Gets

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

setClefs

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

setDirectives

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

setDivisions

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

setFootnote

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

setInstruments

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

setKeys

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

setLevel

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

setMeasureStyles

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

setPartSymbol

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

setStaffDetails

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

setStaves

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

setTimes

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

setTranspositions

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

Class Attributes

See

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

Static Readonly schema

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

setMeasureStyles

Parameters

measureStyles: MeasureStyle[]

Returns Attributes

setPartSymbol

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

`Optional` attributes?: Partial<AttributesAttributes>

`Optional` contents?: AttributesContents

`Readonly` schema

`Static` `Readonly` schema