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

    Interface KeyboardNoteIdSettings

    How find-the-key cards are made: a note on the staff, its key to tap.

    interface KeyboardNoteIdSettings {
        accidentals?: boolean;
        anyOctave: boolean;
        clef: Clef;
        halfStep?: "both" | "up" | "down";
        highestMidi: number;
        keyboardLowestMidi: number;
        keyboardOctaves: number;
        lowestMidi: number;
        spelling?: AccidentalSpelling;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accidentals?: boolean

    Notes with a sharp or a flat too: each black key in the range is asked both ways (C♯ and D♭), its sharp or flat written before the note, and the black key is the one to tap (default: false — naturals only)

    anyOctave: boolean

    Whether the same letter in any octave is right (default: false)

    clef: Clef
    halfStep?: "both" | "up" | "down"

    Ask for the key a half step from the note shown, not the note's own key: 'up' the very next key to the right, 'down' the very next key to the left, 'both' either, drawn evenly card by card. The very next key may be black or white — a half step up from E is F. Both the note's key and the key to tap are on the keyboard (default: none — the note's own key)

    highestMidi: number
    keyboardLowestMidi: number

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

    keyboardOctaves: number

    Octaves shown (default: 2)

    lowestMidi: number

    With accidentals, how the black keys are written: as sharps only, as flats only, or both ways (default: 'both')