Class NumeralKey

The <numeral-key> element

Parent element: <numeral>

The <numeral-key> element is used when the key for the numeral is different than the key specified by the key signature.

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

Hierarchy

  • NumeralKey

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getNumeralFifths getNumeralMode getPrintObject setNumeralFifths setNumeralMode setPrintObject

Constructors

constructor

Properties

attributes

attributes: NumeralKeyAttributes

contents

contents: NumeralKeyContents

Readonly schema

schema: {
    attributes: {
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: typeof NumeralFifths;
    }, {
        type: "required";
        value: typeof NumeralMode;
    }];
    name: "numeral-key";
} = NumeralKey.schema

Type declaration

  • Readonly attributes: {
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    }
    • Readonly print-object: {
          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 contents: readonly [{
        type: "required";
        value: typeof NumeralFifths;
    }, {
        type: "required";
        value: typeof NumeralMode;
    }]
  • Readonly name: "numeral-key"

Static Readonly schema

schema: {
    attributes: {
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: typeof NumeralFifths;
    }, {
        type: "required";
        value: typeof NumeralMode;
    }];
    name: "numeral-key";
} = ...

Type declaration

  • Readonly attributes: {
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    }
    • Readonly print-object: {
          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 contents: readonly [{
        type: "required";
        value: typeof NumeralFifths;
    }, {
        type: "required";
        value: typeof NumeralMode;
    }]
  • Readonly name: "numeral-key"

Methods

getNumeralFifths

getNumeralMode

getPrintObject

setNumeralFifths

setNumeralMode

setPrintObject

Settings

Theme

On This Page

Generated using TypeDoc