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

    Interface HopSettings

    How hop cards are made.

    interface HopSettings {
        clef: Clef;
        content: ContentKind;
        direction?: "ascending" | "descending";
        extraPads: number;
        highestMidi: number;
        keyboardLowestMidi: number;
        keyboardOctaves: number;
        length: number;
        letters?: readonly Step[];
        letterStart?: Step;
        lowestMidi: number;
        maxAccidentals: number;
        sequence: "word" | "scale" | "ascendingValues" | "alphabet";
        symbols: readonly MusicSymbol[];
        terms: Readonly<Record<string, MusicTerm>>;
        values: readonly NoteValue[];
        words: readonly string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    clef: Clef

    For notes and piano keys

    content: ContentKind
    direction?: "ascending" | "descending"

    Which way an alphabet run goes: forwards (default) or backwards

    extraPads: number

    Pads that are not on the way (none for 'ascendingValues', where any other value would be on the way too)

    highestMidi: number
    keyboardLowestMidi: number
    keyboardOctaves: number
    length: number

    Steps in a scale, an ascending run or an alphabet run (an alphabet run is at most seven, each letter once)

    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

    sequence: "word" | "scale" | "ascendingValues" | "alphabet"

    What the steps are: a word to spell (notes), a scale up from its start (notes or keys), values from shortest to longest, or — with letters content — the musical alphabet in a row from letterStart, round from G to A (backwards with direction: 'descending')

    symbols: readonly MusicSymbol[]

    For symbols

    terms: Readonly<Record<string, MusicTerm>>

    For terms

    values: readonly NoteValue[]

    For note values

    words: readonly string[]

    Words for 'word', letters A to G