Class KeySignature

Readonlymode

Readonlytonic

getAccidental

• getAccidental(diatonicId: number): Accidental

  Get accidental for given diatonic id.

  Parameters

  • diatonicId: number

    Diatonic id.

  Returns Accidental

  • Accidental -2, -1, 0, 1 or 2.

getAccidentalType

• getAccidentalType(): AccidentalType

  Get accidental type sharps, flats, or natural (without accidentals).

  Returns AccidentalType

  • Accidental type.

getNaturalScaleNotes

• getNaturalScaleNotes(): readonly Note[]

  Get natural scale notes of this key signature, natural scale has 7 steps (e.g. Major scale: W, W, H, W, W, W, H).

  Returns readonly Note[]

  • Array of notes.

getNoteByDegree

• getNoteByDegree(degree: string | number): Note

  Get note of key signature by degree value.

  Parameters

  • degree: string | number

    Degree number in range [1, 7] or string e.g "b5" or "#4".

  Returns Note

  • Note.

getNumAccidentals

• getNumAccidentals(): number

  Get number of accidentals this key signature has.

  Returns number

  • Number of accidentals.

getOrderedAccidentalNotes

• getOrderedAccidentalNotes(): readonly Note[]

  Get accidental notes in correct order.

  Returns readonly Note[]

  • Array of accidental notes.

Staticequals

• equals(
      a: undefined | null | KeySignature,
      b: undefined | null | KeySignature,
  ): boolean

  Test equality of given key signatures.

  Parameters

  • a: undefined | null | KeySignature

    Key signature a.

  • b: undefined | null | KeySignature

    Key signature b.

  Returns boolean

  • True/false.