Class RootStep

The <root-step> element.

The root-step type represents the pitch step of the root of the current chord within the harmony element. The text attribute indicates how the root should appear in a score if not using the element contents.

See

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

Hierarchy

RootStep

Implements

XMLElement<"root-step", RootStepAttributes, RootStepContents>

Constructors

constructor

new RootStep(opts?): RootStep
Parameters
- Optional opts: {
  attributes?: Partial<RootStepAttributes>;
  contents?: RootStepContents;
  }
  - Optional attributes?: Partial<RootStepAttributes>
  - Optional contents?: RootStepContents
Returns RootStep
- Defined in generated/elements.ts:35854

Properties

attributes

attributes: RootStepAttributes

contents: RootStepContents

`Readonly` schema

schema: XMLElementSchema<"root-step"> = RootStep.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"root-step"> = schema.RootStep

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getStep

getStep(): "A" | "B" | "C" | "D" | "E" | "F" | "G"
Gets

Returns "A" | "B" | "C" | "D" | "E" | "F" | "G"
- Defined in generated/elements.ts:35951

getText

getText(): null | string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setRelativeX

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

setRelativeY

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

setStep

setStep(step): RootStep
Sets
Parameters
- step: "A" | "B" | "C" | "D" | "E" | "F" | "G"
Returns RootStep
- Defined in generated/elements.ts:35955

setText

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

Class RootStep

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<RootStepAttributes>; contents?: RootStepContents; }

Optional attributes?: Partial<RootStepAttributes>

Optional contents?: RootStepContents

Returns RootStep

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"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getStep

Returns "A" | "B" | "C" | "D" | "E" | "F" | "G"

getText

Returns null | string

setColor

Parameters

color: null | string

Returns RootStep

setDefaultX

Parameters

defaultX: null | number

Returns RootStep

setDefaultY

Parameters

defaultY: null | number

Returns RootStep

setFontFamily

Parameters

fontFamily: null | string

Returns RootStep

setFontSize

Parameters

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

Returns RootStep

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns RootStep

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns RootStep

setRelativeX

Parameters

relativeX: null | number

Returns RootStep

setRelativeY

Parameters

relativeY: null | number

Returns RootStep

setStep

`Optional` opts: {
attributes?: Partial<RootStepAttributes>;
contents?: RootStepContents;
}

`Optional` attributes?: Partial<RootStepAttributes>

`Optional` contents?: RootStepContents

`Readonly` schema

`Static` `Readonly` schema