Class KeyAccidental

The <key-accidental> element

Parent element: <key>

Non-traditional key signatures are represented using a list of altered tones. The <key-accidental> element indicates the accidental to be displayed in the key signature, represented in the same manner as the <accidental> element. It is used for disambiguating microtonal accidentals. The different element names indicate the different meaning of altering notes in a scale versus altering a sounding pitch.

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

Hierarchy

KeyAccidental

Implements

XMLElement<"key-accidental", KeyAccidentalAttributes, KeyAccidentalContents>

Index

Constructors

constructor

new KeyAccidental(opts?): KeyAccidental
Parameters
- Optional opts: {
  attributes?: Partial<KeyAccidentalAttributes>;
  contents?: KeyAccidentalContents;
  }
  - Optional attributes?: Partial<KeyAccidentalAttributes>
  - Optional contents?: KeyAccidentalContents
Returns KeyAccidental
- Defined in generated/elements.ts:47565

Properties

attributes

attributes: KeyAccidentalAttributes

contents: KeyAccidentalContents

`Readonly` schema

schema: {
    attributes: {
        smufl: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "acc";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "accidental-value";
            type: "label";
            value: {
                choices: readonly ["other", "sharp", "natural", "flat", "double-sharp", "sharp-sharp", "flat-flat", "natural-sharp", "natural-flat", "quarter-flat", "quarter-sharp", "three-quarters-flat", "three-quarters-sharp", "sharp-down", "sharp-up", "natural-down", "natural-up", "flat-down", "flat-up", "double-sharp-down", "double-sharp-up", "flat-flat-down", "flat-flat-up", "arrow-down", "arrow-up", "triple-sharp", "triple-flat", "slash-quarter-sharp", "slash-sharp", "slash-flat", "double-slash-flat", "sharp-1", "sharp-2", "sharp-3", "sharp-5", "flat-1", "flat-2", "flat-3", "flat-4", "sori", "koron"];
                type: "choices";
            };
        };
    }];
    name: "key-accidental";
} = KeyAccidental.schema

Type declaration

Readonly attributes: {
    smufl: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "acc";
        };
    };
}
- Readonly smufl: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "acc";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "acc";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "acc"
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "accidental-value";
        type: "label";
        value: {
            choices: readonly ["other", "sharp", "natural", "flat", "double-sharp", "sharp-sharp", "flat-flat", "natural-sharp", "natural-flat", "quarter-flat", "quarter-sharp", "three-quarters-flat", "three-quarters-sharp", "sharp-down", "sharp-up", "natural-down", "natural-up", "flat-down", "flat-up", "double-sharp-down", "double-sharp-up", "flat-flat-down", "flat-flat-up", "arrow-down", "arrow-up", "triple-sharp", "triple-flat", "slash-quarter-sharp", "slash-sharp", "slash-flat", "double-slash-flat", "sharp-1", "sharp-2", "sharp-3", "sharp-5", "flat-1", "flat-2", "flat-3", "flat-4", "sori", "koron"];
            type: "choices";
        };
    };
}]
Readonly name: "key-accidental"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    smufl: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "acc";
        };
    };
}
- Readonly smufl: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "acc";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "acc";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "acc"
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "accidental-value";
        type: "label";
        value: {
            choices: readonly ["other", "sharp", "natural", "flat", "double-sharp", "sharp-sharp", "flat-flat", "natural-sharp", "natural-flat", "quarter-flat", "quarter-sharp", "three-quarters-flat", "three-quarters-sharp", "sharp-down", "sharp-up", "natural-down", "natural-up", "flat-down", "flat-up", "double-sharp-down", "double-sharp-up", "flat-flat-down", "flat-flat-up", "arrow-down", "arrow-up", "triple-sharp", "triple-flat", "slash-quarter-sharp", "slash-sharp", "slash-flat", "double-slash-flat", "sharp-1", "sharp-2", "sharp-3", "sharp-5", "flat-1", "flat-2", "flat-3", "flat-4", "sori", "koron"];
            type: "choices";
        };
    };
}]
Readonly name: "key-accidental"

Methods

getAccidentalValue

getAccidentalValue(): "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
Gets

Returns "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
- Defined in generated/elements.ts:47579

getSmufl

getSmufl(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:47570

setAccidentalValue

setAccidentalValue(accidentalValue): KeyAccidental
Sets
Parameters
- accidentalValue: "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
Returns KeyAccidental
- Defined in generated/elements.ts:47624

setSmufl

setSmufl(smufl): KeyAccidental
Sets
Parameters
- smufl: null | string
Returns KeyAccidental
- Defined in generated/elements.ts:47574

Class KeyAccidental

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<KeyAccidentalAttributes>; contents?: KeyAccidentalContents; }

Optional attributes?: Partial<KeyAccidentalAttributes>

Optional contents?: KeyAccidentalContents

Returns KeyAccidental

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { smufl: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "acc"; }; }; }

Readonly smufl: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "acc"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "acc"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "acc"

Readonly name: "key-accidental"

Static Readonly schema

Type declaration

Readonly attributes: { smufl: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "acc"; }; }; }

Readonly smufl: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "acc"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "acc"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "acc"

Readonly name: "key-accidental"

Methods

getAccidentalValue

getSmufl

Returns null | string

setAccidentalValue

Parameters

Returns KeyAccidental

setSmufl

Parameters

smufl: null | string

Returns KeyAccidental

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<KeyAccidentalAttributes>;
contents?: KeyAccidentalContents;
}

`Optional` attributes?: Partial<KeyAccidentalAttributes>

`Optional` contents?: KeyAccidentalContents

`Readonly` schema

`Readonly` attributes: {
smufl: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "acc";
};
};
}

`Readonly` smufl: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "acc";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "acc";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "acc"

`Readonly` name: "key-accidental"

`Static` `Readonly` schema

`Readonly` attributes: {
smufl: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "acc";
};
};
}

`Readonly` smufl: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "acc";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "acc";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "acc"

`Readonly` name: "key-accidental"