Class Key<T>

A Key<PitchLike> is a scale that starts at a specific tonic.

Wikipedia musical key

Type parameters

T: PitchLike

Hierarchy

GenericScale<T>
- Key

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Key(options: ScaleConstructorOptions<T>): Key

Overrides GenericScale.__constructor
- Defined in Scale.ts:127
Parameters
- options: ScaleConstructorOptions<T>
Returns Key

Properties

intervals

intervals: ReadonlyArray<Interval>

modes

modes: ReadonlyArray<Scale> = []

name

name: string

notes

notes: ReadonlyArray<T>

parent

parent: Scale | null

For a minor scale, this is the relative major. For a mode, it's the deriving scale.

pitchClasses

pitchClasses: ReadonlyArray<number>

tonic

tonic: T

Methods

at

at(tonic: string): Key<PitchLike>
at<T>(tonic: T): Key<T>

Inherited from GenericScale.at
- Defined in Scale.ts:63
Return a specific scale of the same scale class, at the specified tonic.

Parameters
- tonic: string
Returns Key<PitchLike>
Inherited from GenericScale.at
- Defined in Scale.ts:64
Type parameters
- T: PitchLike
Parameters
- tonic: T
Returns Key<T>

chords

chords(options?: object): Array<Chord<PitchLike>>

- Defined in Scale.ts:137
Parameters
- Default value options: object = {}
Returns Array<Chord<PitchLike>>

fromRomanNumeral

fromRomanNumeral(name: string): Chord<T>

- Defined in Scale.ts:157
Parameters
- name: string
Returns Chord<T>

progression

progression(names: string): Array<Chord<T>>

- Defined in Scale.ts:153
Parameters
- names: string
Returns Array<Chord<T>>

Static fromString

fromString(name: string): Key<PitchLike>

- Defined in Scale.ts:114
Parameters
- name: string
Returns Key<PitchLike>

Generated using TypeDoc