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

    Interface ScaleDegreeSettings

    How scale-degree cards are made.

    interface ScaleDegreeSettings {
        choiceCount: number;
        clef: Clef;
        degrees: readonly number[];
        findOn: "keyboard" | "staff";
        highestMidi: number;
        keyboardLowestMidi: number;
        keyboardOctaves: number;
        keys: readonly string[];
        lowestMidi: number;
        mode: ScaleDegreeMode;
        numbersOnly?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    choiceCount: number

    name: degrees to choose from, the right one among them, always in order 1 to 7; the degrees asked come first, then their neighbours (default: 2)

    clef: Clef
    degrees: readonly number[]

    The degrees asked, 1 (the tonic) to 7: 5 is the dominant (default: 1 and 5)

    findOn: "keyboard" | "staff"

    find: whether the note is tapped on the keyboard or placed on the staff (default: 'keyboard')

    highestMidi: number

    name: the highest note shown; find on the staff, the highest a note can be placed

    keyboardLowestMidi: number

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

    keyboardOctaves: number

    Octaves shown (default: 2)

    keys: readonly string[]

    The keys asked in, as 'G:major' codes — any major or minor key of up to seven sharps or flats; a minor key's 7th is its raised 7th, the harmonic minor's (default: C, G and F major)

    lowestMidi: number

    name: the lowest note shown, and find on the staff the lowest a note can be placed, as a MIDI number

    Name the degree of a note shown, or find the note of a degree named (default: 'name')

    numbersOnly?: boolean

    Ask by number alone, in the scale from the key's first note — "which number is this note in the scale from C?" — never naming the key, the tonic or the dominant: for a player who has met a scale and its numbers but not keys (default: false)