AreaAlongRoute
Defines an area along a route for prefetching.
Properties
Important: This is a Public Preview API. It may be changed or removed at any time.
The width of the route corridor (a non-negative value). This is the distance between the edges of the corridor. The 'corridor' is defined as the sum of the areas to the left and to the right of the central route polyline. corridorWidth measures its total width. Another way to think about this is to say that the corridor consists of all places within corridorWidth / 2 of the central route polyline, in all directions equally. The default value is 0 meters, making the corridor very narrow (but still existent) which means that no extra tiles will be downloaded on top of those through which the polyline passes already. Also corridorMinLength determinate the minimum corridor length to prefetch, ensuring it's downloaded and available even in case of later connectivity loss. Eg. on 200km route, we will prefetch at least the first corridorMinLength. Updating route current position will effectively move the 'sliding window'. The larger the area, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost.
Functions
Checks if this AreaAlongRoute object is equal to another object.
Generates a hash code for this AreaAlongRoute object.