AWFMapURL

Objective-C

@interface AWFMapURL

Swift

class AWFMapURL

AWFMapURL is a the base class that is responsible for configuring a URL for interacting with the Aeris Maps Platform (AMP).

  • An array of layers used for the URL.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<AWFRasterMapLayer *> *_Nonnull layers;

    Swift

    var layers: [AWFRasterMapLayer] { get }

  • An array of map layer types used in the URL.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<AWFMapLayer> *_Nonnull layerTypes;

    Swift

    var layerTypes: [AWFMapLayer] { get }

  • An array of layer values used in the URL. Unlike layerTypes, the values in the array will contain all layer options within the string.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull layerValues;

    Swift

    var layerValues: [String] { get }

  • The full URL path required for the map request for the specified layers and options.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull URLPath;

    Swift

    var urlPath: String { get }

  • The full URL path required for the map request for the specified options but excluding layer information.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull URLPathExcludingLayers;

    Swift

    var urlPathExcludingLayers: String { get }

  • The date and time for the map request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nonnull date;

    Swift

    var date: Date { get set }

  • The timestamp string for the map’s date in the format YYYYMMddhhmmss.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull timestamp;

    Swift

    var timestamp: String { get }

  • The offset string for the map’s date relative to the current time (e.g. -10minutes, +1hour).

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull offset;

    Swift

    var offset: String { get }

  • Initializes and returns a map image URL instance using the specified base map style.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStyle:(AWFBaseMapStyle)style;

    Swift

    init(style: AWFBaseMapStyle)

    Parameters

    style

    The base map style to use for the map

    Return Value

    An AWFMapImageURL instance initialized with the base map style

  • Initializes and returns a map image URL instance using the specified base map style and raster map layers.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStyle:(AWFBaseMapStyle)style
                               layers:(nullable NSArray<AWFRasterMapLayer *> *)
                                          layers;

    Swift

    init(style: AWFBaseMapStyle, layers: [AWFRasterMapLayer]?)

    Parameters

    style

    The base map style to use for the map
    layers

    An array of raster layers to add to the map

    Return Value

    An AWFMapImageURL instance initialized with the base map style and raster layers

  • Adds a map layer to the request.

    Declaration

    Objective-C

    - (void)addLayer:(nonnull AWFRasterMapLayer *)layer;

    Swift

    func addLayer(_ layer: AWFRasterMapLayer)

  • Adds an array of map layers to the request.

    Declaration

    Objective-C

    - (void)addLayers:(nonnull NSArray<AWFRasterMapLayer *> *)layers;

    Swift

    func addLayers(_ layers: [AWFRasterMapLayer])

  • Inserts a map layer to the request at the specified index relative to existing layers.

    Declaration

    Objective-C

    - (void)insertLayer:(nonnull AWFRasterMapLayer *)layer atIndex:(NSInteger)index;

    Swift

    func insertLayer(_ layer: AWFRasterMapLayer, at index: Int)

  • Inserts a map layer to the request on top of the specified existing layer. If otherLayer is not currently associated with the request, then the layer will be inserted at the top of the layer stack.

    Declaration

    Objective-C

    - (void)insertLayer:(nonnull AWFRasterMapLayer *)layer
         aboveLayer:(nonnull AWFRasterMapLayer *)otherLayer;

    Swift

    func insertLayer(_ layer: AWFRasterMapLayer, above otherLayer: AWFRasterMapLayer)

  • Inserts a map layer to the request underneath the specified existing layer. If otherLayer is not currently associated with the request, then the layer will be inserted at the top of the layer stack.

    Declaration

    Objective-C

    - (void)insertLayer:(nonnull AWFRasterMapLayer *)layer
         belowLayer:(nonnull AWFRasterMapLayer *)otherLayer;

    Swift

    func insertLayer(_ layer: AWFRasterMapLayer, below otherLayer: AWFRasterMapLayer)

  • Moves a map layer in the request to the specified index.

    Declaration

    Objective-C

    - (void)moveLayer:(nonnull AWFRasterMapLayer *)layer toIndex:(NSInteger)index;

    Swift

    func moveLayer(_ layer: AWFRasterMapLayer, to index: Int)

    Parameters

    layer

    The raster map layer to move
    index

    The destination index for the layer

  • Removes a map layer from the request.

    Declaration

    Objective-C

    - (void)removeLayer:(nonnull AWFRasterMapLayer *)layer;

    Swift

    func removeLayer(_ layer: AWFRasterMapLayer)

  • Removes an array of map layers from the request.

    Declaration

    Objective-C

    - (void)removeLayers:(nonnull NSArray<AWFRasterMapLayer *> *)layers;

    Swift

    func removeLayers(_ layers: [AWFRasterMapLayer])

  • Removes all existing map layers from the request.

    Declaration

    Objective-C

    - (void)removeAllLayers;

    Swift

    func removeAllLayers()

  • Returns the existing map layer for the specified raster layer type if it exists in the request.

    Declaration

    Objective-C

    - (nullable AWFRasterMapLayer *)layerForRasterLayer:
    (nonnull AWFMapLayer)layerType;

    Swift

    func layer(forRasterLayer layerType: AWFMapLayer) -> AWFRasterMapLayer?

  • Returns YES if the request has a layer for the specified raster layer type, otherwise NO.

    Declaration

    Objective-C

    - (BOOL)hasLayerForRasterLayer:(nonnull AWFMapLayer)layerType;

    Swift

    func hasLayer(forRasterLayer layerType: AWFMapLayer) -> Bool