Class GuitarContext

constructor

• new GuitarContext(
      tuningName: string,
      scale: Scale,
      handedness: Handedness,
      pitchNotation: PitchNotation,
      guitarNoteLabel: GuitarNoteLabel,
  ): GuitarContext

  Create new guitar context object instance.

  Parameters

  • tuningName: string

    Tuning name (e.g. "Standard").

  • scale: Scale

    Scale.

  • handedness: Handedness

    Handedness.

  • pitchNotation: PitchNotation

    Pitch notation.

  • guitarNoteLabel: GuitarNoteLabel

    Guitar note label type.

  Returns GuitarContext

ReadonlyguitarNoteLabel

Readonlyhandedness

ReadonlymaxFretId

ReadonlypitchNotation

Readonlyscale

ReadonlytuningName

alterGuitarNoteLabel

• alterGuitarNoteLabel(guitarNoteLabel: GuitarNoteLabel): GuitarContext

  Create copy of this guitar context with new guitar note label type.

  Parameters

  • guitarNoteLabel: GuitarNoteLabel

    New guitar note label type.

  Returns GuitarContext

  • Guitar context.

alterHandedness

• alterHandedness(handedness: Handedness): GuitarContext

  Create copy of this guitar context with handedness.

  Parameters

  • handedness: Handedness

    New handedness.

  Returns GuitarContext

  • Guitar context.

alterPitchNotation

• alterPitchNotation(pitchNotation: PitchNotation): GuitarContext

  Create copy of this guitar context with new pitch notation.

  Parameters

  • pitchNotation: PitchNotation

    New pitch notation.

  Returns GuitarContext

  • Guitar context.

alterScale

• alterScale(scale: Scale): GuitarContext

  Create copy of this guitar context with new scale.

  Parameters

  • scale: Scale

    New scale.

  Returns GuitarContext

  • Guitar context.

alterTuningName

• alterTuningName(tuningName: string): GuitarContext

  Create copy of this guitar context with new tuning name.

  Parameters

  • tuningName: string

    New tuning name.

  Returns GuitarContext

  • Guitar context.

getFretPosition

• getFretPosition(stringId: number, fretId: number): Readonly<FretPosition>

  Get fret position object.

  Parameters

  • stringId: number

    String index in range [0,5].

  • fretId: number

    Fret index, 0 = open string fret position.

  Returns Readonly<FretPosition>

  • Fret position object.

getStringTuning

• getStringTuning(stringId: number): Note

  Get tuning value (Note) of given string.

  Parameters

  • stringId: number

    STring index in range [0, 5].

  Returns Note

  • Note of given string played unfretted.

getTuningOverview

• getTuningOverview(): string

  Get tuning overview (e.g. "E2 - A2 - D3 - G3 - B3 - E4").

  Returns string

  • Tuning overview string.