Class KeyOctave

The <key-octave> element.

The optional list of key-octave elements is used to specify in which octave each element of the key signature appears.

See

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

Hierarchy

KeyOctave

Implements

XMLElement<"key-octave", KeyOctaveAttributes, KeyOctaveContents>

Index

Constructors

Properties

attributes contents schema schema

Methods

getCancel getNumber getOctave setCancel setNumber setOctave

Constructors

constructor

new KeyOctave(opts?): KeyOctave
Parameters
- Optional opts: {
  attributes?: Partial<KeyOctaveAttributes>;
  contents?: KeyOctaveContents;
  }
  - Optional attributes?: Partial<KeyOctaveAttributes>
  - Optional contents?: KeyOctaveContents
Returns KeyOctave
- Defined in generated/elements.ts:33075

Properties

attributes

attributes: KeyOctaveAttributes

contents

contents: KeyOctaveContents

`Readonly` schema

schema: XMLElementSchema<"key-octave"> = KeyOctave.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"key-octave"> = schema.KeyOctave

Methods

getCancel

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

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

getNumber

getNumber(): number
Gets

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

getOctave

getOctave(): number
Gets

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

setCancel

setCancel(cancel): KeyOctave
Sets
Parameters
- cancel: null | "yes" | "no"
Returns KeyOctave
- Defined in generated/elements.ts:33084

setNumber

setNumber(number): KeyOctave
Sets
Parameters
- number: number
Returns KeyOctave
- Defined in generated/elements.ts:33093

setOctave

setOctave(octave): KeyOctave
Sets
Parameters
- octave: number
Returns KeyOctave
- Defined in generated/elements.ts:33102

Generated using TypeDoc