Class Alter

The <alter> element

Parent element: <pitch>

The ` element represents chromatic alteration in number of semitones (e.g., -1 for flat, 1 for sharp). Decimal values like 0.5 (quarter tone sharp) are used for microtones.

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

Hierarchy

Alter

Implements

XMLElement<"alter", AlterAttributes, AlterContents>

Index

Constructors

constructor

new Alter(opts?): Alter
Parameters
- Optional opts: {
  attributes?: Partial<AlterAttributes>;
  contents?: AlterContents;
  }
  - Optional attributes?: Partial<AlterAttributes>
  - Optional contents?: AlterContents
Returns Alter
- Defined in generated/elements.ts:10001

Properties

attributes

attributes: AlterAttributes

contents: AlterContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            label: "semitones";
            type: "label";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }];
    name: "alter";
} = Alter.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "semitones";
        type: "label";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}]
Readonly name: "alter"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "semitones";
        type: "label";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}]
Readonly name: "alter"

Methods

getSemitones

getSemitones(): number
Gets

Returns number
- Defined in generated/elements.ts:10007

setSemitones

setSemitones(semitones): Alter
Sets
Parameters
- semitones: number
Returns Alter
- Defined in generated/elements.ts:10011

Class Alter

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<AlterAttributes>;
contents?: AlterContents;
}

`Optional` attributes?: Partial<AlterAttributes>

`Optional` contents?: AlterContents

Returns Alter

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "semitones";
        type: "label";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}]

`Readonly` name: "alter"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "semitones";
        type: "label";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}]

`Readonly` name: "alter"

Methods

getSemitones

Returns number

setSemitones

Parameters

semitones: number

Returns Alter

Settings

Theme

On This Page

Class Alter

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<AlterAttributes>; contents?: AlterContents; }

Optional attributes?: Partial<AlterAttributes>

Optional contents?: AlterContents

Returns Alter

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "semitones"; type: "label"; value: { max: number; min: number; type: "float"; }; }; }]

Readonly name: "alter"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "semitones"; type: "label"; value: { max: number; min: number; type: "float"; }; }; }]

Readonly name: "alter"

Methods

getSemitones

Returns number

setSemitones

Parameters

semitones: number

Returns Alter

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<AlterAttributes>;
contents?: AlterContents;
}

`Optional` attributes?: Partial<AlterAttributes>

`Optional` contents?: AlterContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "semitones";
type: "label";
value: {
max: number;
min: number;
type: "float";
};
};
}]

`Readonly` name: "alter"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "semitones";
type: "label";
value: {
max: number;
min: number;
type: "float";
};
};
}]

`Readonly` name: "alter"