Classes

Class to add a key for the map. The key must be injected before a MapView can be used.

• Example: “” func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { MapsDisplayService.apiKey = “MAP_KEY” […] return true }

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

See more

final public class MapsDisplayService

Default implementation of CopyrightsService.

See more

final public class TomTomCopyrightsService : CopyrightsService

Allows the user to configure the initial parameters of the map.

MapOptions is used in conjunction with MapViewinitialization, i.e: When creating a MapView, it is possible to pass a MapOptions object to configure the MapView before it is showing on the screen, for example, creating a MapView object with the default TomTom style, and a dark style mode: let mapOptions = MapOptions(mapStyle: .defaultStyle, apiKey: "your-key", styleMode: .dark) let mapView = MapView(mapOptions: mapOptions)

Creating a MapView without passing a MapOptions object, will result in the MapView being created using the deafult values. In such case, the API Key that will be used for the map will be taken from MapsDisplayService.apiKey.

See more

public class MapOptions : NSObject

The Layer protocol that represents map layer.

See more

public class Layer

This class provides a container for tiles sources information and map layers.

See more

public final class Style

Represents the circle on the map.

See more

public class Circle : Annotation

Represents the line on the map.

See more

public class Line : Annotation

Represents the marker on the map.

See more

public class Marker : Annotation

Options that defines inner polygon. Can be used with PolygonOverlayOptions.

See more

public class InnerPolygonOptions : AnnotationOptions

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

public class PolygonOverlay : Annotation

Options for creating a PolygonOverlay.

See more

public class PolygonOverlayOptions : AnnotationOptions

Represents the polygon on the map.

See more

public class Polygon : Annotation

A Route representation which can be added and displayed on the map.

To show a Route on the map, call the TomTomMap.addRoute(RouteOptions) method. You can configure its shape and appearance with the RouteOptions class. Drawing a Route on the map requires a list with coordinates of the Route points.

See more

public class Route

The MapView object to wrap the underlying map renderer.

It contains the map created by the renderer in the view hierarchy and provides UI and view life-cycle functionalities. The view can be created programmatically, via xib or storyboards.

For example, displaying a simple MapView programmatically using a constraints-based layout:

Initialization:

lazy var mapView: MapView = {
  let mapOptions = MapOptions(mapStyle: .defaultStyle, apiKey: "your-key")
  let mapView = MapView(mapOptions: mapOptions)
  return mapView
}()

Layout:

mapView.translatesAutoresizingMaskIntoConstraints = false
view.addSubview(mapView)
NSLayoutConstraint.activate([
  mapView.widthAnchor.constraint(equalTo: view.widthAnchor),
  mapView.heightAnchor.constraint(equalTo: view.heightAnchor),
])

Setting up the receival of life-cycle events and updates, as well as setting the initial zoom and position of the map view:

mapView.delegate = self
mapView.cameraUpdate = .init(position: .AMSTERDAM, zoom: 13)

There will also be a need to conform your UIViewController to MapViewDelegate and implement the required methods.

See more

@objc
open class MapView : UIView

The TomTomMap class serves as the foundational class, acting as the primary gateway for integrating a multitude of map-related features. It offers a rich set of functionalities enabling developer interaction with the map and customizing its behavior.

TomTomMap can be accessed in several ways through the MapView class:

• Through the property mapView.map.
• By calling mapView.getMapAsync, i.e., mapView.getMapAsync { map in // do something with map }
• By assigning mapView.onMapReadyCallback, i.e., mapView.onMapReadyCallback = { map in // do something with map }
• By defining mapView(_:, onMapReady:) through the MapDelegate, i.e., func mapView(_: MapView, onMapReady map: TomTomMap) { // do something with the map } In most cases, the preferred way to access the map would be through the property mapView.map, but in some cases where the map should be ready first, such as when calling showVehicleRestrictions(vehicle:) the preferred way would be mapView.getMapAsync or mapView.onMapReadyCallback.

See more

public class TomTomMap : AnnotationsActions, RouteActions, MapActions

extension TomTomMap: CameraActions

extension TomTomMap: RenderedFeatureActions

extension TomTomMap: VehicleActions, LocationActions