Class Note

constructor

• new Note(diatonicId: number, accidental: number): Note

  Parameters

  • diatonicId: number
  • accidental: number

  Returns Note

• new Note(diatonicClass: number, accidental: number, octave: number): Note

  Parameters

  • diatonicClass: number
  • accidental: number
  • octave: number

  Returns Note

• new Note(noteLetter: string, accidental: number, octave: number): Note

  Parameters

  • noteLetter: string
  • accidental: number
  • octave: number

  Returns Note

Readonlyaccidental

ReadonlydiatonicClass

Readonlyoctave

chromaticClass

• get chromaticClass(): number

  Returns number

chromaticId

• get chromaticId(): number

  Returns number

diatonicId

• get diatonicId(): number

  Returns number

midiNumber

• get midiNumber(): number

  Returns number

noteLetter

• get noteLetter(): NoteLetter

  Returns NoteLetter

format

• format(pitchNotation: PitchNotation, symbolSet: SymbolSet): string

  Parameters

  • pitchNotation: PitchNotation
  • symbolSet: SymbolSet

  Returns string

formatOmitOctave

• formatOmitOctave(symbolSet: SymbolSet): string

  Parameters

  • symbolSet: SymbolSet

  Returns string

StaticcompareFunc

• compareFunc(a: Note, b: Note): -1 | 0 | 1

  Parameters

  • a: Note
  • b: Note

  Returns -1 | 0 | 1

Staticequals

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

  Parameters

  • a: undefined | null | Note
  • b: undefined | null | Note

  Returns boolean

StaticfindNextDiatonicIdAbove

• findNextDiatonicIdAbove(
      diatonicId: number,
      bottomDiatonicId: number,
      addOctaveIfEqual: boolean,
  ): number

  Parameters

  • diatonicId: number
  • bottomDiatonicId: number
  • addOctaveIfEqual: boolean

  Returns number

StaticgetAccidental

• getAccidental(accidentalSymbol: string): Accidental

  Parameters

  • accidentalSymbol: string

  Returns Accidental

StaticgetAccidentalSymbol

• getAccidentalSymbol(
      accidental: Accidental,
      symbolsSet: SymbolSet,
  ): undefined | string

  Parameters

  • accidental: Accidental
  • symbolsSet: SymbolSet

  Returns undefined | string

StaticgetChromaticClass

• getChromaticClass(chromaticId: number): number

  Parameters

  • chromaticId: number

  Returns number

StaticgetChromaticIdInOctave

• getChromaticIdInOctave(chromaticId: number, octave: number): number

  Parameters

  • chromaticId: number
  • octave: number

  Returns number

StaticgetChromaticNote

• getChromaticNote(chromaticId: number): Note

  Parameters

  • chromaticId: number

  Returns Note

StaticgetDiatonicClass

• getDiatonicClass(diatonicId: number): number

  Parameters

  • diatonicId: number

  Returns number

• getDiatonicClass(noteName: string): number

  Parameters

  • noteName: string

  Returns number

StaticgetDiatonicIdInOctave

• getDiatonicIdInOctave(diatonicId: number, octave: number): number

  Parameters

  • diatonicId: number
  • octave: number

  Returns number

StaticgetNote

• getNote(noteName: string): Note

  Parameters

  • noteName: string

  Returns Note

StaticgetNoteLetter

• getNoteLetter(diatonicId: number): NoteLetter

  Parameters

  • diatonicId: number

  Returns NoteLetter

StaticgetOctaveFromChromaticId

• getOctaveFromChromaticId(chromaticId: number): number

  Parameters

  • chromaticId: number

  Returns number

StaticgetOctaveFromDiatonicId

• getOctaveFromDiatonicId(diatonicId: number): number

  Parameters

  • diatonicId: number

  Returns number

StaticgetScientificNoteName

• getScientificNoteName(noteName: string, symbolSet: SymbolSet): string

  Parameters

  • noteName: string
  • symbolSet: SymbolSet

  Returns string

StaticisValidNoteName

• isValidNoteName(noteName: string): boolean

  Parameters

  • noteName: string

  Returns boolean

StaticparseNote

• parseNote(noteName: string): undefined | Readonly<ParsedNote>

  Parameters

  • noteName: string

  Returns undefined | Readonly<ParsedNote>

StaticremoveDuplicates

• removeDuplicates(notes: readonly Note[]): Note[]

  Remove duplicate notes.

  Parameters

  • notes: readonly Note[]

    Array of notes.

  Returns Note[]

  Sorted set of notes.

StaticreplaceAccidentalSymbols

• replaceAccidentalSymbols(str: string, symbolSet: SymbolSet): string

  Parameters

  • str: string
  • symbolSet: SymbolSet

  Returns string

Staticsort

• sort(notes: readonly Note[]): Note[]

  Sort notes by diatonicId in ascending order.

  Parameters

  • notes: readonly Note[]

    Array of notes.

  Returns Note[]

  Sorted array of notes.

StaticvalidateAccidental

• validateAccidental(acc: number): Accidental

  Parameters

  • acc: number

  Returns Accidental

StaticvalidatechromaticClass

• validatechromaticClass(chromaticClass: number): number

  Parameters

  • chromaticClass: number

  Returns number

StaticvalidateChromaticId

• validateChromaticId(chromaticId: number): number

  Parameters

  • chromaticId: number

  Returns number

StaticvalidateDiatonicClass

• validateDiatonicClass(diatonicClass: number): number

  Parameters

  • diatonicClass: number

  Returns number

StaticvalidateDiatonicId

• validateDiatonicId(diatonicId: number): number

  Parameters

  • diatonicId: number

  Returns number

StaticvalidateNoteLetter

• validateNoteLetter(note: string): NoteLetter

  Parameters

  • note: string

  Returns NoteLetter

StaticvalidateOctave

• validateOctave(octave: number): number

  Parameters

  • octave: number

  Returns number