MGLMapSnapshotter

 

@interface MGLMapSnapshotter : NSObject

An immutable utility object for capturing map-based images.

Example

let camera = MGLMapCamera(lookingAtCenter: CLLocationCoordinate2D(latitude: 37.7184, longitude: -122.4365), fromDistance: 100, pitch: 20, heading: 0)



let options = MGLMapSnapshotOptions(styleURL: MGLStyle.satelliteStreetsStyleURL(), camera: camera, size: CGSize(width: 320, height: 480))
options.zoomLevel = 10



let snapshotter = MGLMapSnapshotter(options: options)
snapshotter.start { (snapshot, error) in
    if error != nil {
        // error handler
    } else {
        // image handler
    }
}

  • Starts the snapshot creation and executes the specified block with the result.

    Declaration

    Objective-C

    - (void)startWithCompletionHandler:
    (nonnull MGLMapSnapshotCompletionHandler)completionHandler;

    Swift

    func start(completionHandler: @escaping MGLMapSnapshotCompletionHandler)

    Parameters

    completionHandler

    The block to handle the result in.
    View Source on GitHub

  • Starts the snapshot creation and executes the specified block with the result on the specified queue.

    Declaration

    Objective-C

    - (void)startWithQueue:(nonnull dispatch_queue_t)queue
     completionHandler:
         (nonnull MGLMapSnapshotCompletionHandler)completionHandler;

    Swift

    func start(with queue: DispatchQueue, completionHandler: @escaping MGLMapSnapshotCompletionHandler)

    Parameters

    queue

    The queue to handle the result on.
    completionHandler

    The block to handle the result in.
    View Source on GitHub

  • Cancels the snapshot creation request, if any.

    Once you call this method, you cannot resume the snapshot. In order to obtain the snapshot, create a new MGLMapSnapshotter object.

    Declaration

    Objective-C

    - (void)cancel;

    Swift

    func cancel()
    View Source on GitHub

  • The zoom level.

    The default zoom level is 0. If this property is non-zero and the camera property is non-nil, the camera’s altitude is ignored in favor of this property’s value.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) double zoomLevel;

    Swift

    var zoomLevel: Double { get set }
    View Source on GitHub

  • A camera representing the viewport visible in the snapshot.

    If this property is non-nil and the coordinateBounds property is set to a non-empty coordinate bounds, the camera’s center coordinate and altitude are ignored in favor of the coordinateBounds property.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MGLMapCamera *_Nonnull camera;

    Swift

    var camera: MGLMapCamera { get set }
    View Source on GitHub

  • The coordinate rectangle that encompasses the bounds to capture.

    If this property is non-empty and the camera property is non-nil, the camera’s center coordinate and altitude are ignored in favor of this property’s value.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MGLCoordinateBounds coordinateBounds;

    Swift

    var coordinateBounds: MGLCoordinateBounds { get set }
    View Source on GitHub

  • URL of the map style to snapshot.

    The URL may be a full HTTP or HTTPS URL, a Mapbox URL indicating the style’s map ID (mapbox://styles/{user}/{style}), or a path to a local file relative to the application’s resource path. Specify nil for the default style.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSURL *styleURL;

    Swift

    var styleURL: URL? { get set }
    View Source on GitHub

  • The size of the output image, measured in points.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGSize size;

    Swift

    var size: CGSize { get set }
    View Source on GitHub

  • Indicates whether a snapshot is currently being generated.

    Declaration

    Objective-C

    @property (readonly, getter=isLoading, nonatomic) BOOL loading;

    Swift

    var isLoading: Bool { get }
    View Source on GitHub