MPLocationDisplayRule Class Reference

#include <MPLocationDisplayRule.h>

Inheritance diagram for MPLocationDisplayRule:

Instance Methods
(BOOL)	- show:
(nullable NSString *)	- getLabelContent:
(void)	- fetchIcon:
(nullable instancetype)	- initWithName:AndZoomLevelOn:AndShowLabel:
(nullable instancetype)	- initWithName:AndIcon:AndZoomLevelOn:
(nullable instancetype)	- initWithName:AndIcon:AndZoomLevelOn:AndShowLabel:
(nullable instancetype)	- initWithName:AndIconURL:AndZoomLevelOn:AndShowLabel:

Properties
NSString< Ignore > *	name
NSNumber *	zOn
NSNumber *	zOff
NSString *	iconPath
NSString *	label
UIColor< Optional > *	highlightOutlineColor
UIColor< Optional > *_Nullable	highlightFillColor
NSNumber< Optional > *_Nullable	highlightStrokeWidth
UIImage< Ignore > *	icon
BOOL	showLabel
BOOL	showIcon
BOOL	showOutline
BOOL	visible
CGSize	iconSize
NSUInteger	labelMaxWidth
NSString< Optional > *	clusteringId
NSInteger	displayRank
BOOL	showPolygon
NSNumber *	zOnPolygon
NSNumber *	zOffPolygon
NSNumber *	polygonStrokeWidth
UIColor *	polygonStrokeColor
UIColor *	polygonFillColor
NSNumber *	model2DBearing
NSNumber *	model2DHeightMeters
NSString *	model2DModel
BOOL	model2DVisible
NSNumber *	model2DWidthMeters
NSNumber *	model2DZoomFrom
NSNumber *	model2DZoomTo

Detailed Description

This class serves as a display rule for locations.

Method Documentation

fetchIcon:

- (void) fetchIcon:

(nonnull NSString *)

basePathOrBundle

Retrieve the icon from the ressources and store in memory.

getLabelContent:

- (nullable NSString *) getLabelContent:

(nonnull MPLocation *)

location

Get the label from the display rule, based on the location input.

Returns

An string.

initWithName:AndIcon:AndZoomLevelOn:

- (nullable instancetype) initWithName:		(nullable NSString *)	name
AndIcon:		(nullable UIImage *)	icon
AndZoomLevelOn:		(CGFloat)	zOn

Instantiate a display rule with parameters.

Parameters

name	The name and identifier of the rule.
icon	The icon used to display locations that qualify conditions of this rule.
zOn	The map zoom level above which the location marker should display.

initWithName:AndIcon:AndZoomLevelOn:AndShowLabel:

- (nullable instancetype) initWithName:		(nullable NSString *)	name
AndIcon:		(nullable UIImage *)	icon
AndZoomLevelOn:		(CGFloat)	zOn
AndShowLabel:		(BOOL)	doShowLabel

Instantiate a display rule with parameters.

Parameters

name	The name and identifier of the rule.
icon	The icon used to display locations that qualify conditions of this rule.
zOn	The map zoom level above which the location marker should display.
doShowLabel	Whether or not to show a text label instead of the icon.

initWithName:AndIconURL:AndZoomLevelOn:AndShowLabel:

- (nullable instancetype) initWithName:		(nullable NSString *)	name
AndIconURL:		(nullable NSString *)	iconURL
AndZoomLevelOn:		(CGFloat)	zOn
AndShowLabel:		(BOOL)	doShowLabel

Defered instantiate a display rule with parameters.

Parameters

name	The name and identifier of the rule.
iconURL	The icon URL used to display locations that qualify conditions of this rule.
zOn	The map zoom level above which the location marker should display.
doShowLabel	Whether or not to show a text label instead of the icon.

initWithName:AndZoomLevelOn:AndShowLabel:

- (nullable instancetype) initWithName:		(nullable NSString *)	name
AndZoomLevelOn:		(CGFloat)	zOn
AndShowLabel:		(BOOL)	doShowLabel

Instantiate a display rule with parameters.

Parameters

name	The name and identifier of the rule.
zOn	The map zoom level above which the location marker should display.
doShowLabel	Whether or not to show a text label instead of the icon.

show:

- (BOOL) show:

(CGFloat)

zLevel

Processes the rule conditions at the given map zoom level.

Parameters

zLevel

The current map zoom level.

Returns

Whether or not to show the location.

Property Documentation

clusteringId

- (NSString<Optional>*) clusteringId

readwritenonatomicstrong

The grouping or clustering id of this displayrule. MPLocations sharing the same clusteringId may be grouped on the map if necessary. Default value is nil

displayRank

- (NSInteger) displayRank

readwritenonatomicassign

Display rank determines which POI (or group of POIs) will be displayed in case of conflicts / overlaps. Higher ranks wins over lower.

highlightFillColor

- (UIColor<Optional>* _Nullable) highlightFillColor

readwritenonatomicassign

The highlight fill color.

highlightOutlineColor

- (UIColor<Optional>*) highlightOutlineColor

readwritenonatomicstrong

The highlight outline color.

highlightStrokeWidth

- (NSNumber<Optional>* _Nullable) highlightStrokeWidth

readwritenonatomicassign

The highlight stroke width.

icon

- (UIImage<Ignore>*) icon

readwritenonatomicstrong

The marker icon to use on markers that apply to the display rule.

iconPath

- (NSString*) iconPath

readwritenonatomicstrong

Relative path of the marker icon to use, without extension. Format is png.

iconSize

- (CGSize) iconSize

readwritenonatomicassign

Size of the icon image

label

- (NSString*) label

readwritenonatomicstrong

Label template for the resulting location marker - e.g. "{{name}}", "{{roomId}}", "Room #{{roomId}}" etc..

labelMaxWidth

- (NSUInteger) labelMaxWidth

readwritenonatomicassign

Maximum width in points of the label shown on the map. If the text shown in the label (typically the location name) is longer than the labelMaxWidth the text will flow onto as many lines as needed.

model2DBearing

- (NSNumber*) model2DBearing

readnonatomicstrong

model2DHeightMeters

- (NSNumber*) model2DHeightMeters

readnonatomicstrong

model2DModel

- (NSString*) model2DModel

readnonatomicstrong

model2DVisible

- (BOOL) model2DVisible

readnonatomicassign

model2DWidthMeters

- (NSNumber*) model2DWidthMeters

readnonatomicstrong

model2DZoomFrom

- (NSNumber*) model2DZoomFrom

readnonatomicstrong

model2DZoomTo

- (NSNumber*) model2DZoomTo

readnonatomicstrong

name

- (NSString<Ignore>*) name

readwritenonatomicstrong

Name/identifier of the rule. Also used as the rule condition for the location types.

polygonFillColor

- (UIColor*) polygonFillColor

readwritenonatomicstrong

The fill color of the polygon drawn on the map.

polygonStrokeColor

- (UIColor*) polygonStrokeColor

readwritenonatomicstrong

The stroke color of the polygon drawn on the map.

polygonStrokeWidth

- (NSNumber*) polygonStrokeWidth

readwritenonatomicstrong

The stroke width of the polygon drawn on the map.

showIcon

- (BOOL) showIcon

readwritenonatomicassign

Whether or not to show an icon.

showLabel

- (BOOL) showLabel

readwritenonatomicassign

Whether or not to show a text label. See label property

showOutline

- (BOOL) showOutline

readwritenonatomicassign

Whether or not to show an outline.

showPolygon

- (BOOL) showPolygon

readwritenonatomicassign

BOOL indicating if the locations polygon should be shown on the map.

visible

- (BOOL) visible

readwritenonatomicassign

Whether or not to show the icon.

zOff

- (NSNumber*) zOff

readwritenonatomicstrong

The map zoom level beneath which the location marker should be visible.

zOffPolygon

- (NSNumber*) zOffPolygon

readwritenonatomicstrong

The map zoom level beneath which the location marker should be visible.

zOn

- (NSNumber*) zOn

readwritenonatomicstrong

The map zoom level above which the location marker should be visible.

zOnPolygon

- (NSNumber*) zOnPolygon

readwritenonatomicstrong

The map zoom level above which the location polygon should be visible.