TomTom Maps for JavaScript
    Preparing search index...

    Type Alias WaypointProps

    Properties specific to route waypoints.

    type WaypointProps = {
        radiusMeters?: number;
    }
    Index

    Properties

    radiusMeters?

    Properties

    radiusMeters?: number

    Radius in meters defining a circle (soft) waypoint.

    When specified, the waypoint becomes a circle waypoint that shapes the route without generating explicit navigation instructions or creating an additional route leg.

    • Circle waypoints influence the route path while providing flexibility to the routing engine
    • Larger radius values give more freedom for route optimization
    • Smaller radius values force the route to pass closer to the specified point
    • Unlike regular waypoints, circle waypoints don't create legs or generate "arrive at waypoint" instructions
    • Useful for shaping routes through general areas rather than specific points

    Must be a positive integer with a maximum value of 135000.

    // Circle waypoint with 1km radius - route will pass somewhere within this area
    { radiusMeters: 1000 }

    // Small radius - route will pass very close to this point
    { radiusMeters: 50 }

    Settings

    Member Visibility

    On This Page

    Properties