ElectricBikeProfile - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > ElectricBikeProfile

ElectricBikeProfile class

Electric bike profile containing e-bike configuration and rider/vehicle parameters.

Holds electric bike specific routing parameters used by the routing engine to estimate energy consumption, apply legal constraints, and tune route generation for e-bike capabilities.

Routing

Signature:

export declare class ElectricBikeProfile extends VehicleRegistration

Extends: VehicleRegistration

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Creates an ElectricBikeProfile with optional values. Constructs an instance with sensible defaults if specific values are not provided. The defaults model a typical pedelec with no masses or auxiliary consumption specified.

Constructor

Modifiers

Description

(constructor)(options)

Creates an ElectricBikeProfile with optional values.

Constructs an instance with sensible defaults if specific values are not provided. The defaults model a typical pedelec with no masses or auxiliary consumption specified.

Properties

Property	Type	Description
auxConsumptionDay	number	Auxiliary power consumption during day in Watts. If zero, a default internal value may be applied by routing logic.
auxConsumptionNight	number	Auxiliary power consumption during night in Watts. If zero, a default internal value may be applied by routing logic.
bikeMass	number	Bike mass in kilograms. If zero, a default internal value may be applied by routing logic.
bikerMass	number	Rider (biker) mass in kilograms. If zero, a default internal value may be applied by routing logic.
ignoreLegalRestrictions	boolean	Ignore country-based legal restrictions related to e-bikes. When true, routing will not apply jurisdiction-specific constraints for e-bike classification.
type	ElectricBikeType	Ebike drivetrain type. Default is ElectricBikeType.pedelec.

Methods

Method	Modifiers	Description
equals(other)		Check equality with another ElectricBikeProfile
hashCode()		Get hash code for use in maps/sets