TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ReachableRangeOwnParams

    Parameters specific to reachable range calculation.

    These parameters are combined with common routing parameters to calculate the reachable area from a starting point.

    type ReachableRangeOwnParams = {
        budget: ReachableRangeBudget;
        costModel?: ReachableRangeCostModel;
        maxFerryLengthMeters?: number;
        origin: HasLngLat;
        smoothing?: "none" | "weak" | "strong";
        vehicle?: ReachableRangeVehicleParameters;
        when?: DepartArriveParams<"departAt">;
    }
    Index
    budget costModel? maxFerryLengthMeters? origin smoothing? vehicle? when?
    budget: ReachableRangeBudget

    The budget for the reachable range calculation.

    It consists of a type, which sets time or distance and the units, plus its value. It determines the extent of the reachable area polygon.

    costModel?: ReachableRangeCostModel

    How the routes underlying the range are optimized, and what they avoid.

    maxFerryLengthMeters?: number

    Maximum ferry length in meters to consider.

    The calculation avoids ferries longer than this value. Use it to exclude long ferry routes that might extend the range unrealistically.

    maxFerryLengthMeters: 5000  // Avoid ferries longer than 5 km
    origin: HasLngLat

    Location where the range calculation starts.

    It is the center point from which reachability is calculated, as any HasLngLat:

    • A [longitude, latitude] position
    • A GeoJSON Point
    • A GeoJSON Feature with a Point geometry, such as a place from a search
    // Position
    origin: [4.9, 52.3]

    // A place from a search
    origin: await geocodeOne('Amsterdam Centraal')
    smoothing?: "none" | "weak" | "strong"

    Applies post-processing to smooth the polygon boundary for better visual appearance.

    Stronger smoothing generally results in more points.

    'strong'

    smoothing: 'strong'
    vehicle?: ReachableRangeVehicleParameters

    Parameters for the vehicle whose reachable range is calculated.

    when?: DepartArriveParams<"departAt">

    When to depart, as an instant (date) or a wall-clock time at the origin (localDateTime).

    Future departure times use predictive traffic, and the current time live traffic. A past date departs now, as DepartArriveParams explains.

    Depart now

    when: { option: 'departAt', localDateTime: '2026-10-19T08:00:00' }

    Settings
    Member Visibility

    On This Page
    Properties