Class FretboardSystem

Index

Constructors

Methods

getFretCount getPositionAt getScale getTuning

Constructors

constructor

new FretboardSystem(params?: FretboardSystemParams): FretboardSystem
Creates a FretboardSystem instance.
Parameters
- Optionalparams: FretboardSystemParams
  The accepted params
Returns FretboardSystem
- Defined in packages/fretboard/src/fretboardSystem/FretboardSystem.ts:52

Methods

getFretCount

getFretCount(): number
Returns the instance fret count

Returns number
The instance fret count
- Defined in packages/fretboard/src/fretboardSystem/FretboardSystem.ts:73

getPositionAt

getPositionAt(position: BareFretboardPosition): SystemPosition | null
Returns the position information at the given string and fret
Parameters
- position: BareFretboardPosition
Returns SystemPosition | null
The found position
- Defined in packages/fretboard/src/fretboardSystem/FretboardSystem.ts:82

getScale

getScale(__namedParameters: ScaleParams): FretboardPosition[]
Returns the position information for the passed scale parameters.
Parameters
- __namedParameters: ScaleParams
  The expected parameters
Returns FretboardPosition[]
The scale positions
- Defined in packages/fretboard/src/fretboardSystem/FretboardSystem.ts:93

getTuning

getTuning(): Tuning
Returns the instance tuning

Returns Tuning
The instance tuning
- Defined in packages/fretboard/src/fretboardSystem/FretboardSystem.ts:65