Type Alias FretboardVoicingResult

A single chord voicing for a fretted instrument. Compatible with notae's FretboardChord — spread with name to render directly.

const voicings = getFretboardVoicings(chord, GUITAR_STANDARD);
renderFretboard({ name: chord.name, ...voicings[0] });

type FretboardVoicingResult = {
    baseFret: number;
    frets: number[];
    root: string;
    stringOffset?: number[];
    tuning: string[];
}

Properties

baseFret: number

Absolute fret of the first displayed fret. 1 in open position or when lowest fret is 1.

frets: number[]

One fret per string, low→high. -1 = mute (×), stringOffset[i] = open (○), N = fret N.

root: string

Root note name (e.g. 'C', 'F#').

stringOffset?: number[]

Per-string fret offset, echoed from options. Present only when offset was supplied.

tuning: string[]

Open-string note names, low→high (e.g. ['E','A','D','G','B','E']).