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

    Interface IntervalIdSettings

    How interval cards are made: what @hiyve/music-theory asks, read from the staff, with two choices of its own.

    interface IntervalIdSettings {
        accidentals: boolean;
        ask?: IntervalAsk;
        asked?: readonly string[];
        choiceCount: number;
        clef: Clef;
        generic: boolean;
        halfWhole?: boolean;
        highestMidi: number;
        intervals: IntervalName[];
        lowestMidi: number;
        melodic: boolean;
        naturalsOnly: boolean;
    }

    Hierarchy

    Index

    Properties

    accidentals: boolean

    Start from sharps and flats as well as naturals

    What is asked (default: 'interval', the interval between the notes). 'shape' asks how the two notes are written instead: one after the other, a melodic interval, or together, a harmonic one — each card drawn either way, its two notes any interval of intervals, the choices always 'melodic' then 'harmonic'

    asked?: readonly string[]

    Only these answers are asked — numbers ('6') when generic, codes ('M6') otherwise — the others still offered as choices

    choiceCount: number
    clef: Clef
    generic: boolean

    Ask for the interval's number alone — a 3rd, not a major 3rd — with the numbers to choose from (default: true). Otherwise the quality is asked too, as @hiyve/music-theory does

    halfWhole?: boolean

    Name a 2nd as a half step (m2) or a whole step (M2), not by its number or quality — for a player who has met half and whole steps but not interval quality. The quality is then asked (generic is not consulted), intervals may hold only m2 and M2, and the choices are always the half step first, then the whole step (default: false)

    highestMidi: number

    Highest note written, as a MIDI number

    intervals: IntervalName[]

    The intervals asked; the choices are drawn from them too

    lowestMidi: number

    Lowest note written, as a MIDI number

    melodic: boolean

    The two notes one after the other, rather than together

    naturalsOnly: boolean

    Only intervals whose both notes are naturals, so no sharp or flat is drawn (default: true)