VMMSCustomMapInfo

@interface 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

    Swift

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

    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

    Swift

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

    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

    Swift

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

    Parameters

    meta

    the new metadata

  • Loads a json file that contains custom map info.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use load:forMap:options instead.

    Declaration

    Swift

    + (void)load:(NSString *)filePath
    delegate:(id<VMMSMapDelegate>)mapDelegate
      forMap:(VMMSMap *)map;

    Parameters

    filePath

    the absolute file path to the json file
    mapDelegate

    a VMMSMapDelegate
    map

    the associated VMMSMap

  • Loads a json file that contains custom map info.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use load:forMap:options instead.

    Declaration

    Swift

    + (void)load:(NSString *)filePath
    delegate:(id<VMMSMapDelegate>)mapDelegate
      forMap:(VMMSMap *)map
     options:(VMMSWaypointLabelOptions *)options;

    Parameters

    filePath

    the absolute file path to the json file
    mapDelegate

    a VMMSMapDelegate
    map

    the associated VMMSMap
    options

    options for labeling waypoints

  • Loads a json file that contains custom map info.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use load:forMap:options instead.

    Declaration

    Swift

    + (void)loadFromURL:(NSURL *)url
           delegate:(id<VMMSMapDelegate>)delegate
             forMap:(VMMSMap *)map;

    Parameters

    url

    the URL to the json file
    delegate

    a VMMSMapDelegate
    map

    the associated VMMSMap

  • Loads a json file that contains custom map info.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use load:forMap:options instead.

    Declaration

    Swift

    + (void)loadFromURL:(NSURL *)url
           delegate:(id<VMMSMapDelegate>)delegate
        withOptions:(VMMSWaypointLabelOptions *)options
             forMap:(VMMSMap *)map;

    Parameters

    url

    the URL to the json file
    delegate

    a VMMSMapDelegate
    options

    options for labeling waypoints
    map

    the associated VMMSMap

  • Loads a json file that contains custom map info.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use load:forMap:options instead.

    Declaration

    Swift

    + (void)loadFromURL:(NSURL *)url
        withSession:(NSURLSession *)session
           delegate:(id<VMMSMapDelegate>)delegate
             forMap:(VMMSMap *)map;

    Parameters

    url

    the URL to the json file
    session

    a custom URL session to control how the file is retrieved
    delegate

    a VMMSMapDelegate
    map

    the associated VMMSMap

  • Loads a json file that contains custom map info.

    Since

    1.0

    Warning

    Deprecated in 1.1. Use load:forMap:options instead.

    Declaration

    Swift

    + (void)loadFromURL:(NSURL *)url
        withSession:(NSURLSession *)session
           delegate:(id<VMMSMapDelegate>)delegate
        withOptions:(VMMSWaypointLabelOptions *)options
             forMap:(VMMSMap *)map;

    Parameters

    url

    the URL to the json file
    session

    a custom URL session to control how the file is retrieved
    delegate

    a VMMSMapDelegate
    options

    options for labeling waypoints
    map

    the associated VMMSMap