MapView

 
open class MapView : UIView

Undocumented

  • Undocumented

    Declaration

    Swift

    public private(set) var mapboxMap: MapboxMap! { get set }

  • The gestures object will be responsible for all gestures on the map.

    Declaration

    Swift

    public private(set) var gestures: GestureManager! { get }

  • The ornamentsobject will be responsible for all ornaments on the map.

    Declaration

    Swift

    public private(set) var ornaments: OrnamentsManager! { get }

  • The camera object manages a camera’s view lifecycle.

    Declaration

    Swift

    public private(set) var camera: CameraAnimationsManager! { get }

  • The locationobject handles location events of the map.

    Declaration

    Swift

    public private(set) var location: LocationManager! { get }

  • Controls the addition/removal of annotations to the map.

    Declaration

    Swift

    public private(set) var annotations: AnnotationOrchestrator! { get }

  • Manages the configuration of custom view annotations on the map.

    Declaration

    Swift

    public private(set) var viewAnnotations: ViewAnnotationManager! { get }

  • ViewportManager provides a high-level and extensible API for driving the map camera. It provides built-in states for following the location puck and showing an overview of a GeoJSON geometry, and enables the creation of custom states. Transitions between states can be animated with a built-in default transition and via custom transitions.

    Declaration

    Swift

    public private(set) var viewport: ViewportManager! { get }

  • A Boolean value that indicates whether the underlying CAMetalLayer of the MapView presents its content using a CoreAnimation transaction

    By default, this is false resulting in the output of a rendering pass being displayed on the CAMetalLayer as quickly as possible (and asynchronously). This typically results in the fastest rendering performance.

    If, however, the MapView is overlaid with a UIKit element which must be pinned to a particular lat-long, then setting this to true will result in better synchronization and less jitter.

    Declaration

    Swift

    public var presentsWithTransaction: Bool { get set }

  • Undocumented

    Declaration

    Swift

    open override var isOpaque: Bool { get set }

  • The preferred frames per second used for map rendering.

    Note

    preferredFrameRateRange is available for iOS 15.0 and above.

    Declaration

    Swift

    @available(iOS, deprecated: 15, message: "Use preferredFrameRateRange instead.")
public var preferredFramesPerSecond: Int { get set }

  • The preferred range of frame refresh rates.

    Declaration

    Swift

    @available(iOS 15.0, *)
public var preferredFrameRateRange: CAFrameRateRange { get set }

  • The map’s current camera

    Declaration

    Swift

    @available(*, deprecated, renamed: "mapboxMap.cameraState")
public var cameraState: CameraState { get }

  • The map’s current anchor, calculated after applying padding (if it exists)

    Declaration

    Swift

    @available(*, deprecated, renamed: "mapboxMap.anchor")
public var anchor: CGPoint { get }

  • Debug options for the current MapView and it’s native MapboxMap

    Declaration

    Swift

    public var debugOptions: MapViewDebugOptions { get set }

  • Initialize a MapView

    Declaration

    Swift

    @available(iOSApplicationExtension, unavailable)
public init(frame: CGRect, mapInitOptions: MapInitOptions = MapInitOptions())

    Parameters

    frame

    frame for the MapView.
    mapInitOptions

    The options to initialize the Maps API with.

  • Initialize a MapView

    Declaration

    Swift

    public init(frame: CGRect,
            mapInitOptions: MapInitOptions = MapInitOptions(),
            urlOpener: AttributionURLOpener)

    Parameters

    frame

    frame for the MapView.
    mapInitOptions

    The options to initialize the Maps API with.
    urlOpener

    Attribution URL opener

  • Undocumented

    Declaration

    Swift

    required public init?(coder: NSCoder)

  • Undocumented

    Declaration

    Swift

    open override func awakeFromNib()

  • Undocumented

    Declaration

    Swift

    open override func layoutSubviews()

  • Undocumented

    Declaration

    Swift

    @_spi(Metrics)
public var metricsReporter: MapViewMetricsReporter?

  • Undocumented

    Declaration

    Swift

    open override func didMoveToWindow()

  • Errors related to rendered snapshots

    See more

    Declaration

    Swift

    public struct SnapshotError : Error, Equatable

  • Synchronously captures the rendered map as a UIImage. The image does not include the ornaments (scale bar, compass, attribution, etc.) or any other custom subviews. Use drawHierarchy(in:afterScreenUpdates:) directly to include the full hierarchy.

    Declaration

    Swift

    public func snapshot() throws -> UIImage

    Return Value

    A UIImage of the rendered map