Class Numeral

The <numeral> element.

The numeral type represents the Roman numeral or Nashville number part of a harmony. It requires that the key be specified in the encoding, either with a key or numeral-key element.

See

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

Hierarchy

Numeral

Implements

XMLElement<"numeral", NumeralAttributes, NumeralContents>

Index

Constructors

Properties

attributes contents schema schema

Methods

getNumeralAlter getNumeralKey getNumeralRoot setNumeralAlter setNumeralKey setNumeralRoot

Constructors

constructor

new Numeral(opts?): Numeral
Parameters
- Optional opts: {
  attributes?: Partial<NumeralAttributes>;
  contents?: NumeralContents;
  }
  - Optional attributes?: Partial<NumeralAttributes>
  - Optional contents?: NumeralContents
Returns Numeral
- Defined in generated/elements.ts:36595

Properties

attributes

attributes: NumeralAttributes

contents

contents: NumeralContents

`Readonly` schema

schema: XMLElementSchema<"numeral"> = Numeral.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"numeral"> = schema.Numeral

Methods

getNumeralAlter

getNumeralAlter(): null | NumeralAlter
Gets

Returns null | NumeralAlter
- Defined in generated/elements.ts:36610

getNumeralKey

getNumeralKey(): null | NumeralKey
Gets

Returns null | NumeralKey
- Defined in generated/elements.ts:36619

getNumeralRoot

getNumeralRoot(): NumeralRoot
Gets

Returns NumeralRoot
- Defined in generated/elements.ts:36601

setNumeralAlter

setNumeralAlter(numeralAlter): Numeral
Sets
Parameters
- numeralAlter: null | NumeralAlter
Returns Numeral
- Defined in generated/elements.ts:36614

setNumeralKey

setNumeralKey(numeralKey): Numeral
Sets
Parameters
- numeralKey: null | NumeralKey
Returns Numeral
- Defined in generated/elements.ts:36623

setNumeralRoot

setNumeralRoot(numeralRoot): Numeral
Sets
Parameters
- numeralRoot: NumeralRoot
Returns Numeral
- Defined in generated/elements.ts:36605

Generated using TypeDoc