63 lines
2.1 KiB
Objective-C
63 lines
2.1 KiB
Objective-C
#import <UIKit/UIKit.h>
|
|
|
|
#import "MLNFoundation.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
The `MLNAnnotationImage` class is responsible for presenting point-based
|
|
annotations visually on a map view. Annotation image objects wrap `UIImage`
|
|
objects and may be recycled later and put into a reuse queue that is maintained
|
|
by the map view.
|
|
|
|
#### Related examples
|
|
TODO: Mark a place on the map with an image, learn how use an image
|
|
as a marker using `MLNAnnotationImage`.
|
|
*/
|
|
MLN_EXPORT
|
|
@interface MLNAnnotationImage : NSObject <NSSecureCoding>
|
|
|
|
// MARK: Initializing and Preparing the Image Object
|
|
|
|
/**
|
|
Initializes and returns a new annotation image object.
|
|
|
|
@param image The image to be displayed for the annotation.
|
|
@param reuseIdentifier The string that identifies that this annotation image is
|
|
reusable.
|
|
@return The initialized annotation image object or `nil` if there was a problem
|
|
initializing the object.
|
|
*/
|
|
+ (instancetype)annotationImageWithImage:(UIImage *)image
|
|
reuseIdentifier:(NSString *)reuseIdentifier;
|
|
|
|
// MARK: Getting and Setting Attributes
|
|
|
|
/** The image to be displayed for the annotation. */
|
|
@property (nonatomic, strong, nullable) UIImage *image;
|
|
|
|
/**
|
|
The string that identifies that this annotation image is reusable. (read-only)
|
|
|
|
You specify the reuse identifier when you create the image object. You use this
|
|
type later to retrieve an annotation image object that was created previously
|
|
but which is currently unused because its annotation is not on screen.
|
|
|
|
If you define distinctly different types of annotations (with distinctly
|
|
different annotation images to go with them), you can differentiate between the
|
|
annotation types by specifying different reuse identifiers for each one.
|
|
*/
|
|
@property (nonatomic, readonly) NSString *reuseIdentifier;
|
|
|
|
/**
|
|
A Boolean value indicating whether the annotation is enabled.
|
|
|
|
The default value of this property is `YES`. If the value of this property is
|
|
`NO`, the annotation image ignores touch events and cannot be selected.
|
|
*/
|
|
@property (nonatomic, getter=isEnabled) BOOL enabled;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|