Class NumeralMode

The <numeral-mode> element

Parent element: <numeral-key>

The <numeral-mode> specifies the scale that is used to interpret the <numeral-root> element values.

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

Hierarchy

NumeralMode

Implements

XMLElement<"numeral-mode", NumeralModeAttributes, NumeralModeContents>

Index

Constructors

constructor

new NumeralMode(opts?): NumeralMode
Parameters
- Optional opts: {
  attributes?: Partial<NumeralModeAttributes>;
  contents?: NumeralModeContents;
  }
  - Optional attributes?: Partial<NumeralModeAttributes>
  - Optional contents?: NumeralModeContents
Returns NumeralMode
- Defined in generated/elements.ts:52782

Properties

attributes

attributes: NumeralModeAttributes

contents: NumeralModeContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            label: "numeral-mode";
            type: "label";
            value: {
                choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
                type: "choices";
            };
        };
    }];
    name: "numeral-mode";
} = NumeralMode.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "numeral-mode";
        type: "label";
        value: {
            choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
            type: "choices";
        };
    };
}]
Readonly name: "numeral-mode"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "numeral-mode";
        type: "label";
        value: {
            choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
            type: "choices";
        };
    };
}]
Readonly name: "numeral-mode"

Methods

getNumeralMode

getNumeralMode(): "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"
Gets

Returns "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"
- Defined in generated/elements.ts:52788

setNumeralMode

setNumeralMode(numeralMode): NumeralMode
Sets
Parameters
- numeralMode: "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"
Returns NumeralMode
- Defined in generated/elements.ts:52792

Class NumeralMode

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<NumeralModeAttributes>;
contents?: NumeralModeContents;
}

`Optional` attributes?: Partial<NumeralModeAttributes>

`Optional` contents?: NumeralModeContents

Returns NumeralMode

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "numeral-mode";
        type: "label";
        value: {
            choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
            type: "choices";
        };
    };
}]

`Readonly` name: "numeral-mode"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "numeral-mode";
        type: "label";
        value: {
            choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
            type: "choices";
        };
    };
}]

`Readonly` name: "numeral-mode"

Methods

getNumeralMode

Returns "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"

setNumeralMode

Parameters

numeralMode: "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"

Returns NumeralMode

Settings

Theme

On This Page

Class NumeralMode

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<NumeralModeAttributes>; contents?: NumeralModeContents; }

Optional attributes?: Partial<NumeralModeAttributes>

Optional contents?: NumeralModeContents

Returns NumeralMode

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "numeral-mode"; type: "label"; value: { choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"]; type: "choices"; }; }; }]

Readonly name: "numeral-mode"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "numeral-mode"; type: "label"; value: { choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"]; type: "choices"; }; }; }]

Readonly name: "numeral-mode"

Methods

getNumeralMode

Returns "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"

setNumeralMode

Parameters

numeralMode: "major" | "minor" | "harmonic minor" | "melodic minor" | "natural minor"

Returns NumeralMode

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<NumeralModeAttributes>;
contents?: NumeralModeContents;
}

`Optional` attributes?: Partial<NumeralModeAttributes>

`Optional` contents?: NumeralModeContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "numeral-mode";
type: "label";
value: {
choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
type: "choices";
};
};
}]

`Readonly` name: "numeral-mode"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "numeral-mode";
type: "label";
value: {
choices: readonly ["major", "harmonic minor", "melodic minor", "minor", "natural minor"];
type: "choices";
};
};
}]

`Readonly` name: "numeral-mode"