TomTom Maps for JavaScript
    Preparing search index...

    Type Alias PlanningWaypoint

    PlanningWaypoint: WaypointLike | null

    Waypoint or placeholder for route planning.

    It is a point along a route, either a full waypoint with position and properties, or null for a placeholder like an unset waypoint in a multi-stop route planner UI.

    Use cases:

    • Route planning interfaces with add/remove waypoint functionality
    • Multi-stop delivery route optimization
    • Placeholder slots in waypoint arrays
    • Optional intermediate stops

    Waypoint types:

    • WaypointLike: Full waypoint with coordinates and optional properties
    • null: Placeholder for unset or removed waypoints

    showWaypoints draws no pin for a placeholder, but it keeps its position, so the stops after it keep their numbers.

    // Array of waypoints with some unset
    const waypoints: PlanningWaypoint[] = [
      { type: 'Feature', geometry: { type: 'Point', coordinates: [4.9, 52.3] } },
      null,  // Empty slot for user to add waypoint
      { type: 'Feature', geometry: { type: 'Point', coordinates: [4.5, 51.9] } }
    ];

    // Filter out null waypoints before routing
    const validWaypoints = waypoints.filter((waypoint) => waypoint !== null);

    Settings
    Member Visibility