TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ElectricSummary

    ElectricSummary: SummaryBase & {
        batteryConsumptionInkWh?: number;
        batteryConsumptionInPCT?: number;
        remainingChargeAtArrivalInkWh?: number;
        remainingChargeAtArrivalInPCT?: number;
    }

    Summary information for routes using electric vehicles.

    Extends the base summary with battery consumption and charge level estimates.

    Type Declaration

    • OptionalbatteryConsumptionInkWh?: number

      Estimated electric energy consumption in kilowatt-hours (kWh).

      Calculated using the Electric Consumption Model based on:

      • Vehicle speed-to-consumption rates
      • Route characteristics (elevation changes)
      • Recuperation (regenerative braking)

      Included only if:

      • Vehicle engine type is set to electric
      • Speed-to-consumption rates are specified in the request

      This value includes recuperated energy and can be negative (indicating net energy gain), such as when descending a long hill. If maxChargeInkWh is specified, recuperation is capped to prevent exceeding maximum battery capacity.

      batteryConsumptionInkWh: 15.5    // Consumed 15.5 kWh
      batteryConsumptionInkWh: -2.3 // Gained 2.3 kWh (downhill with recuperation)
    • OptionalbatteryConsumptionInPCT?: number

      Estimated battery consumption as a percentage of maximum capacity.

      Only present if maxChargeInkWh was specified in the request and batteryConsumptionInkWh is available.

      // If maxChargeInkWh is 100 and batteryConsumptionInkWh is 15.5
      batteryConsumptionInPCT: 15.5 // 15.5% of battery capacity
    • OptionalremainingChargeAtArrivalInkWh?: number

      Estimated battery charge in kWh upon arrival at the destination.

      Available only for Long Distance EV Routing (LDEVR) with charging stops. Calculated as: currentChargeInkWh - batteryConsumptionInkWh + chargingEnergy

    • OptionalremainingChargeAtArrivalInPCT?: number

      Estimated battery charge as percentage of capacity upon arrival.

      Available only for Long Distance EV Routing (LDEVR) with charging stops. Derived from remainingChargeAtArrivalInkWh and maxChargeInkWh.