Class TuningStep

The <tuning-step> element

Parent elements: <accord>, <staff-tuning>

The <tuning-step> element is represented like the <step> element, with a different name to reflect its different function in string tuning.

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

Hierarchy

TuningStep

Implements

XMLElement<"tuning-step", TuningStepAttributes, TuningStepContents>

Index

Constructors

constructor

new TuningStep(opts?): TuningStep
Parameters
- Optional opts: {
  attributes?: Partial<TuningStepAttributes>;
  contents?: TuningStepContents;
  }
  - Optional attributes?: Partial<TuningStepAttributes>
  - Optional contents?: TuningStepContents
Returns TuningStep
- Defined in generated/elements.ts:42309

Properties

attributes

attributes: TuningStepAttributes

contents: TuningStepContents

`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: "tuning-step";
} = TuningStep.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: "tuning-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: "tuning-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:42315

setStep

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

Class TuningStep

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<TuningStepAttributes>;
contents?: TuningStepContents;
}

`Optional` attributes?: Partial<TuningStepAttributes>

`Optional` contents?: TuningStepContents

Returns TuningStep

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: "tuning-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: "tuning-step"

Methods

getStep

Returns "A" | "B" | "C" | "D" | "E" | "F" | "G"

setStep

Parameters

step: "A" | "B" | "C" | "D" | "E" | "F" | "G"

Returns TuningStep

Settings

Theme

On This Page

Class TuningStep

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<TuningStepAttributes>; contents?: TuningStepContents; }

Optional attributes?: Partial<TuningStepAttributes>

Optional contents?: TuningStepContents

Returns TuningStep

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: "tuning-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: "tuning-step"

Methods

getStep

Returns "A" | "B" | "C" | "D" | "E" | "F" | "G"

setStep

Parameters

step: "A" | "B" | "C" | "D" | "E" | "F" | "G"

Returns TuningStep

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<TuningStepAttributes>;
contents?: TuningStepContents;
}

`Optional` attributes?: Partial<TuningStepAttributes>

`Optional` contents?: TuningStepContents

`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: "tuning-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: "tuning-step"