MRAnnotation Protocol Reference

Conforms to NSObject
Declared in MRAnnotation.h

Overview

The basic MRAnnotation class; defines a location in space and a title/subtitle for the selection UI.

  point required method

Center x and y of the annotation view. The implementation of this property must be KVO compliant.

@property (nonatomic, readonly) CGPoint point

Declared In

MRAnnotation.h

  title

Title for use by selection UI.

@property (nullable, nonatomic, readonly, copy) NSString *title

Declared In

MRAnnotation.h

  subtitle

Subtitle for use by selection UI.

@property (nullable, nonatomic, readonly, copy) NSString *subtitle

Declared In

MRAnnotation.h

  minimumZoomLevel

Gets the minimum zoom level (inclusive) at which this annotation should be displayed. If not implemented, the annotation will be displayed at every zoom level. Return MRZoomLevelWorld to always display when map is zoomed all the way out

@property (nonatomic, readonly) MRZoomLevel minimumZoomLevel

Declared In

MRAnnotation.h

  maximumZoomLevel

Gets the maximum zoom level (inclusive) at which this annotation should be displayed. If not implemented, the annotation will be displayed at every zoom level. Return MRZoomLevelAtom to always display when map is zoomed all the way in

@property (nonatomic, readonly) MRZoomLevel maximumZoomLevel

Declared In

MRAnnotation.h

  zPosition

This property changes the the front-to-back ordering of annotations onscreen.

@property (nonatomic, readonly) CGFloat zPosition

Declared In

MRAnnotation.h

  collides

Sets whether the annotation collides with other annotations. Default is NO if unimplemented.

@property (nonatomic, readonly) BOOL collides

Declared In

MRAnnotation.h

  preferredOpacity

Preferred Annotations opacity when added to the map. Defaults to 1.0

@property (nonatomic, readonly) CGFloat preferredOpacity

Declared In

MRAnnotation.h

– compareDisplayPriority:

Deprecated. Use zPosition and collides instead.

- (NSComparisonResult)compareDisplayPriority:(id<MRAnnotation>)annotation

Parameters

annotation

The annotation with which to compare display priority.

Discussion

Implement to support collision detection between annotations when displayed on a map. This method should return NSOrderedAscending if the receiver has “less priority” than the given annotation, NSOrderedDescending if the receiver has “more priority”, and NSOrderedSame if the receiver and the annotation are of equal priority. More priority means that given the choice of displaying one of two annotations occupying similar space on the map, the higher priority annotation will be displayed.

Declared In

MRAnnotation.h

  isInflated

Used to signify the annotation should be inflated or enlarged. This helps show various states that the annotation can be represented in.

@property (nonatomic, assign) BOOL isInflated

Declared In

MRAnnotation.h

  userActivity

Optional User Activity to expose for the MRAnnotation

@property (nullable, nonatomic, readonly, strong) NSUserActivity *userActivity

Declared In

MRAnnotation.h

  attributeSet

CoreSpotlight Searchable item Attribute Set for this MRAnnotation.

@property (nonatomic, nullable, strong) CSSearchableItemAttributeSet *attributeSet

Declared In

MRAnnotation.h

  searchItem

CoreSpotlight Search item itself that can be indexed

@property (nonatomic, nullable, strong) CSSearchableItem *searchItem

Declared In

MRAnnotation.h