@tspro/web-music-score
    Preparing search index...

    Class GuitarContext

    Guitar context class.

    Index

    Constructors

    Properties

    guitarNoteLabel: GuitarNoteLabel

    Guitar note label type.

    handedness: Handedness

    Handedness.

    maxFretId: number

    Maximum fret index value.

    pitchNotation: PitchNotation

    Pitch notation.

    scale: Scale

    Scale.

    tuningName: string

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

    Methods

    • Create copy of this guitar context with new tuning name.

      Parameters

      • tuningName: string

        New tuning name.

      Returns GuitarContext

      • Guitar context.
    • 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.
    • Get tuning value (Note) of given string.

      Parameters

      • stringId: number

        STring index in range [0, 5].

      Returns Note

      • Note of given string played unfretted.
    • Get tuning overview (e.g. "E2 - A2 - D3 - G3 - B3 - E4").

      Returns string

      • Tuning overview string.