Snapshotter

 
public class Snapshotter
extension Snapshotter: MapEventsObservable

Undocumented

  • A style object that can be manipulated to set different styles for a snapshot

    Declaration

    Swift

    public let style: Style

  • Initialize a Snapshotter instance

    Declaration

    Swift

    public init(options: MapSnapshotOptions)

    Parameters

    options

    Options describing an intended snapshot

  • The size of the snapshot

    Declaration

    Swift

    public var snapshotSize: CGSize { get set }

  • The current camera state of the snapshotter

    Declaration

    Swift

    public var cameraState: CameraState { get }

  • Sets the camera of the snapshotter

    Declaration

    Swift

    public func setCamera(to cameraOptions: CameraOptions)

    Parameters

    cameraOptions

    The target camera options

  • In the tile mode, the snapshotter fetches the still image of a single tile.

    Declaration

    Swift

    public var tileMode: Bool { get set }

  • Request a new snapshot. If there is a pending snapshot request, it is cancelled automatically.

    Declaration

    Swift

    public func start(overlayHandler: SnapshotOverlayHandler?,
                  completion: @escaping (Result<UIImage, SnapshotError>) -> Void)

    Parameters

    overlayHandler

    The optional block to call after the base map finishes drawing, but before the final snapshot has been drawn. This block provides a SnapshotOverlayHandler type, which can be used with Core Graphics to draw custom content directly over the snapshot image.
    completion

    The block to call once the snapshot has been generated, providing a Result<UIImage, SnapshotError> type.

  • Cancels the current snapshot operation.The callback passed to the start method is called with error parameter set.

    Declaration

    Swift

    public func cancel()

  • Undocumented

    See more

    Declaration

    Swift

    public enum SnapshotError : Error

Camera

  • Returns the coordinate bounds corresponding to a given CameraOptions

    Declaration

    Swift

    public func coordinateBounds(for camera: CameraOptions) -> CoordinateBounds

    Parameters

    camera

    The camera for which the coordinate bounds will be returned.

    Return Value

    CoordinateBounds for the given CameraOptions

  • Calculates a CameraOptions to fit a list of coordinates.

    Declaration

    Swift

    public func camera(for coordinates: [CLLocationCoordinate2D],
                   padding: UIEdgeInsets,
                   bearing: Double?,
                   pitch: Double?) -> CameraOptions

    Parameters

    coordinates

    Array of coordinates that should fit within the new viewport.
    padding

    The new padding to be used by the camera.
    bearing

    The new bearing to be used by the camera.
    pitch

    The new pitch to be used by the camera.

    Return Value

    A CameraOptions that fits the provided constraints

Snapshotter