Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FrettedChord

Also known as “guitar chords”; but generalized to fretted instruments.

See guitar chord.

Hierarchy

  • FrettedChord

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

barres

barres: ReadonlyArray<Barre>

chord

chord: Chord<PitchLike>

instrument

instrument: FrettedInstrument

positions

positions: ReadonlyArray<ChordFret>

properties

properties: Readonly<object>

Accessors

ascii

  • get ascii(): string

  • A string representation of open, fretted, and muted strings. For example, 'x02440'.

    This representation doesn't represent barres.

    Returns string

fingerCount

  • get fingerCount(): number

  • How many fingers does the fretting require? For an un-barred fretting, this is just the number of fretted strings.

    Returns number

intervals

notes

  • get notes(): Note[]

Methods

Static fromAscii

  • Create a FrettedChord from an ASCII chord description, e.g. 'x02440'.

    For all valid ASCII chord descriptions desc, FrettedChord.fromAscii(desc).ascii === desc.

    For all FrettedChords chord with no barres, assert.deepStrictEqual(FrettedCord.fromAscii(chord.ascii), chord).

    Parameters

    Returns FrettedChord

Generated using TypeDoc