Class NumeralRoot

The <numeral-root> element.

The numeral-root type represents the Roman numeral or Nashville number as a positive integer from 1 to 7. The text attribute indicates how the numeral should appear in the score. A numeral-root value of 5 with a kind of major would have a text attribute of "V" if displayed as a Roman numeral, and "5" if displayed as a Nashville number. If the text attribute is not specified, the display is application-dependent.

See

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

Hierarchy

NumeralRoot

Implements

XMLElement<"numeral-root", NumeralRootAttributes, NumeralRootContents>

Constructors

constructor

new NumeralRoot(opts?): NumeralRoot
Parameters
- Optional opts: {
  attributes?: Partial<NumeralRootAttributes>;
  contents?: NumeralRootContents;
  }
  - Optional attributes?: Partial<NumeralRootAttributes>
  - Optional contents?: NumeralRootContents
Returns NumeralRoot
- Defined in generated/elements.ts:36185

Properties

attributes

attributes: NumeralRootAttributes

contents: NumeralRootContents

`Readonly` schema

schema: XMLElementSchema<"numeral-root"> = NumeralRoot.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"numeral-root"> = schema.NumeralRoot

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:36199

getDefaultY

getDefaultY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:36208

getFontFamily

getFontFamily(): null | string
Gets

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

getFontSize

getFontSize(): null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
Gets

Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
- Defined in generated/elements.ts:36226

getFontStyle

getFontStyle(): null | "normal" | "italic"
Gets

Returns null | "normal" | "italic"
- Defined in generated/elements.ts:36237

getFontWeight

getFontWeight(): null | "normal" | "bold"
Gets

Returns null | "normal" | "bold"
- Defined in generated/elements.ts:36246

getNumeralValue

getNumeralValue(): number
Gets

Returns number
- Defined in generated/elements.ts:36282

getRelativeX

getRelativeX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:36255

getRelativeY

getRelativeY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:36264

getText

getText(): null | string
Gets

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

setColor

setColor(color): NumeralRoot
Sets
Parameters
- color: null | string
Returns NumeralRoot
- Defined in generated/elements.ts:36194

setDefaultX

setDefaultX(defaultX): NumeralRoot
Sets
Parameters
- defaultX: null | number
Returns NumeralRoot
- Defined in generated/elements.ts:36203

setDefaultY

setDefaultY(defaultY): NumeralRoot
Sets
Parameters
- defaultY: null | number
Returns NumeralRoot
- Defined in generated/elements.ts:36212

setFontFamily

setFontFamily(fontFamily): NumeralRoot
Sets
Parameters
- fontFamily: null | string
Returns NumeralRoot
- Defined in generated/elements.ts:36221

setFontSize

setFontSize(fontSize): NumeralRoot
Sets
Parameters
- fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
Returns NumeralRoot
- Defined in generated/elements.ts:36230

setFontStyle

setFontStyle(fontStyle): NumeralRoot
Sets
Parameters
- fontStyle: null | "normal" | "italic"
Returns NumeralRoot
- Defined in generated/elements.ts:36241

setFontWeight

setFontWeight(fontWeight): NumeralRoot
Sets
Parameters
- fontWeight: null | "normal" | "bold"
Returns NumeralRoot
- Defined in generated/elements.ts:36250

setNumeralValue

setNumeralValue(numeralValue): NumeralRoot
Sets
Parameters
- numeralValue: number
Returns NumeralRoot
- Defined in generated/elements.ts:36286

setRelativeX

setRelativeX(relativeX): NumeralRoot
Sets
Parameters
- relativeX: null | number
Returns NumeralRoot
- Defined in generated/elements.ts:36259

setRelativeY

setRelativeY(relativeY): NumeralRoot
Sets
Parameters
- relativeY: null | number
Returns NumeralRoot
- Defined in generated/elements.ts:36268

setText

setText(text): NumeralRoot
Sets
Parameters
- text: null | string
Returns NumeralRoot
- Defined in generated/elements.ts:36277

Class NumeralRoot

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<NumeralRootAttributes>; contents?: NumeralRootContents; }

Optional attributes?: Partial<NumeralRootAttributes>

Optional contents?: NumeralRootContents

Returns NumeralRoot

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getFontFamily

Returns null | string

getFontSize

Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

getFontStyle

Returns null | "normal" | "italic"

getFontWeight

Returns null | "normal" | "bold"

getNumeralValue

Returns number

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getText

Returns null | string

setColor

Parameters

color: null | string

Returns NumeralRoot

setDefaultX

Parameters

defaultX: null | number

Returns NumeralRoot

setDefaultY

Parameters

defaultY: null | number

Returns NumeralRoot

setFontFamily

Parameters

fontFamily: null | string

Returns NumeralRoot

setFontSize

Parameters

fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

Returns NumeralRoot

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns NumeralRoot

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns NumeralRoot

setNumeralValue

Parameters

numeralValue: number

Returns NumeralRoot

setRelativeX

Parameters

relativeX: null | number

Returns NumeralRoot

setRelativeY

`Optional` opts: {
attributes?: Partial<NumeralRootAttributes>;
contents?: NumeralRootContents;
}

`Optional` attributes?: Partial<NumeralRootAttributes>

`Optional` contents?: NumeralRootContents

`Readonly` schema

`Static` `Readonly` schema