SYMapRouteLabel Class Reference

Represents the class implementation for route label object of SYMapObject. SYMapRouteLabel is used to display a label on a route on a map. The map handles proper placement of icons on the screen as well as panning and rotation. More...

#import <SYMapObjects.h>

Inheritance diagram for SYMapRouteLabel:

Collaboration diagram for SYMapRouteLabel:

Instance Methods
(nonnull instancetype)	- initWithText:textStyle:placeOnRoute:
	Initializes a SYMapRouteLabel instance with the specified text, style and route. More...

Properties
NSString *	text
	Label text. More...
SYMapObjectTextStyle *	textStyle
	Label text style. More...
UIImage *	image
	Image that will be drawn on label surface. More...
UIImage *	styleImage
	Label style image, that defines color, shape, and ninepatch properties. More...
CGPoint	anchorPosition
	The relative CGPoint position of the SYMapRouteLabel from its anchored location. Value of 0,0 is top left location of SYMapRouteLabel, 1,1 is bottom right. Default value is 0.0,0.0. More...
CGSize	forcedSize
	Forced route label size. More...
CGSize	maxImageSize
	Maximum label image size. More...
CGSize	maxTextSize
	Maximum text size. More...
BOOL	horizontalImageMirroringEnabled
	Enables horizontal mirroring of label image. Default value is NO. More...
BOOL	verticalImageMirroringEnabled
	Enables vertical mirroring of label image. Default value is NO. More...
SYRoute *	route
	Label's route. Once SYMapRouteLabel is added to SYMapView, it's position is calculated to be displayed on this route. More...
CGFloat	minZoomLevel
	Minimum zoom level, at which SYMapRouteLabel is displayed. More...
CGFloat	maxZoomLevel
	Maximum zoom level, at which SYMapRouteLabel is displayed. More...
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
SYGeoCoordinate *	coordinate
	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...
CGPoint	screenPosition
	Position of the SYViewObject on the screen. More...
SYViewObjectType	baseType
	Determines which type of this ViewObject it is. More...
id< NSCoding >	payload
	Optional payload for storing custom data. More...

Detailed Description

Represents the class implementation for route label object of SYMapObject. SYMapRouteLabel is used to display a label on a route on a map. The map handles proper placement of icons on the screen as well as panning and rotation.

Method Documentation

initWithText:textStyle:placeOnRoute:

- (nonnull instancetype) initWithText:		(nonnull NSString *)	text
textStyle:		(nullable SYMapObjectTextStyle *)	style
placeOnRoute:		(nonnull SYRoute *)	route

Initializes a SYMapRouteLabel instance with the specified text, style and route.

Parameters

style

Can be nil - default SYMapObjectTextStyle will be used.

Property Documentation

text

- (NSString*) text

readwritenonatomicstrong

Label text.

textStyle

- (SYMapObjectTextStyle*) textStyle

readwritenonatomicstrong

Label text style.

image

- (UIImage*) image

readwritenonatomicstrong

Image that will be drawn on label surface.

styleImage

- (UIImage*) styleImage

readwritenonatomicstrong

Label style image, that defines color, shape, and ninepatch properties.

anchorPosition

- (CGPoint) anchorPosition

readwritenonatomicassign

The relative CGPoint position of the SYMapRouteLabel from its anchored location. Value of 0,0 is top left location of SYMapRouteLabel, 1,1 is bottom right. Default value is 0.0,0.0.

forcedSize

- (CGSize) forcedSize

readwritenonatomicassign

Forced route label size.

maxImageSize

- (CGSize) maxImageSize

readwritenonatomicassign

Maximum label image size.

maxTextSize

- (CGSize) maxTextSize

readwritenonatomicassign

Maximum text size.

horizontalImageMirroringEnabled

- (BOOL) horizontalImageMirroringEnabled

readwritenonatomicassign

Enables horizontal mirroring of label image. Default value is NO.

verticalImageMirroringEnabled

- (BOOL) verticalImageMirroringEnabled

readwritenonatomicassign

Enables vertical mirroring of label image. Default value is NO.

route

- (SYRoute*) route

readnonatomicassign

Label's route. Once SYMapRouteLabel is added to SYMapView, it's position is calculated to be displayed on this route.

minZoomLevel

- (CGFloat) minZoomLevel

readwritenonatomicassign

Minimum zoom level, at which SYMapRouteLabel is displayed.

maxZoomLevel

- (CGFloat) maxZoomLevel

readwritenonatomicassign

Maximum zoom level, at which SYMapRouteLabel is displayed.

---

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

• SYMapObjects.h