routing library
Routing
Provides APIs for route calculation, management, and related overlays.
This library covers the main interfaces and classes for route creation, preferences, listeners, terrain profiles, and social overlays.
Main features
- MapViewRoutesCollection – Collection of routes for map display.
- Route – Main class for representing a route. Specialized classes are available for special types of routes.
- RouteBookmarks – Bookmark management for route information, allowing the user to persist route data.
- RouteListener – Listener interface for route events.
- RouteTerrainProfile – Terrain profile data for routes.
- RoutePreferences – Preferences for route calculation.
- RoutingService – Main class for route calculation and management.
- SocialOverlay, SocialReportListener – Social overlays and reporting for routes.
More details
- See the Routing documentation for more information.
Classes
- BikeProfileElectricBikeProfile
- Bike and electric bike routing profile.
- BuildTerrainProfile
- Preferences regarding building terrain profile
- CarProfile
- Car routing profile.
- ClimbSection
- Climb section describing an ascending segment of the route.
- DepartureHeading
- Departure heading
- ElectricBikeProfile
- Electric bike profile containing e-bike configuration and rider/vehicle parameters.
- MapViewRoute Maps & 3D Scenes
- Wrapper representing the Route, RenderSettings and label as displayed on the map view.
- MapViewRoutesCollection Maps & 3D Scenes
- Collection managing routes displayed on a map view.
- MotorVehicleProfile
- Motor vehicle profile.
- OTRoute
- Over-track (OT) route representation.
- PredefinedCategoryParameterKeys
- Predefined parameter keys for report category metadata.
- PredefinedReportParameterKeys
- Predefined parameter keys for social report data access.
- PTAlert
- Public transport alert.
- PTBuyTicketInformation
- Buy-ticket information for a public transport route.
- PTRoute
- Public transport route.
- PTRouteInstruction
- Public transport route instruction.
- PTRouteSegment
- Public transport route segment.
- PTTranslation
- Public transport translation.
- RoadTypeSection
- Road type section describing the classification of the road for a segment.
- RoundTripParameters
- Round trip parameters
- Route
- A computed navigable route.
- RouteBookmarks
- Manages a persistent collection of saved routes (bookmarks).
- RouteInstruction
- A single route step inside a route segment.
- RouteListener
- Listener for events related to a computed route.
- RoutePreferences
- Comprehensive route calculation configuration for customizing routing behavior.
- RouteRenderSettings Maps & 3D Scenes
- Additional rendering settings used to customize how routes are displayed on the map.
- RouteSegment
- A single portion of a computed route between two consecutive waypoints.
- RouteTerrainProfile
- Terrain information for a calculated route.
- RoutingService
- Static service for asynchronous route calculation and navigation planning.
- SocialOverlay
- Static service for crowd-sourced social event reporting and interaction.
- SocialReportListener
- Listens for updates to social report overlay items and delivers update events.
- SocialReportsOverlayCategory Maps & 3D Scenes
- Represents a social report category with hierarchical subcategories.
- SocialReportsOverlayInfo
- Provides access to social report category hierarchy and metadata.
- SteepSection
- Steep section indicating an abrupt elevation change category.
- SurfaceSection
- Surface section describing surface type changes along the route.
- TruckProfile
- Truck routing profile.
- VehicleRegistration
- Vehicle registration information.
Enums
- BikeProfile
- Bike profile selection used for bicycle routing.
- ElectricBikeType
- Electric bike drivetrain type.
- EVChargingConnector
- Electric vehicle charging connector type
- FuelType
- Fuel type for motorized vehicles.
- Grade
- Climb difficulty categories (UCI-based).
- PedestrianProfile
- Pedestrian profile
- PTAlgorithmType
- Algorithm type
- PTSortingStrategy
- Sorting strategy
- RangeType
- Range type to define ranges in.
- RealtimeStatus
- Status of real-time information.
- RoadType
- Road classification for a route section.
- RouteAlternativesSchema
- Alternative routes scheme
- RouteBookmarksSortOrder
- Sort order options for RouteBookmarks.
- RoutePathAlgorithm
- Path calculation algorithm
- RoutePathAlgorithmFlavor
- Path calculation flavors
- RouteResultDetails
- Routing result details
- RouteResultType
- Route result
- RouteTransportMode
- Transport mode
- RouteType
- Route type
- RouteTypePreferences
- Route type preference
- SurfaceType
- Surface material/type for a route segment.
- TrafficAvoidance
- Traffic avoidance options
- TransitType
- Type of transit.