Class

MKMapSnapshotOptions

The options to use when capturing map-based imagery.

Declaration

@interface MKMapSnapshotOptions : NSObject

Overview

After creating and configuring an instance of this class, you pass that instance to an MKMapSnapshotter object. The snapshotter uses the configuration options to determine which portion of the map to capture, the viewing angle to use for the camera, and the map's overall appearance.

In macOS 10.14 and later, you can apply a light or dark appearance to your map snapshots by modifying the appearance property of your snapshot options. Even if you specify a custom appearance, users can use the Maps app to force all maps to adopt a light appearance.

Topics

Configuring the Snapshot Region

region

The map region that you want to capture.

mapRect

The map rect that you want to capture.

camera

The camera to use when taking the map snapshot.

Configuring the Map Data

mapType

The map’s visual style.

showsBuildings

A Boolean indicating whether the map displays extruded building information.

showsPointsOfInterest

A Boolean indicating whether the map displays point-of-interest information.

Deprecated
pointOfInterestFilter

The filter used to determine the points of interest shown in the snapshot.

Configuring the Image Output

traitCollection

Traits that determine the appearance of the map snapshot.

size

The size of the image that you want to create.

appearance

The visual style (light or dark) to apply to the map when rendering the snapshot image.

scale

The scale factor to use when creating the image.

Relationships

Inherits From

Conforms To

See Also

Creating a Snapshotter Object

- initWithOptions:

Initializes and returns a snapshotter object based on the specified options.