Warning

This feature is available in the Full MapKit SDK version

YMKDrivingAnnotation

@interface YMKDrivingAnnotation : NSObject

The annotation that is displayed on the map.

Summary

Class methods

+ (nonnull YMKDrivingAnnotation *)annotationWithAction:(nullable NSNumber *)action
                                               toponym:(nullable NSString *)toponym
                                       descriptionText:(nonnull NSString *)descriptionText
                                        actionMetadata:(nonnull YMKDrivingActionMetadata *)actionMetadata
                                             landmarks:(nonnull NSArray<NSNumber *> *)landmarks
                                         toponymPhrase:(nullable YMKDrivingToponymPhrase *)toponymPhrase;

Properties

@property (nonatomic, readonly, nullable) NSNumber *action;
Driver action

@property (nonatomic, readonly, nullable) NSString *toponym;
The toponym of the location

@property (nonatomic, readonly, nonnull) NSString *descriptionText;
Description text to display

@property (nonatomic, readonly, nonnull)
    YMKDrivingActionMetadata *actionMetadata;
Action metadata

@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *landmarks;
Significant landmarks

@property (nonatomic, readonly, nullable) YMKDrivingToponymPhrase *toponymPhrase;
The description of the object

Class methods

annotationWithAction:toponym:descriptionText:actionMetadata:landmarks:toponymPhrase:

+ (nonnull YMKDrivingAnnotation *)annotationWithAction:(nullable NSNumber *)action
                                               toponym:(nullable NSString *)toponym
                                       descriptionText:(nonnull NSString *)descriptionText
                                        actionMetadata:(nonnull YMKDrivingActionMetadata *)actionMetadata
                                             landmarks:(nonnull NSArray<NSNumber *> *)landmarks
                                         toponymPhrase:(nullable YMKDrivingToponymPhrase *)toponymPhrase;

Properties

action

@property (nonatomic, readonly, nullable) NSNumber *action;

Driver action.

Optional field, can be nil.


toponym

@property (nonatomic, readonly, nullable) NSString *toponym;

The toponym of the location.

Optional field, can be nil.


descriptionText

@property (nonatomic, readonly, nonnull) NSString *descriptionText;

Description text to display.


actionMetadata

@property (nonatomic, readonly, nonnull)
    YMKDrivingActionMetadata *actionMetadata;

Action metadata.


landmarks

@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *landmarks;

Significant landmarks.


toponymPhrase

@property (nonatomic, readonly, nullable) YMKDrivingToponymPhrase *toponymPhrase;

The description of the object.

Optional field, can be nil.


Previous
YMKDrivingActionMetadata
Next
YMKDrivingCheckpoint
In this article: