TomTom Maps for JavaScript
    Preparing search index...

    Type Alias KnobEntry<ID, KIND>

    KnobEntry: KIND extends KnobKind
        ? {
            default?: KnobValueOf<KIND>;
            description: string;
            id: ID;
            kind: KIND;
        } & (
            KIND extends "factor"
            | "number"
            | "offset"
                ? { options?: never; range: KnobRange }
                : KIND extends "enum"
                | "enums"
                    ? { options: readonly string[]; range?: never }
                    : KIND extends "colors"
                        ? { options?: readonly string[]; range?: never }
                        : { options?: never; range?: never }
        )
        : never

    A knob catalogue entry, with what a UI or a coding agent needs to offer a knob and validate its values with no map loaded. A catalogue may add fields of its own.

    Type Parameters

    Each kind has one union member. A factor, number or offset knob always carries its range, an enum or enums knob its options, and a colors knob may carry the names it resolves.