MapboxMap Class Reference

style
The style object supports run time styling.
Declaration
Swift

public internal(set) var style: Style { get }

Style loading


                    
                    
                    loadStyleURI(_:completion:)

Loads a style from a StyleURI, calling a completion closure when the style is fully loaded or there has been an error during load.

Declaration

Swift

public func loadStyleURI(_ styleURI: StyleURI, completion: ((Result<Style, Error>) -> Void)? = nil)

Parameters

`styleURI`	StyleURI to load
`completion`	Closure called when the style has been fully loaded. The `Result` type encapsulates the `Style` or error that occurred. See `MapLoadingError`


                    
                    
                    loadStyleJSON(_:completion:)

Loads a style from a JSON string, calling a completion closure when the style is fully loaded or there has been an error during load.

Declaration

Swift

public func loadStyleJSON(_ JSON: String, completion: ((Result<Style, Error>) -> Void)? = nil)

Parameters

`styleURI`	Style JSON string
`completion`	Closure called when the style has been fully loaded. The `Result` type encapsulates the `Style` or error that occurred. See `MapLoadingError`

Prefetching

prefetchZoomDelta
When loading a map, if prefetchZoomDelta is set to any number greater than 0, the map will first request a tile for zoom - prefetchZoomDelta in an attempt to display a full map at lower resolution as quick as possible.

It will get clamped at the tile source minimum zoom. The default delta is 4.
Declaration
Swift

public var prefetchZoomDelta: UInt8 { get set }
resourceOptions
Gets the resource options for the map.

All optional fields of the returned object are initialized with the actual values.

Note
The result of this property is different from the ResourceOptions that were provided to the map’s initializer.
Declaration
Swift

public var resourceOptions: ResourceOptions { get }


                    
                    
                    clearData(for:completion:)

Clears temporary map data.

Clears temporary map data from the data path defined in the given resource options. Useful to reduce the disk usage or in case the disk cache contains invalid data.

Note

Calling this API will affect all maps that use the same data path and does not affect persistent map data like offline style packages.

Declaration

Swift

public static func clearData(for resourceOptions: ResourceOptions, completion: @escaping (Error?) -> Void)

Parameters

`resourceOptions`	The `resource options` that contain the map data path to be used
`completion`	Called once the request is complete


                    
                    
                    elevation(at:)

Gets elevation for the given coordinate.

Note

Elevation is only available for the visible region on the screen.

Declaration

Swift

public func elevation(at coordinate: CLLocationCoordinate2D) -> Double?

Parameters


                                  coordinate

Coordinate for which to return the elevation.

Return Value

Elevation (in meters) multiplied by current terrain exaggeration, or empty if elevation for the coordinate is not available.

Camera Fitting


                    
                    
                    coordinateBounds(for:)

Transforms a view’s frame into a set of coordinate bounds

Declaration

Swift

public func coordinateBounds(for rect: CGRect) -> CoordinateBounds

Parameters


                                  rect

The rect whose bounds will be transformed into a set of map coordinate bounds.

Return Value

A CoordinateBounds object that represents the southwest and northeast corners of the view’s bounds.


                    
                    
                    rect(for:)

Transforms a set of map coordinate bounds to a CGRect relative to the MapView.

Declaration

Swift

public func rect(for coordinateBounds: CoordinateBounds) -> CGRect

Parameters


                                  coordinateBounds

The coordinateBounds that will be converted into a rect relative to the MapView

Return Value

A CGRect whose corners represent the vertices of a set of CoordinateBounds.

options
Declaration
Swift

public var options: MapOptions { get }

CameraManagerProtocol


                    
                    
                    camera(for:padding:bearing:pitch:)

Declaration

Swift

public func camera(for coordinateBounds: CoordinateBounds,
                   padding: UIEdgeInsets,
                   bearing: Double?,
                   pitch: Double?) -> CameraOptions


                    
                    
                    camera(for:padding:bearing:pitch:)

Declaration

Swift

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


                    
                    
                    camera(for:camera:rect:)

Declaration

Swift

public func camera(for coordinates: [CLLocationCoordinate2D],
                   camera: CameraOptions,
                   rect: CGRect) -> CameraOptions


                    
                    
                    camera(for:padding:bearing:pitch:)

Declaration

Swift

public func camera(for geometry: Turf.Geometry,
                   padding: UIEdgeInsets,
                   bearing: CGFloat?,
                   pitch: CGFloat?) -> CameraOptions

CameraOptions to CoordinateBounds


                    
                    
                    coordinateBounds(for:)

Declaration

Swift

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


                    
                    
                    coordinateBoundsZoom(for:)

Declaration

Swift

public func coordinateBoundsZoom(for camera: CameraOptions) -> CoordinateBoundsZoom


                    
                    
                    coordinateBoundsZoomUnwrapped(for:)

Declaration

Swift

public func coordinateBoundsZoomUnwrapped(for camera: CameraOptions) -> CoordinateBoundsZoom


                    
                    
                    coordinate(for:)

Declaration

Swift

public func coordinate(for point: CGPoint) -> CLLocationCoordinate2D


                    
                    
                    point(for:)

Declaration

Swift

public func point(for coordinate: CLLocationCoordinate2D) -> CGPoint


                    
                    
                    points(for:)

Declaration

Swift

public func points(for coordinates: [CLLocationCoordinate2D]) -> [CGPoint]


                    
                    
                    coordinates(for:)

Declaration

Swift

public func coordinates(for points: [CGPoint]) -> [CLLocationCoordinate2D]

Camera options setters/getters


                    
                    
                    setCamera(to:)

Declaration

Swift

public func setCamera(to cameraOptions: CameraOptions)


                    
                    
                    cameraState

Declaration

Swift

public var cameraState: CameraState { get }


                    
                    
                    freeCameraOptions

Declaration

Swift

public var freeCameraOptions: FreeCameraOptions { get set }

cameraBounds
Returns the bounds of the map.
Declaration
Swift

public var cameraBounds: CameraBounds { get }


                    
                    
                    setCameraBounds(for:)

Sets the bounds of the map.

Throws

MapError

Declaration

Swift

public func setCameraBounds(for options: CameraBoundsOptions) throws

Parameters


                                  options

New camera bounds. Nil values will not take effect.

Drag API


                    
                    
                    dragStart(for:)

Declaration

Swift

public func dragStart(for point: CGPoint)


                    
                    
                    dragCameraOptions(from:to:)

Declaration

Swift

public func dragCameraOptions(from: CGPoint, to: CGPoint) -> CameraOptions

dragEnd()
Declaration
Swift

public func dragEnd()

MapFeatureQueryable


                    
                    
                    queryRenderedFeatures(for:options:completion:)

Declaration

Swift

public func queryRenderedFeatures(for shape: [CGPoint], options: RenderedQueryOptions? = nil, completion: @escaping (Result<[QueriedFeature], Error>) -> Void)


                    
                    
                    queryRenderedFeatures(in:options:completion:)

Declaration

Swift

public func queryRenderedFeatures(in rect: CGRect, options: RenderedQueryOptions? = nil, completion: @escaping (Result<[QueriedFeature], Error>) -> Void)


                    
                    
                    queryRenderedFeatures(at:options:completion:)

Declaration

Swift

public func queryRenderedFeatures(at point: CGPoint, options: RenderedQueryOptions? = nil, completion: @escaping (Result<[QueriedFeature], Error>) -> Void)


                    
                    
                    querySourceFeatures(for:options:completion:)

Declaration

Swift

public func querySourceFeatures(for sourceId: String,
                                options: SourceQueryOptions,
                                completion: @escaping (Result<[QueriedFeature], Error>) -> Void)


                    
                    
                    queryFeatureExtension(for:feature:extension:extensionField:args:completion:)

Declaration

Swift

public func queryFeatureExtension(for sourceId: String,
                                  feature: Turf.Feature,
                                  extension: String,
                                  extensionField: String,
                                  args: [String: Any]? = nil,
                                  completion: @escaping (Result<FeatureExtensionValue, Error>) -> Void)

ObservableProtocol


                    
                    
                    subscribe(_:events:)

Declaration

Swift

public func subscribe(_ observer: Observer, events: [String])


                    
                    
                    unsubscribe(_:events:)

Declaration

Swift

public func unsubscribe(_ observer: Observer, events: [String] = [])

Map Event handling


                    
                    
                    onNext(_:handler:)

Declaration

Swift

@discardableResult
public func onNext(_ eventType: MapEvents.EventKind, handler: @escaping (Event) -> Void) -> Cancelable


                    
                    
                    onEvery(_:handler:)

Declaration

Swift

@discardableResult
public func onEvery(_ eventType: MapEvents.EventKind, handler: @escaping (Event) -> Void) -> Cancelable

Map data clearing


                    
                    
                    clearData(completion:)

Clears temporary map data.

Clears temporary map data from the data path defined in the given resource options. Useful to reduce the disk usage or in case the disk cache contains invalid data.

Note

Calling this API will affect all maps that use the same data path and does not affect persistent map data like offline style packages.

Declaration

Swift

public func clearData(completion: @escaping (Error?) -> Void)

Parameters


                                  completion

Called once the request is complete