Class Key

Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).

The only function considered public API is Key.distance

Implements

KeyProperties

Index

Accessors

modifier preferredModifier unicodeModifier

Methods

toString useModifier distance keyWithModifier

Accessors

modifier

get modifier(): Accidental | null
Returns Accidental | null
Deprecated
Use accidental instead
- Defined in src/key.ts:94

preferredModifier

get preferredModifier(): Accidental | null
Returns Accidental | null
Deprecated
Use preferredAccidental instead
- Defined in src/key.ts:100

unicodeModifier

get unicodeModifier(): string | null
Returns string | null
Deprecated
Use unicodeAccidental instead
- Defined in src/key.ts:88

Methods

toString

toString(
    __namedParameters?: {
        showMinor?: boolean;
        useUnicodeModifier?: boolean;
    },
): string
Returns a string representation of an object.
Parameters
- __namedParameters: { showMinor?: boolean; useUnicodeModifier?: boolean } = {}
Returns string
- Defined in src/key.ts:530

useModifier

useModifier(newAccidental: Accidental | null): Key
Parameters
- newAccidental: Accidental | null
Returns Key
Deprecated
Use useAccidental instead
- Defined in src/key.ts:675

`Static`distance

distance(oneKey: string | Key, otherKey: string | Key): number
Calculates the distance in semitones between one key and another.
Parameters
- oneKey: string | Key
  the key
- otherKey: string | Key
  the other key
Returns number
the distance in semitones
- Defined in src/key.ts:291

`Static`keyWithModifier

keyWithModifier(
    key: string,
    accidental: Accidental | null,
    type: ChordType,
): string
Parameters
- key: string
- accidental: Accidental | null
- type: ChordType
Returns string
Deprecated
Use keyWithAccidental instead
- Defined in src/key.ts:217