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

    Interface ChordNameSettings

    How chord-name cards are made.

    interface ChordNameSettings {
        choiceCount: number;
        clef: Clef;
        highestMidi: number;
        keys: readonly string[];
        lowestMidi: number;
        namings: readonly ChordNaming[];
        numerals: readonly string[];
        symbols: readonly string[];
    }
    Index

    Properties

    choiceCount: number

    Names to choose from, the right one among them: the chords asked, lowest root first (default: 3)

    clef: Clef
    highestMidi: number

    The highest note of a chord

    keys: readonly string[]

    numeral: the keys a chord is named in, as 'C:major' codes; a minor key's 7th note is raised in its V, V7 and vii° (default: C, G and F major)

    lowestMidi: number

    The lowest note a chord's root may be, as a MIDI number

    namings: readonly ChordNaming[]

    The namings asked, one drawn per card (default: 'symbol')

    numerals: readonly string[]

    numeral: the numerals asked — upper case for a major chord, lower case for a minor one, ° for a diminished one: 'I', 'ii', 'IV', 'V', 'V7', 'vii°' in a major key, 'i', 'iv', 'V', 'VI' in a minor one (default: I, IV and V); a numeral whose chord needs a note the key does not spell ('vi' in a minor key) is skipped

    symbols: readonly string[]

    symbol: the chords to draw, by symbol — a root with an optional ♯ or ♭, then nothing for major, m for minor, 7 for a dominant 7th or dim for diminished: 'C', 'F♯m', 'G7' (default: C, F and G)