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

    Type Alias AlongRouteSortBy

    AlongRouteSortBy: "detourTime" | "detourOffset"

    Result sorting order for along-route search.

    Controls how the returned POIs are ordered relative to the route.

    Pass these to search, which selects the request variant from the params it is given: a route property dispatches to along-route search, a geometries property to geometry search, and neither to fuzzy search. alongRouteSearch is also exported directly.

    • detourTime: Sort by additional travel time required to visit the POI (default)
    • detourOffset: Sort by how far along the route the detour point falls