Class Fretboard

constructor

• new Fretboard(options?: Partial<FretboardOptions>): Fretboard

  Creates a Fretboard instance.

  Parameters

  • Optionaloptions: Partial<FretboardOptions>

    The accepted options

  Returns Fretboard

frets

grid

strings

svg

wrapper

clear

• clear(): Fretboard

  Clears the current positions

  Returns Fretboard

  The current Fretboard instance.

clearHighlightAreas

• clearHighlightAreas(): Fretboard

  Clears all the current highlight areas.

  Returns Fretboard

  The current Fretboard instance.

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.

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.

muteStrings

• muteStrings(params: MuteStringsParams): Fretboard

  Marks the passed strings as muted.

  Parameters

  • params: MuteStringsParams

    The expected parameters.

  Returns Fretboard

  The current Fretboard instance.

render

• render(): Fretboard

  Renders the fretboard with the current positions.

  Returns Fretboard

  The current Fretboard instance

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.

renderScale

• renderScale(__namedParameters: ScaleParams): Fretboard

  Renders the positions of the passed scale.

  Parameters

  • __namedParameters: ScaleParams

    The expected parameters.

  Returns Fretboard

  The current Fretboard instance.

setPositions

• setPositions(positions: FretboardPosition[]): Fretboard

  Sets the current positions

  Parameters

  • positions: FretboardPosition[]

    The positions to be set.

  Returns Fretboard

  The current Fretboard instance.

style

• style(__namedParameters: StyleParams): Fretboard

  Controls all the style parameters.

  Parameters

  • __namedParameters: StyleParams

    The expected parameters.

  Returns Fretboard

  The current Fretboard instance.