VMMSCustomMapInfo

Objective-C

@interface VMMSCustomMapInfo : NSObject

Swift

class VMMSCustomMapInfo : NSObject

Class that contains custom info that can be used when creating turn by turn directions and auto-labeling waypoints.

Since

1.0

Public Methods

  • Loads a json file that contains custom map info.

    Since

    1.1

    Declaration

    Objective-C

    + (nonnull instancetype)load:(nonnull id<VMDFile>)vmdFile
                      forMap:(nonnull VMWayfindingMap *)map
                     options:(nonnull VMMSWaypointLabelOptions *)options;

    Swift

    class func load(_ vmdFile: Any, for map: VMWayfindingMap, options: VMMSWaypointLabelOptions) -> Self

    Parameters

    vmdFile

    File path to the json file.
    map

    A VMMSMap instance.
    options

    The options to use for labeling.

  • Retrieves the metadata associated with two waypoints.

    Declaration

    Objective-C

    - (nonnull VMMSPathMetadata *)
    metadataForSegmentWithStartId:(nonnull NSString *)startId
                         andEndId:(nonnull NSString *)endId;

    Swift

    func metadataForSegment(withStartId startId: String, andEndId endId: String) -> VMMSPathMetadata

    Parameters

    startId

    The ID of the first waypoint.
    endId

    The ID of the second waypoint.

    Return Value

    Returns path metadata for the segment.

  • Addes a new path metadata object

    Declaration

    Objective-C

    - (void)addPathMetadata:(nonnull VMMSPathMetadata *)meta;

    Swift

    func add(_ meta: VMMSPathMetadata)

    Parameters

    meta

    the new metadata