Class KeyStep

The <key-step> element.

Non-traditional key signatures are represented using a list of altered tones. The key-step element indicates the pitch step to be altered, represented using the same names as in the step element.

See

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

Hierarchy

KeyStep

Implements

XMLElement<"key-step", KeyStepAttributes, KeyStepContents>

Index

Constructors

constructor

new KeyStep(opts?): KeyStep
Parameters
- Optional opts: {
  attributes?: Partial<KeyStepAttributes>;
  contents?: KeyStepContents;
  }
  - Optional attributes?: Partial<KeyStepAttributes>
  - Optional contents?: KeyStepContents
Returns KeyStep
- Defined in generated/elements.ts:32833

Properties

attributes

attributes: KeyStepAttributes

contents: KeyStepContents

`Readonly` schema

schema: XMLElementSchema<"key-step"> = KeyStep.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"key-step"> = schema.KeyStep

Methods

getStep

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

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

setStep

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

Class KeyStep

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<KeyStepAttributes>;
contents?: KeyStepContents;
}

`Optional` attributes?: Partial<KeyStepAttributes>

`Optional` contents?: KeyStepContents

Returns KeyStep

Properties

attributes

contents

`Readonly` schema

`Static` `Readonly` schema

Methods

getStep

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

setStep

Parameters

step: "A" | "B" | "C" | "D" | "E" | "F" | "G"

Returns KeyStep

Settings

Theme

On This Page

Class KeyStep

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<KeyStepAttributes>; contents?: KeyStepContents; }

Optional attributes?: Partial<KeyStepAttributes>

Optional contents?: KeyStepContents

Returns KeyStep

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getStep

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

setStep

Parameters

step: "A" | "B" | "C" | "D" | "E" | "F" | "G"

Returns KeyStep

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<KeyStepAttributes>;
contents?: KeyStepContents;
}

`Optional` attributes?: Partial<KeyStepAttributes>

`Optional` contents?: KeyStepContents

`Readonly` schema

`Static` `Readonly` schema