Hiyve Components - v1.0.0
    Preparing search index...

    Interface ChordBuildSettings

    How build-a-chord cards are made.

    interface ChordBuildSettings {
        accidentals: boolean;
        keyboardLowestMidi: number;
        keyboardOctaves: number;
        qualities: readonly ChordQuality[];
        roots: readonly string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    accidentals: boolean

    Roots on black keys too, when no roots are given, each named as its chord usually is — as a sharp or a flat, whichever spells the chord with fewer of them: D♭ major, C♯ minor (default: false)

    keyboardLowestMidi: number

    The lowest key, a C (default: 60, middle C)

    keyboardOctaves: number

    Octaves shown (default: 2)

    qualities: readonly ChordQuality[]
    roots: readonly string[]

    The roots to draw from, by name — a letter with an optional sharp or flat: 'C', 'F♯' or 'F#', 'B♭' or 'Bb' — each spelled as written, so 'D♭' asks for D♭ major, never C♯ major. Every root is paired with every quality. When given, accidentals is not consulted (default: none — every white-key root, and the black-key roots with accidentals)