SYMapRoute Class Reference

SYMapObject in the shape of a route that can be displayed on a map. In order to display the route object on the map, the route object needs to be added to an SYMapView by calling addMapObject:. More...

#import <SYMapObjects.h>

Inheritance diagram for SYMapRoute:
Collaboration diagram for SYMapRoute:

Instance Methods

(nonnull instancetype) - initWithRoute:type:
 Initializes a SYMapRoute instance with the specified SYRoute and SYMapRouteType for the displayed route. More...
 
(void) - useCustomColor:borderColor:
 Sets custom color to use for displaying this route object. More...
 
(instancetype) - initWithSdkMapRoute: [implementation]
 
- Instance Methods inherited from SYMapObject
(instancetype) - initWithCoordinate:type:payload: [implementation]
 
(Sygic::Map::MapObject *) - sdkMapObject [implementation]
 
- Instance Methods inherited from SYViewObject
(instancetype) - initWithCoordinate:baseType: [implementation]
 
(instancetype) - initWithCoordinate:baseType:payload: [implementation]
 

Properties

SYMapRouteType routeType
 Type of SYMapRoute. See the available SYMapRouteTypes. More...
 
SYRouteroute
 SYRoute represented by the SYMapRoute. More...
 
BOOL useCustomColor
 Indicates whether the route object is using custom colors. More...
 
UIColor * innerColor
 Inner color of the route. More...
 
UIColor * borderColor
 Route's border color. More...
 
UIColor *color DEPRECATED_ATTRIBUTE
 Route color. More...
 
BOOL trafficVisible
 Indicates whether the route object is displaying traffic information. More...
 
Sygic::Map::MapRoute mapRoute [implementation]
 
- Properties inherited from SYMapObject
NSInteger tag
 An integer that you can use to identify view objects in your application. Default value is 0. More...
 
SYMapObjectType mapObjectType
 Map object type. See the available SYMapObjectTypes. More...
 
NSUInteger zIndex
 Z-index (stacking order) for the SYMapObject. Objects with the highest value are placed at the top of the stacking order. More...
 
BOOL visibility
 Visibility of the SYMapObject. Can be shown or hidden. More...
 
- Properties inherited from SYViewObject
SYGeoCoordinatecoordinate
 Geographical location of the SYViewObject. The meaning of the location for a particular object depends on that object's type. Objects that don't have a location will return nil. The meaning of the location for certain view objects is as follows: More...
 
SYViewObjectType baseType
 Determines which type of this ViewObject it is. More...
 
id< NSCoding > payload
 Optional payload for storing custom data. More...
 

Additional Inherited Members

- Class Methods inherited from SYViewObject
(std::vector< uint8_t >) + serializePayload: [implementation]
 
(id< NSCoding >) + deserializePayload: [implementation]
 

Detailed Description

SYMapObject in the shape of a route that can be displayed on a map. In order to display the route object on the map, the route object needs to be added to an SYMapView by calling addMapObject:.

Method Documentation

◆ initWithRoute:type:()

- (nonnull instancetype) initWithRoute: (nonnull SYRoute *)  route
type: (SYMapRouteType)  type 

Initializes a SYMapRoute instance with the specified SYRoute and SYMapRouteType for the displayed route.

◆ initWithSdkMapRoute:()

- (instancetype) initWithSdkMapRoute: (std::shared_ptr< Sygic::Map::MapRoute >)  sdkRoute
implementation

◆ useCustomColor:borderColor:()

- (void) useCustomColor: (nonnull UIColor *)  innerColor
borderColor: (nonnull UIColor *)  borderColor 

Sets custom color to use for displaying this route object.

Property Documentation

◆ borderColor

- (UIColor*) borderColor
readnonatomicstrong

Route's border color.

◆ DEPRECATED_ATTRIBUTE

- (UIColor* color) DEPRECATED_ATTRIBUTE
readwritenonatomicstrong

Route color.

◆ innerColor

- (UIColor*) innerColor
readnonatomicstrong

Inner color of the route.

◆ mapRoute

- Map:
readwritenonatomicassignimplementation

◆ route

- (SYRoute*) route
readnonatomicassign

SYRoute represented by the SYMapRoute.

◆ routeType

- (SYMapRouteType) routeType
readnonatomicassign

Type of SYMapRoute. See the available SYMapRouteTypes.

◆ trafficVisible

- (BOOL) trafficVisible
readwritenonatomicassign

Indicates whether the route object is displaying traffic information.

◆ useCustomColor

- (BOOL) useCustomColor
readnonatomicassign

Indicates whether the route object is using custom colors.


The documentation for this class was generated from the following file: