MapboxMap Class Reference

__map
The underlying renderer object responsible for rendering the map
Declaration
Swift

public let __map: Map
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`

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.

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: 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 }

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: 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