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

    Interface OrderSettings

    How order cards are made.

    interface OrderSettings {
        clef: Clef;
        content: ContentKind;
        count: number;
        direction: "ascending" | "descending";
        highestMidi: number;
        keyboardLowestMidi: number;
        keyboardOctaves: number;
        letters?: readonly Step[];
        letterStart?: Step;
        lowestMidi: number;
        maxAccidentals: number;
        symbols: readonly MusicSymbol[];
        terms: Readonly<Record<string, MusicTerm>>;
        values: readonly NoteValue[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    clef: Clef

    For notes and piano keys

    content: ContentKind
    count: number

    Things to put in order

    direction: "ascending" | "descending"
    highestMidi: number
    keyboardLowestMidi: number
    keyboardOctaves: number
    letters?: readonly Step[]

    For letters: the letters to draw from (default: all seven, A to G)

    letterStart?: Step

    For letters: where the musical alphabet starts, so going forwards from 'C' runs C D E F G A B, round from G to A; going backwards (an order descending, a hop descending) runs from it the other way. An order starts from 'A' forwards and 'G' backwards unless told otherwise; a hop along the alphabet starts on a letter drawn from letters

    lowestMidi: number
    maxAccidentals: number

    For key signatures: the most sharps or flats

    symbols: readonly MusicSymbol[]

    For symbols

    terms: Readonly<Record<string, MusicTerm>>

    For terms

    values: readonly NoteValue[]

    For note values