MapsIndoors iOS SDK  V3
Instance Methods | Properties | List of all members
MPLocationDisplayRule Class Reference

#import <MPLocationDisplayRule.h>

Inheritance diagram for MPLocationDisplayRule:
MPJSONModel <AbstractMPJSONModelProtocol>

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:
 
- Instance Methods inherited from MPJSONModel
(instancetype) - initWithString:error:
 
(instancetype) - initWithString:usingEncoding:error:
 
(NSString *) - toJSONString
 
(NSData *) - toJSONData
 
(NSString *) - toJSONStringWithKeys:
 
(NSData *) - toJSONDataWithKeys:
 
(BOOL) - validate:
 
(BOOL) - mergeFromDictionary:useKeyMapping:error:
 
- Instance Methods inherited from <AbstractMPJSONModelProtocol>
(instancetype) - initWithDictionary:error:
 
(instancetype) - initWithData:error:
 
(NSDictionary *) - toDictionary
 
(NSDictionary *) - toDictionaryWithKeys:
 

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
 
NSString< Optional > * clusteringId
 
NSInteger displayRank
 
BOOL showPolygon
 
NSNumber * zOnPolygon
 
NSNumber * zOffPolygon
 
NSNumber * polygonStrokeWidth
 
UIColor * polygonStrokeColor
 
UIColor * polygonFillColor
 

Additional Inherited Members

- Class Methods inherited from MPJSONModel
(NSMutableArray *) + arrayOfModelsFromDictionaries:error:
 
(NSMutableArray *) + arrayOfModelsFromData:error:
 
(NSMutableArray *) + arrayOfModelsFromString:error:
 
(NSMutableDictionary *) + dictionaryOfModelsFromDictionary:error:
 
(NSMutableDictionary *) + dictionaryOfModelsFromData:error:
 
(NSMutableDictionary *) + dictionaryOfModelsFromString:error:
 
(NSMutableArray *) + arrayOfDictionariesFromModels:
 
(NSMutableDictionary *) + dictionaryOfDictionariesFromModels:
 
(MPJSONKeyMapper *) + keyMapper
 
(BOOL) + propertyIsOptional:
 
(BOOL) + propertyIsIgnored:
 
(Class) + classForCollectionProperty:
 

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
nameThe name and identifier of the rule.
iconThe icon used to display locations that qualify conditions of this rule.
zOnThe 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
nameThe name and identifier of the rule.
iconThe icon used to display locations that qualify conditions of this rule.
zOnThe map zoom level above which the location marker should display.
doShowLabelWhether 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
nameThe name and identifier of the rule.
iconURLThe icon URL used to display locations that qualify conditions of this rule.
zOnThe map zoom level above which the location marker should display.
doShowLabelWhether 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
nameThe name and identifier of the rule.
zOnThe map zoom level above which the location marker should display.
doShowLabelWhether 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
zLevelThe 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..

◆ 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.


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