chordsheetjs
    Preparing search index...

    Class ChordDefinition

    Represents a chord definition.

    Definitions are made using the {chord} or {define} directive. A chord definitions overrides a previous chord definition for the exact same chord.

    Index

    Properties

    Methods

    Properties

    baseFret: number

    Defines the offset for the chord, which is the position of the topmost finger. The offset must be 1 or higher.

    fingers: number[]

    defines finger settings. This part may be omitted.

    For the frets and the fingers positions, there must be exactly as many positions as there are strings, which is 6 by default. For the fingers positions, values corresponding to open or damped strings are ignored. Finger settings may be numeric (0 .. 9) or uppercase letters (A .. Z). Note that the values -, x, X, and N are used to designate a string without finger setting.

    frets: Fret[]

    Defines the string positions. Strings are enumerated from left (lowest) to right (highest), as they appear in the chord diagrams. Fret positions are relative to the offset minus one, so with base-fret 1 (the default), the topmost fret position is 1. With base-fret 3, fret position 1 indicates the 3rd position. 0 (zero) denotes an open string. Use -1, N or x to denote a non-sounding string.

    name: string

    The chord name, e.g. C, Dm, G7.

    Methods