Class Fretboard

Index

Constructors

Properties

frets grid strings svg wrapper

Methods

clear clearHighlightAreas getChordPositions highlightAreas muteStrings render renderChord renderScale setPositions style

Constructors

constructor

new Fretboard(options?: Partial<FretboardOptions>): Fretboard
Creates a Fretboard instance.
Parameters
- options: Partial<FretboardOptions> = {}
  The accepted options
Returns Fretboard
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:291

Properties

frets

frets: number[]

grid

grid: Point[][]

strings

strings: number[]

svg

svg: Selection<SVGSVGElement, FretboardPosition, HTMLElement, FretboardPosition>

wrapper

wrapper: Selection<
    SVGGElement,
    FretboardPosition,
    HTMLElement,
    FretboardPosition,
>

Methods

clear

clear(): Fretboard
Clears the current positions

Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:447

clearHighlightAreas

clearHighlightAreas(): Fretboard
Clears all the current highlight areas.

Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:650

getChordPositions

getChordPositions(
params: Pick<RenderChordParams, "input" | "chordName">,
): FretboardPosition[]
Returns the chord positions and corresponding note names in the given system context.
Parameters
- params: Pick<RenderChordParams, "input" | "chordName">
  The expected parameters.
Returns FretboardPosition[]
The positions for the passed input.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:542

highlightAreas

highlightAreas(
...areas: [BareFretboardPosition, BareFretboardPosition][],
): Fretboard
Highlight the passed fretboard ares
Parameters
- ...areas: [BareFretboardPosition, BareFretboardPosition][]
  An array of [FretboardPosition, FretboardPosition] tuples
Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:580

muteStrings

muteStrings(params: MuteStringsParams): Fretboard
Marks the passed strings as muted.
Parameters
- params: MuteStringsParams
  The expected parameters.
Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:487

render

render(): Fretboard
Renders the fretboard with the current positions.

Returns Fretboard
The current Fretboard instance
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:353

renderChord

renderChord(__namedParameters: RenderChordParams): Fretboard
Renders a chord diagram (i.e. a cropped fretboard with just the chord positions)
Parameters
- __namedParameters: RenderChordParams
  The expected parameters.
Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:523

renderScale

renderScale(__namedParameters: ScaleParams): Fretboard
Renders the positions of the passed scale.
Parameters
- __namedParameters: ScaleParams
  The expected parameters.
Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:556

setPositions

setPositions(positions: FretboardPosition[]): Fretboard
Sets the current positions
Parameters
- positions: FretboardPosition[]
  The positions to be set.
Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:438

style

style(__namedParameters: StyleParams): Fretboard
Controls all the style parameters.
Parameters
- __namedParameters: StyleParams
  The expected parameters.
Returns Fretboard
The current Fretboard instance.
- Defined in packages/fretboard/src/fretboard/Fretboard.ts:458