Class KeySignature

Hierarchy (View Summary)

KeySignature
- Scale

Index

Properties

Methods

getAccidental getAccidentalType getNaturalScaleNotes getNoteByDegree getNumAccidentals getOrderedAccidentalNotes equals

Properties

`Readonly`mode

mode: Mode

Mode: Ionian/Major = 1, Dorian = 2, ..., Locrian = 7

`Readonly`tonic

tonic: string

Tonic/root note.

Methods

getAccidental

getAccidental(diatonicId: number): Accidental
Parameters
- diatonicId: number
Returns Accidental

getAccidentalType

getAccidentalType(): AccidentalType
Returns AccidentalType

getNaturalScaleNotes

getNaturalScaleNotes(): readonly Note[]
Returns readonly Note[]

getNoteByDegree

getNoteByDegree(degree: string | number): Note
Parameters
- degree: string | number
  number 1..7 or string e.g "b5" or "#4"
Returns Note

getNumAccidentals

getNumAccidentals(): number
Returns number

getOrderedAccidentalNotes

getOrderedAccidentalNotes(): readonly Note[]
Returns readonly Note[]

`Static`equals

equals(
a: undefined | null | KeySignature,
b: undefined | null | KeySignature,
): boolean
Parameters
- a: undefined | null | KeySignature
- b: undefined | null | KeySignature
Returns boolean