Class Scale

Hierarchy (View Summary)

KeySignature
- Scale

Constructors

constructor

new Scale(tonic: string, scaleType: ScaleType): Scale
Parameters
- tonic: string
- scaleType: ScaleType
Returns Scale
Overrides KeySignature.constructor

Properties

`Readonly`mode

mode: Mode

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

`Readonly`scaleType

scaleType: ScaleType

`Readonly`tonic

tonic: string

Tonic/root note.

Methods

getAccidental

getAccidental(diatonicId: number): Accidental
Parameters
- diatonicId: number
Returns Accidental
Inherited from KeySignature.getAccidental

getAccidentalType

getAccidentalType(): AccidentalType
Returns AccidentalType
Inherited from KeySignature.getAccidentalType

getIntervalFromRootNote

getIntervalFromRootNote(note: Note): Interval
Parameters
- note: Note
Returns Interval

getNaturalScaleNotes

getNaturalScaleNotes(): readonly Note[]
Returns readonly Note[]
Inherited from KeySignature.getNaturalScaleNotes

getNoteByDegree

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

getNumAccidentals

getNumAccidentals(): number
Returns number
Inherited from KeySignature.getNumAccidentals

getOrderedAccidentalNotes

getOrderedAccidentalNotes(): readonly Note[]
Returns readonly Note[]
Inherited from KeySignature.getOrderedAccidentalNotes

getPreferredChromaticNote

getPreferredChromaticNote(chromaticId: number): Note
Parameters
- chromaticId: number
Returns Note

getScaleName

getScaleName(symbolSet?: SymbolSet): string
Parameters
- OptionalsymbolSet: SymbolSet
Returns string

getScaleNotes

getScaleNotes(bottomNote: string, numOctaves: number): Note[]
Parameters
- bottomNote: string
- numOctaves: number
Returns Note[]

getScaleOverview

getScaleOverview(): string
Returns string

getScaleSteps

getScaleSteps(): number[]
Returns number[]

getScaleStringSteps

getScaleStringSteps(): string[]
Returns string[]

isScaleNote

isScaleNote(note: Note): boolean
Parameters
- note: Note
Returns boolean

isScaleRootNote

isScaleRootNote(note: Note): boolean
Parameters
- note: Note
Returns boolean

`Static`equals

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