TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ChargingStopProps

    ChargingStopProps: CommonPlaceProps & {
        chargingConnectionInfo?: ChargingConnectionInfo;
        chargingConnections: ChargingConnectionInfo[];
        chargingParkId: string;
        chargingParkName?: string;
        chargingParkOperatorName?: string;
        chargingParkPaymentOptions?: ChargingPaymentOption[];
        chargingParkPowerInkW?: number;
        chargingParkSpeed?: ChargingSpeed;
        chargingParkUuid: string;
        chargingStopType?: "Auto_Generated" | "User_Defined";
        chargingTimeInSeconds: number;
        targetChargeInkWh: number;
        targetChargeInPCT?: number;
    }

    Properties specific to charging stops in electric vehicle routes.

    These properties are combined with CommonPlaceProps to form a complete ChargingStop object.

    Type Declaration

    • OptionalchargingConnectionInfo?: ChargingConnectionInfo

      Detailed information about the recommended charging connection for this stop.

      Specifies which connector type, power level, and charging specifications should be used at this charging park for optimal charging.

      This is typically the best connector available that matches:

      • Vehicle's charging capabilities
      • Required charging speed for the journey
      • Availability at the charging park
    • chargingConnections: ChargingConnectionInfo[]

      Array of available charging connections at this park.

      Each connection specifies plug type, power ratings, and current type.

    • chargingParkId: string

      Unique identifier for the charging park.

    • OptionalchargingParkName?: string

      The common name of this charging park.

      A human-readable name for the charging location, often including nearby landmarks, business names, or descriptive identifiers.

      chargingParkName: "Amsterdam Central Station - North Side"
      chargingParkName: "Shell Recharge - Highway A2"
    • OptionalchargingParkOperatorName?: string

      The charging network operator or provider name.

      Identifies the company or organization that operates this charging park.

      Common operators include: Shell Recharge, Ionity, ChargePoint, EVgo, Tesla Supercharger, Fastned, etc.

      chargingParkOperatorName: "Ionity"
      chargingParkOperatorName: "Shell Recharge"
    • OptionalchargingParkPaymentOptions?: ChargingPaymentOption[]

      Available payment options at this charging park.

      Lists the payment methods accepted at this charging location. Multiple options may be available.

    • OptionalchargingParkPowerInkW?: number

      Maximum available charging power at this charging park in kilowatts (kW).

      Represents the highest power output available across all charging connections at this location. Actual charging power may be lower depending on:

      • Vehicle capabilities
      • Selected connector type
      • Battery state of charge
      • Grid conditions

      This is typically the power of the fastest charger at the park.

      // A charging park with multiple chargers
      chargingParkPowerInkW: 150 // Has at least one 150kW charger
    • OptionalchargingParkSpeed?: ChargingSpeed

      The best charging speed classification of this charging park amongst its connectors.

      • slow: Typically up to 12 kW (Level 1 AC charging)
      • regular: Typically between 12 kW and 50 kW (Level 2 AC charging)
      • fast: Typically between 50 kW and 150 kW (DC fast charging)
      • ultra-fast: Typically above 150 kW (High-power DC fast charging)
    • chargingParkUuid: string

      The unique UUID identifier of this charging park.

      This universally unique identifier can be used to:

      • Check real-time availability of charging stations
      • Query detailed charging park information
      • Track charging park status and updates
      • Cross-reference with TomTom EV Charging Stations API

      Use this UUID with the EV Charging Stations Availability API to get real-time connector availability before arriving at the charging stop.

      // Use UUID to check availability
      const availability = await evChargingAvailability.get({
        chargingAvailability: chargingStop.chargingParkUuid
      });
    • OptionalchargingStopType?: "Auto_Generated" | "User_Defined"

      The source of the charging stop at the end of this leg.

      Indicates whether the charging stop was automatically calculated by the routing engine or explicitly specified by the user.

      • Auto_Generated: The routing engine selected this charging stop to optimize the route
      • User_Defined: The user explicitly requested a charging stop at this location
    • chargingTimeInSeconds: number

      Estimated time in seconds required to charge the battery at this stop.

      Calculated based on:

      • Current battery charge level
      • Target charge level for next leg
      • Charging power of the selected connector
      • Battery charging curve characteristics
    • targetChargeInkWh: number

      Target battery charge level in kilowatt-hours (kWh) after charging.

      The routing engine determines the optimal charge level to minimize total journey time while ensuring the vehicle can reach the next stop.

    • OptionaltargetChargeInPCT?: number

      Target battery charge level as a percentage of maximum capacity.

      Derived from targetChargeInkWh and the vehicle's maximum battery capacity.

      // If maxChargeInkWh is 100 and targetChargeInkWh is 80
      targetChargeInPCT // 80

    Settings

    Member Visibility