Share via

MapRouteLine Class

Note

Bing Maps SDK for Android and iOS retirement

Bing Maps SDK for Android and iOS is deprecated and has been retired for all free (Basic) account customers. Enterprise account customers can continue to use Bing Maps SDK for Android and iOS until June 30th, 2028. To avoid service disruptions, all enterprise account customers using Bing Maps SDK for Android and iOS will need to be updated to use Azure Maps Web SDK by June 30th, 2028.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

Displays a route line on the map. Represents a path to be traveled between two or more waypoints displayed on the map.

Android

class MapRouteLine extends MapElement

iOS

@interface MSMapRouteLine : MSMapElement

See also: MapElement

Methods

addMapSegment

Adds a MapRouteSegment to the MapRouteLine. Returns false if the MapRouteSegment is already in the MapRouteLine.

Android

boolean addSegment(MapRouteSegment mapRouteSegment)

iOS

- (BOOL)addSegment:(MSMapRouteSegment*)mapSegment

removeMapSegment

Removes a MapRouteSegment to the MapRouteLine. Returns false if the MapRouteSegment is not in the MapRouteLine.

Android

boolean removeSegment(MapRouteSegment mapRouteSegment)

iOS

- (BOOL)removeSegment:(MSMapRouteSegment*)mapSegment

clearSegments

Removes all segments from the MapRouteLine.

Android

void clearSegments()

iOS

- (void)clearSegments

Properties

iterator (Android only)

Allows enumerating over the segments in the MapRouteLine.

Iterator<MapRouteSegment> getSegments()

mapRouteSegments (iOS only)

Allows enumerating over the segments in the MapRouteLine.

- property(nonatomic, readonly) NSArray<MSMapRouteSegment*>* mapRouteSegments
`

RouteState

Android

Sets or gets route state which is used to set the name of an entry of this MapRouteLine. If MapStyleSheetEntry is also set, this value gets ignored.

MapRouteLineState getRouteState()
void setRouteState(MapRouteLineState lineState)

iOS

@property(nonatomic) MSMapRouteLineState routeState
`

See Also