TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.0. Go to the latest version, 1.0.0-rc.5.
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, either:

    • An object with lon and lat properties
    • An array [longitude, latitude]
    // Object format
    origin: { lon: 4.9, lat: 52.3 }

    // Array format
    origin: [4.9, 52.3]
    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.

    If you supply past dates or dates that are impossible to achieve, it defaults to departing now.

    Future departure times use predictive traffic, the current time uses live traffic, and historic times use historical patterns.

    Depart now

    when: { option: 'departAt', date: new Date('2025-10-20T08:00:00Z') }

    Settings
    Member Visibility

    On This Page
    Properties