Universal Music Theory Library - v0.12.0
    Preparing search index...

    Type Alias FretboardScaleResult

    Scale notes mapped to fretboard positions. Compatible with notae's FretboardChord — spread with name to render directly.

    const map = getFretboardScale(scale, GUITAR_STANDARD);
    renderFretboard({ name: scale.name, ...map });
    type FretboardScaleResult = {
        baseFret: number;
        degrees: number[][];
        frets: number[][];
        root: string;
        stringOffset?: number[];
        tuning: string[];
    }
    Index

    Properties

    baseFret degrees frets root stringOffset? tuning

    Properties

    baseFret: number

    1 for a full-neck map, or the starting fret for a position box.

    degrees: number[][]

    Per string, parallel to frets: the scale degree of each note (1 = the root).

    frets: number[][]

    Per string: all fret positions where a scale note appears. Empty array = no scale notes on this string.

    root: string

    Root note name: the scale's written root when it names the root's pitch (F# lydian → 'F#').

    stringOffset?: number[]

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

    tuning: string[]

    Open-string note names, low→high.

    Settings

    Member Visibility

    On This Page

    Properties