AWFTileOverlayPath

Objective-C

@interface AWFTileOverlayPath : NSObject

Swift

class AWFTileOverlayPath : NSObject

The AWFTileOverlayPath class provides an object used to specify the index values for a single tile.

  • x

    The index of the tile along the x axis of the map.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger x;

    Swift

    var x: Int { get set }
  • y

    The index of the tile along the y axis of the map.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger y;

    Swift

    var y: Int { get set }
  • z

    The zoom level number for the tile.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger z;

    Swift

    var z: Int { get set }
  • The screen scale factor for which the tile is intended. This value is either 1.0 (for standard resolution displays) or 2.0 (for Retina displays).

    Declaration

    Objective-C

    @property (nonatomic) CGFloat contentScaleFactor;

    Swift

    var contentScaleFactor: CGFloat { get set }
  • The timestamp string for which the tile is intended. This value is usually assigned by a tile overlay’s metadata object, which provides the available times and intervals for a specific tile overlay.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *time;

    Swift

    var time: String? { get set }
  • The interval offset for which the tile is intended. You can use this instead of time to specify the number of intervals to offset from the most recent interval. 0 is the most recent interval, 1 is the interval before the most recent, 2 is two intervals before, and so on.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger offset;

    Swift

    var offset: Int { get set }
  • Initializes and returns an overlay path object at the specified indexes.

    Declaration

    Objective-C

    + (nonnull AWFTileOverlayPath *)overlayPathWithX:(NSInteger)x
                                                   y:(NSInteger)y
                                                   z:(NSInteger)z;

    Swift

    /*not inherited*/ init(x: Int, y: Int, z: Int)

    Return Value

    An initialized overlay path object.

  • Initializes and returns an overlay path object at the specified indexes and interval offset.

    Declaration

    Objective-C

    + (nonnull AWFTileOverlayPath *)overlayPathWithX:(NSInteger)x
                                                   y:(NSInteger)y
                                                   z:(NSInteger)z
                                              offset:(NSInteger)offset;

    Swift

    /*not inherited*/ init(x: Int, y: Int, z: Int, offset: Int)

    Return Value

    An initialized overlay path object.