Home > @magiclane/maps-sdk > TrafficService > getPersistentRoadblockPathPreview
TrafficService.getPersistentRoadblockPathPreview() method
Get persistent roadblock path preview.
Signature:
static getPersistentRoadblockPathPreview(params: {
from: UserRoadblockPathPreviewCoordinate;
to: Coordinates;
transportMode: RouteTransportMode;
}): [Coordinates[], UserRoadblockPathPreviewCoordinate, GemError];Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
params |
{ from: UserRoadblockPathPreviewCoordinate; to: Coordinates; transportMode: RouteTransportMode; } |
The preview parameters. |
params properties:
- from: UserRoadblockPathPreviewCoordinate
The previous defined coordinates in roadblock path from where to start the preview.
- to: Coordinates
The movable coordinate in roadblock path to where the preview ends.
- transportMode: RouteTransportMode
The transport mode.
Returns:
[Coordinates[], UserRoadblockPathPreviewCoordinate, GemError]
A tuple containing: the coordinates list preview of the roadblock path, the next roadblock point match suggestion, and the error code.