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

    Type Alias SectionIconConfig

    The icon drawn on a route section.

    Backed by a symbol layer over the section's own source: the generated section types get one added, and the types that already draw an icon (ferry, tollRoad) have theirs replaced.

    type SectionIconConfig = {
        image: string;
        placement?: "center" | "along";
        sizeFactor?: number;
    }
    Index
    image placement? sizeFactor?
    image: string

    The id of an image in the loaded style's sprite, e.g. poi-toll_plaza. An id the sprite does not carry draws nothing.

    placement?: "center" | "along"

    Where the icon sits on the section.

    • center: one icon at the middle of each section.
    • along: icons repeated along the section.

    "center" on the generated types; the bespoke types that draw an icon keep their own placement.

    sizeFactor?: number

    Icon scale, where 1 is the sprite image's own size. Clamped to SECTION_ICON_SIZE_FACTOR_RANGE, 0.25 to 2.

    1 on the generated types; the bespoke types that draw an icon keep their own zoom-ramped size.

    Settings
    Member Visibility

    On This Page
    Properties