guitar-scales 1.0.0 | Documentation

guitar-scales

1.0.0

GuitarScale ▸
- Static members
- .getNames
- .getNotesPerString
- .getScalePerString
- .setTuning
- .get
Print
Structs ▸
- Static members
- .GuitarAllStrings
- .GuitarFretzInfo
- .PrintSegments
Tuning

Need help reading this?

GuitarScale

Create a new GuitarScale

new GuitarScale()

Properties

tuning (Tuning)

Static Members

▸ getNames()

getNames(): array

Returns

array: The list of supported scales

Example

console.log(GuitarScale.getNames()) //['ionian', 'aeolian', 'minor', '...']

▸ getNotesPerString(noteString)

Get the notes per String

getNotesPerString(noteString: String): array

Parameters

noteString

(String
            = E)

The first note of the string, this note represent the string at 0 fret

Returns

array: ["E", "F", "F#", "G", "G#", "A", "A#", "B"] - The notes ordered per fret

▸ getScalePerString(scale, stringNotes)

Get specific scale per string

getScalePerString(scale: Array, stringNotes: Array)

Parameters

scale (Array)

stringNotes (Array)

▸ setTuning(tuning)

Sets specific tuning to the object

setTuning(tuning: any)

Parameters

tuning (any)

▸ get(note, scaleName, allNeck, altTuning)

Get the scale that you wants

get(note: String, scaleName: String, allNeck: bool, altTuning: Array): GuitarAllStrings

Parameters

note (String) [note=c] The first note for your scale

scaleName (String) [scaleName=ionian] The name of the scale that you wants to get

allNeck

(bool
            = false)

Flag for get all neck or only the half of neck notes

altTuning

(Array
            = null)

[tuning= [D,A,D,G,B,E] ] If you want extra tunning you can describe here

Returns

GuitarAllStrings: GuitarAllStrings

Print

Structs

Static Members

▸ GuitarAllStrings

GuitarAllString

GuitarAllStrings

Type: Object

Properties

info (string)

Tuning (Tuning)

▸ new GuitarFretzInfo()

GuitarFretzInfo

new GuitarFretzInfo()

Static Members

▸ get(note, noteEnharmonic, freet, isPartOfScale, scalePosition)

get(note: string, noteEnharmonic: string, freet: number, isPartOfScale: bool, scalePosition: number)

Parameters

note (string) Note

noteEnharmonic (string) Note Enharmonic

freet (number) Freet Number

isPartOfScale

(bool
            = false)

Flag for identify if the fret is part of the scale

scalePosition

(number
            = null)

Interval value in the sc

▸ new PrintSegments()

new PrintSegments()

Tuning

Tunning

Tuning