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
- DepartureHeading
- Departure heading
- ElectricBikeProfile
- eBike profile
- EVProfile
- EV routing profile
- EVRoute
- Electric vehicle route class
- EVRouteInstruction
- Electric vehicle route instruction class
- EVRouteSegment
- Electric vehicle segment class
- MapViewRoute
- Mapview route class
- MapViewRoutesCollection
- Mapview Routes collection class
- MotorVehicleProfile
- Motor vehicle profile.
- OTRoute
- Over track route
- PredefinedCategoryParameterKeys
- PredefinedCategoryParameterKeys contains keys for report category parameters.
- PredefinedReportParameterKeys
- PredefinedReportParameterKeys contains keys for report parameters.
- PTAlert
- Public transport alert class
- PTBuyTicketInformation
- Public transport buy ticket information class.
- PTRoute
- Public transport route class
- PTRouteInstruction
- Public transport route instruction class.
- PTRouteSegment
- Public transport route segment
- PTTranslation
- Public transport translation class
- RoadTypeSection
- Road type sections
- Route
- Route class
- RouteBookmarks
- Route bookmarks class.
- RouteInstruction
- Route instruction class
- RouteListener Places
- Listener for events related to a route.
- RoutePreferences
- Route preferences - contains the preferences used for route calculation.
- RouteRenderSettings
- A class that extends RenderSettings to provide additional rendering settings specifically for routes.
- RouteSegment Core
- Route segment class
- RouteTerrainProfile
- Route terrain profile
- RoutingService
- Routing service class
- SocialOverlay
- SocialOverlay allows reporting and retrieval of social events.
- SocialReportListener
- SocialReportListener listens for updates to social report overlay items.
- SocialReportsOverlayInfo
- SocialReportsOverlayInfo provides information about social reports categories.
- SteepSection
- Steep sections
- SurfaceSection
- Surface sections
- TruckProfile
- Truck routing profile
Enums
- BikeProfile
- Bike profile
- ElectricBikeType
- eBike type
- FuelType
- Fuel Type
- Grade
- Climb grade - UCI based, see https://bicycles.stackexchange.com/questions/1210/how-are-the-categories-for-climbs-decided
- PedestrianProfile
- Pedestrian profile
- PTAlgorithmType
- Algorithm type
- PTSortingStrategy
- Sorting strategy
- RealtimeStatus
- Status of real-time information.
- RoadType
- Get road type
- RouteAlternativesSchema
- Alternative routes scheme
- RouteBookmarksSortOrder
- Enumeration used to specify the sort order of the routes.
- 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
- Get surface type
- TrafficAvoidance
- Traffic avoidance options
- TransitType
- Type of transit.