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

    Type Alias MapEffectsKnobDescriptor

    MapEffectsKnobDescriptor: KnobDescriptor<EffectKnobValueOf<EffectKnobId>> & {
        appliesTo: string;
        available: boolean;
        id: EffectKnobId;
        range?: EffectKnobRange;
        useCase: string;
    }

    One entry of the effects catalogue: the SDK's shared KnobDescriptor, narrowed the way StylingKnobDescriptor narrows it, plus the use case the effect serves.

    Type Declaration

    • appliesTo: string

      Always any-style, for the same reason.

    • available: boolean

      Always true: an effect reads the rendered pixels, so it has something to work on anywhere.

    • id: EffectKnobId

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

    • Optionalrange?: EffectKnobRange

      The range of valid values, for a numeric knob.

    • useCase: string

      The practical problem the effect solves.

    Settings
    Member Visibility