Protocols

The following protocols are available globally.

AppUIInstanceStateObservable

  • Observer of Application UI Instance state UI Instance is represented by UIScene (there could be multiple UIScene instances per iOS application) or UIApplication (there is a single instance of UIApplication class per iOS application).

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol AppUIInstanceStateObservable : Observer

ApplicationLifecycleMonitoring

  • Monitors the iOS application lifecycle and notifies observers on state changes.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol ApplicationLifecycleMonitoring

CameraActions

  • A protocol that defines camera actions.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol CameraActions : AnyObject

CopyrightsService

  • CopyrightsServiceProtocol defines a method used to obtain the copyright informations.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol CopyrightsService

LocationActions

  • Type to control location features.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol LocationActions : AnyObject
  • MapActions defines a set of methods closely connected to the map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol MapActions : AnyObject

Layer

  • The Layer protocol that represents map layer.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol Layer : AnyObject

Style

  • The Style protocol that represents the map style.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol Style : AnyObject

AnnotationOptions

  • Base protocol for AnnotationOptions

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public protocol AnnotationOptions

Annotation

  • Base protocol for any Annotation: polygon, line, circle, marker etc.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol Annotation : AnyObject

Circle

  • Protocol that represents the requirements of a circle

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol Circle : Annotation

Line

  • The Line.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol Line : Annotation

PolygonOverlay

  • A polygon overlay can be built by setting the outer area color and adding inner polygons. Only one inner polygon is supported, but the inner polygons can be nested. Example:

       let innerOptions = InnerPolygonOptions(fillColor: .red
                                          coordinates: coordinates)
    
       innerOptions.nestedPolygonOptions = InnerPolygonOptions(
           fillColor: UIColor.blue,
           coordinates: coordinates
       )
    
       let polygonOptions = PolygonOverlayOptions(outerColor: .green,
                                              innerPolygonOptions: innerOptions)
    
       try? mapView.map.addPolygonOverlay(options: polygonOptions)
    

    }

    See more

    Declaration

    Swift

    public protocol PolygonOverlay : Annotation

Marker

  • Protocol that defines requirements for a marker.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public protocol Marker : Annotation

Polygon

  • Protocol that represents the requirements of a polygon.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol Polygon : Annotation
  • A protocol that defines map annotation actions.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol AnnotationsActions : AnyObject
  • Rendered Feature Actions protocol.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol RenderedFeatureActions

RouteDelegate

  • RouteDelegate.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol RouteDelegate : AnyObject

Route

  • Protocol specifying the Route object.

    See more

    Declaration

    Swift

    public protocol Route : AnyObject
  • Protocol allowing management of the route representation on the map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol RouteActions
  • Protocol that defines method that will be performed when user clicked on traffic incidents icon.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol OnTrafficIncidentObservable : Observer

MapRendererFrameCaptureDelegate

  • MapMetalRendererFrameCaptureDelegate exposes possibility to get currently drawn frame as a texture. Using this delegate may have impact of performance rendering.

    Declaration

    Swift

    public protocol MapRendererFrameCaptureDelegate : AnyObject

MapViewDelegate

  • The MapViewDelegate informs when map is ready.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol MapViewDelegate : AnyObject

MapDataSource

  • The methods that an object adopts to manage callout views for a MapView.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol MapDataSource : AnyObject

MapDelegate

  • A protocol that provides actions delegate from Map allowing you to interact with the map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public protocol MapDelegate : AnyObject

Map