Class KeyOctave

The <key-octave> element

Parent element: <key>

The <key-octave> element specifies in which octave an element of a key signature appears. The content specifies the octave value using the same values as the <display-octave> element.

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

Hierarchy

  • KeyOctave

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getCancel getNumber getOctave setCancel setNumber setOctave

Constructors

constructor

Properties

attributes

attributes: KeyOctaveAttributes

contents

contents: KeyOctaveContents

Readonly schema

schema: {
    attributes: {
        cancel: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        number: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "octave";
            type: "label";
            value: {
                max: 9;
                min: 0;
                type: "int";
            };
        };
    }];
    name: "key-octave";
} = KeyOctave.schema

Type declaration

  • Readonly attributes: {
        cancel: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        number: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    }
    • Readonly cancel: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly number: {
          type: "required";
          value: {
              max: number;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            max: number;
            min: 1;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 1
        • Readonly type: "int"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "octave";
            type: "label";
            value: {
                max: 9;
                min: 0;
                type: "int";
            };
        };
    }]
  • Readonly name: "key-octave"

Static Readonly schema

schema: {
    attributes: {
        cancel: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        number: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "octave";
            type: "label";
            value: {
                max: 9;
                min: 0;
                type: "int";
            };
        };
    }];
    name: "key-octave";
} = ...

Type declaration

  • Readonly attributes: {
        cancel: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        number: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    }
    • Readonly cancel: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly number: {
          type: "required";
          value: {
              max: number;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            max: number;
            min: 1;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 1
        • Readonly type: "int"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "octave";
            type: "label";
            value: {
                max: 9;
                min: 0;
                type: "int";
            };
        };
    }]
  • Readonly name: "key-octave"

Methods

getCancel

getNumber

getOctave

setCancel

setNumber

setOctave

Settings

Theme

On This Page

Generated using TypeDoc