Home > @magiclane/maps-sdk > RouteBookmarks > update
RouteBookmarks.update() method
Update an existing bookmarked route.
Only the fields provided will be updated; omit a parameter to leave the existing value intact.
Signature:
update(index: number, name?: string | null, waypoints?: Landmark[] | null, preferences?: RoutePreferences | null): void;Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
number |
Index of the route to update in the current sort order. |
|
name |
string | null |
(Optional) Optional new unique name for the route. If a route with this name already exists the update will fail. |
|
waypoints |
Landmark[] | null |
(Optional) Optional new list of Landmark waypoints. |
|
preferences |
RoutePreferences | null |
(Optional) Optional RoutePreferences to persist with the route. |
Returns:
void