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

    Class FretPosition

    Fret position props.

    Index

    Constructors

    constructor

    Properties

    borderColor chromaticId fillColor fretId guitarCtx isBarre isScaleNote isScaleRootNote isVisible note stringId text textColor

    Accessors

    chromaticClass

    Methods

    hide setDefaultBorderColor setDefaultFillColor setDefaultText show

    Constructors

    • Create new fret position object instance.

      Parameters

      • guitarCtx: GuitarContext

        Guitar context.

      • stringId: number

        String index in range [0, 5].

      • fretId: number

        Fret index, 0 = open string fret position.

      • chromaticId: number

        Chromatic id.

      Returns FretPosition

    Properties

    borderColor: undefined | string

    Border color of note circle.

    chromaticId: number

    Chromatic id.

    fillColor: undefined | string

    Fill color of note circle.

    fretId: number

    Fret index, 0 = open string fret position.

    guitarCtx: GuitarContext

    Guitar context.

    isBarre: boolean = false

    Is barre? (Reserved for future)

    isScaleNote: boolean

    Is note of this fret position a scale note?

    isScaleRootNote: boolean

    Is note of this fret position a scale root note?

    isVisible: boolean = false

    Is note circle/text of this fret position visible?

    note: Note

    Note of this fret position.

    stringId: number

    String index in range [0, 5].

    text

    text: string = ""

    Text (e.g. note name) of this fret position.

    textColor: string = DefaultColors.TextColor

    Text color.

    Accessors

    • get chromaticClass(): number

      Chromatic class getter.

      Returns number

    Methods

    • Hide note circle/text of this fret position.

      Returns void

    • Set default border color of note circle.

      Parameters

      • showBorder: boolean = false

      Returns void

    • Set default fill color of note circle.

      Returns void

    • Set default note name.

      Returns void

    • Show note circle/text of this fret position.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods