Class Relation

The <relation> element.

A related resource for the music that is encoded. This is similar to the Dublin Core relation element. Standard type values are music, words, and arrangement, but other types may be used.

See

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

Hierarchy

Relation

Implements

XMLElement<"relation", RelationAttributes, RelationContents>

Index

Constructors

Properties

attributes contents schema schema

Methods

getText getType setText setType

Constructors

constructor

new Relation(opts?): Relation
Parameters
- Optional opts: {
  attributes?: Partial<RelationAttributes>;
  contents?: RelationContents;
  }
  - Optional attributes?: Partial<RelationAttributes>
  - Optional contents?: RelationContents
Returns Relation
- Defined in generated/elements.ts:704

Properties

attributes

attributes: RelationAttributes

contents

contents: RelationContents

`Readonly` schema

schema: XMLElementSchema<"relation"> = Relation.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"relation"> = schema.Relation

Methods

getText

getText(): string
Gets

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

getType

getType(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:709

setText

setText(text): Relation
Sets
Parameters
- text: string
Returns Relation
- Defined in generated/elements.ts:722

setType

setType(type): Relation
Sets
Parameters
- type: null | string
Returns Relation
- Defined in generated/elements.ts:713

Generated using TypeDoc