Class KeySignature

Index

Constructors

Methods

equals getAccidental getNumAccidentals getOrderedAccidentalNotes getScaleNote getType

Constructors

constructor

new KeySignature(keyNote: string, mode: number): KeySignature
Parameters
- keyNote: string
  Key note.
- mode: number
  [1..7], 1 = Ionian/Major, 2 = Dorian, ..., 7 = Locrian
Returns KeySignature

Methods

equals

equals(o: KeySignature): boolean
Parameters
- o: KeySignature
Returns boolean

getAccidental

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

getNumAccidentals

getNumAccidentals(): number
Returns number

getOrderedAccidentalNotes

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

getScaleNote

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

getType

getType(): "natural" | "flat" | "sharp"
Returns "natural" | "flat" | "sharp"