Class KeyStep

The <key> element

Parent element: <attributes>

The <key> element represents a key signature. Both traditional and non-traditional key signatures are supported. Key signatures appear at the start of each system unless the print-object attribute has been set to "no".

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

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:47367

Properties

attributes

attributes: KeyStepAttributes

contents: KeyStepContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            label: "step";
            type: "label";
            value: {
                choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
                type: "choices";
            };
        };
    }];
    name: "key-step";
} = KeyStep.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "step";
        type: "label";
        value: {
            choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
            type: "choices";
        };
    };
}]
Readonly name: "key-step"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "step";
        type: "label";
        value: {
            choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
            type: "choices";
        };
    };
}]
Readonly name: "key-step"

Methods

getStep

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

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

setStep

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

Class KeyStep

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

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "step";
        type: "label";
        value: {
            choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
            type: "choices";
        };
    };
}]

`Readonly` name: "key-step"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "step";
        type: "label";
        value: {
            choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
            type: "choices";
        };
    };
}]

`Readonly` name: "key-step"

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

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

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "step"; type: "label"; value: { choices: readonly ["A", "B", "C", "D", "E", "F", "G"]; type: "choices"; }; }; }]

Readonly name: "key-step"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "step"; type: "label"; value: { choices: readonly ["A", "B", "C", "D", "E", "F", "G"]; type: "choices"; }; }; }]

Readonly name: "key-step"

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

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "step";
type: "label";
value: {
choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
type: "choices";
};
};
}]

`Readonly` name: "key-step"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "step";
type: "label";
value: {
choices: readonly ["A", "B", "C", "D", "E", "F", "G"];
type: "choices";
};
};
}]

`Readonly` name: "key-step"