This is the documentation of version 0.46.10. Go to the latest version, 1.0.0.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ReachableRangeBudget

    Budget constraint for reachable range calculation.

    Defines the limit (time, distance, or fuel/charge) for calculating how far you can travel from a starting point.

    Use Cases:

    • Service area visualization (30-min delivery zone)
    • EV range anxiety mitigation (show reachable area)
    • Emergency response coverage (10-min response time)
    • Delivery zone planning
    • Store location analysis
    // 30-minute travel time
    const timeBudget: ReachableRangeBudget = {
    type: 'timeMinutes',
    value: 30
    };

    // 50 km distance
    const distanceBudget: ReachableRangeBudget = {
    type: 'distanceKM',
    value: 50
    };

    // 50% battery remaining
    const evBudget: ReachableRangeBudget = {
    type: 'remainingChargeCPT',
    value: 50
    };

    // 20 liters of fuel
    const fuelBudget: ReachableRangeBudget = {
    type: 'spentFuelLiters',
    value: 20
    };
    type ReachableRangeBudget = {
        type: BudgetType;
        value: number;
    }
    Index

    Properties

    Properties

    The type of budget, including units.

    • timeMinutes: Minutes of travel time
    • distanceKM: Kilometers of travel distance
    • remainingChargeCPT: Battery percentage remaining
    • spentChargePCT: Battery percentage consumed
    • spentFuelLiters: Liters of fuel consumed
    value: number

    The value of the budget based on the units mentioned in the type.

    Typical Values:

    • Time: 5-60 minutes
    • Distance: 5-100 km
    • Charge: 10-100 percentage
    • Fuel: 5-50 liters
    value: 30    // 30 minutes/km/percent/liters depending on type
    value: 15.5 // Decimal values supported