Instance Method

startWithCompletionHandler:

Submits the request to create a snapshot and delivers the results to the specified block.

Declaration

- (void)startWithCompletionHandler:(MKMapSnapshotCompletionHandler)completionHandler;

Parameters

completionHandler

The block to call with the resulting snapshot. This block is executed on the app’s main thread and must not be nil.

Discussion

Call this method to begin generating a snapshot image based on the specified parameters. This method executes the request asynchronously.

The snapshotter delivers the final image to your app only when it is running in the foreground. The snapshotter must render the final image while your app is in the foreground. If you start generating a snapshot while the app is in the background, or if your app moves to the background while a snapshot is in progress, this behavior delays the delivery of the snapshot until your app returns to the foreground.

In macOS, this method creates both standard and high-resolution representations of the map data and includes both in the returned image object. In iOS, you must specify the image scale you want using the snapshot options, which default to the scale on the current device.

See Also

Generating a Snapshot

- startWithQueue:completionHandler:

Submits the request to create a snapshot and executes the resulting block on the specified queue.

MKMapSnapshotCompletionHandler

A block that processes the results of a snapshot request.

- cancel

Cancels the current request to create a snapshot.

loading

A Boolean value indicating whether the snapshotter is currently generating an image.