TomTom Maps SDK for JavaScript
This is the documentation of version 0.58.1. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias StylingKnob

    One entry of stylingKnobCatalogue: what a UI or a coding agent needs to offer the knob and validate a value for it, with no map loaded. The value in force is StylingModule.get.

    type StylingKnob = {
        appliesTo: StylingKnobAppliesTo;
        description: string;
        id: StylingKnobId;
        kind: StylingKnobKind;
        options?: readonly string[];
        range?: StylingKnobRange;
    }
    Index
    appliesTo description id kind options? range?
    appliesTo: StylingKnobAppliesTo

    Which styles the knob works on; see stylingKnobAppliesTo.

    description: string

    One line on what turning the knob does.

    id: StylingKnobId

    The knob's id, as accepted by StylingModule.set.

    kind: StylingKnobKind
    options?: readonly string[]

    The valid values, for enum knobs.

    range?: StylingKnobRange

    The range of valid values, for factor and number knobs.

    Settings
    Member Visibility

    On This Page
    Properties