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

    Type Alias WaypointsConfig

    How the module draws the waypoints RoutingModule.showWaypoints is given.

    Each setting reaches the waypoints already shown.

    type WaypointsConfig = {
        entryPoints?: GetPositionEntryPointOption;
        highlight?: WaypointHighlightConfig;
        icon?: WaypointIconConfig;
        label?: WaypointLabelConfig;
        stopNumbering?: WaypointStopNumbering;
    }
    Index
    entryPoints? highlight? icon? label? stopNumbering?
    entryPoints?: GetPositionEntryPointOption

    Controls how entry points are used when displaying waypoints on the map.

    Entry points represent the actual navigable entrance to a location, which may differ from the geometric center coordinates.

    Available options:

    • main-when-available - Uses the main entry point coordinates when available, falling back to the waypoint coordinates
    • ignore - Always uses the original waypoint coordinates

    "ignore"

    highlight?: WaypointHighlightConfig

    How a hovered or clicked waypoint is drawn.

    icon?: WaypointIconConfig

    The waypoint pins, per role, and an optional icon per waypoint picked from its data.

    label?: WaypointLabelConfig

    The waypoint labels: whether they show, what they say and how they look.

    stopNumbering?: WaypointStopNumbering

    How the stops between origin and destination are marked inside their pin.

    "numbers"

    Settings
    Member Visibility

    On This Page
    Properties