Class RootAlter

The <root-alter> element.

The root-alter element represents the chromatic alteration of the root of the current chord within the harmony element. In some chord styles, the text for the root-step element may include root-alter information. In that case, the print-object attribute of the root-alter element can be set to no. The location attribute indicates whether the alteration should appear to the left or the right of the root-step; it is right by default.

See

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

Hierarchy

RootAlter

Implements

XMLElement<"root-alter", RootAlterAttributes, RootAlterContents>

Constructors

constructor

new RootAlter(opts?): RootAlter
Parameters
- Optional opts: {
  attributes?: Partial<RootAlterAttributes>;
  contents?: RootAlterContents;
  }
  - Optional attributes?: Partial<RootAlterAttributes>
  - Optional contents?: RootAlterContents
Returns RootAlter
- Defined in generated/elements.ts:35993

Properties

attributes

attributes: RootAlterAttributes

contents: RootAlterContents

`Readonly` schema

schema: XMLElementSchema<"root-alter"> = RootAlter.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"root-alter"> = schema.RootAlter

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getLocation

getLocation(): null | "left" | "right"
Gets

Returns null | "left" | "right"
- Defined in generated/elements.ts:36063

getPrintObject

getPrintObject(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:36072

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSemitones

getSemitones(): number
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setLocation

setLocation(location): RootAlter
Sets
Parameters
- location: null | "left" | "right"
Returns RootAlter
- Defined in generated/elements.ts:36067

setPrintObject

setPrintObject(printObject): RootAlter
Sets
Parameters
- printObject: null | "yes" | "no"
Returns RootAlter
- Defined in generated/elements.ts:36076

setRelativeX

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

setRelativeY

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

setSemitones

setSemitones(semitones): RootAlter
Sets
Parameters
- semitones: number
Returns RootAlter
- Defined in generated/elements.ts:36103

Class RootAlter

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<RootAlterAttributes>; contents?: RootAlterContents; }

Optional attributes?: Partial<RootAlterAttributes>

Optional contents?: RootAlterContents

Returns RootAlter

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"

getLocation

Returns null | "left" | "right"

getPrintObject

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSemitones

Returns number

setColor

Parameters

color: null | string

Returns RootAlter

setDefaultX

Parameters

defaultX: null | number

Returns RootAlter

setDefaultY

Parameters

defaultY: null | number

Returns RootAlter

setFontFamily

Parameters

fontFamily: null | string

Returns RootAlter

setFontSize

Parameters

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

Returns RootAlter

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns RootAlter

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns RootAlter

setLocation

Parameters

location: null | "left" | "right"

Returns RootAlter

setPrintObject

Parameters

printObject: null | "yes" | "no"

`Optional` opts: {
attributes?: Partial<RootAlterAttributes>;
contents?: RootAlterContents;
}

`Optional` attributes?: Partial<RootAlterAttributes>

`Optional` contents?: RootAlterContents

`Readonly` schema

`Static` `Readonly` schema