tonic.ts

Index

Modules

Intervals

Enumerations

IntervalQuality

Classes

Interfaces

Functions

Object literals

Instruments

Functions

allFrettings

allFrettings(chordOrName: Chord<Note> | string, options?: Partial<FrettingOptions>): FrettedChord[]

- Defined in fretting.ts:54
Return frettings, sorted by default properties.

Parameters
- chordOrName: Chord<Note> | string
- Default value options: Partial<FrettingOptions> = defaultFrettingOptions
Returns FrettedChord[]

asInterval

asInterval(n: Interval | number): Interval

- Defined in Interval.ts:222
Parameters
- n: Interval | number
Returns Interval

asPitchLike

asPitchLike(pitch: string | PitchLike): PitchLike

- Defined in PitchLike.ts:16
Convert a string into a Note or [PitchClass]]. This is idempotent on instances Note and PitchClass.

Parameters
- pitch: string | PitchLike
Returns PitchLike

chordFromRomanNumeral

chordFromRomanNumeral<T>(name: string, scale: Key<T>): Chord<T>

- Defined in chordProgressions.ts:20
Type parameters
- T: PitchLike
Parameters
- name: string
- scale: Key<T>
Returns Chord<T>

frettingFor

frettingFor(chord: Chord<Note> | string, options?: Partial<FrettingOptions>): FrettedChord | null

- Defined in fretting.ts:46
Return best fretting, sorted by default properties.

Parameters
- chord: Chord<Note> | string
- Default value options: Partial<FrettingOptions> = defaultFrettingOptions
Returns FrettedChord | null

intervalClassDifference

intervalClassDifference(a: number, b: number): number

- Defined in Interval.ts:290
Parameters
- a: number
- b: number
Returns number

parsePitchLike

parsePitchLike(name: string): PitchLike

- Defined in PitchLike.ts:23
Parse a string as a Note or PitchClass. In case of ambiguity (e.g. "E"), prefer PitchClass.

Parameters
- name: string
Returns PitchLike

Object literals

Const Instruments

Instruments: object

Cello

Cello: StringInstrument = new StringInstrument('Cello', 'C G D A')

Guitar

Guitar: FrettedInstrument = new FrettedInstrument('Guitar', 'E2 A2 D3 G3 B3 E4', 12)

Viola

Viola: StringInstrument = new StringInstrument('Viola', 'C G D A')

Violin

Violin: StringInstrument = new StringInstrument('Violin', 'G D A E')

Generated using TypeDoc