TomTomMap

Delegate of the TomTomMap.

Data source of the TomTomMap.

The language to be used for labels returned in the response. It should be one of the supported IETF language code tags described here or one of the custom language tags. When data in a specified language is not available for a specific label, the default language is used. Default value: NGT (Neutral Ground Truth)

Defines the map styles available to the user.

main: By default this is the TomTom light style. dark: By default this is the TomTom dark style. When MapOptions.mapStyle.darkStyle is not set, setting map.styleMode = .dark will have no effect.

An Array of the map Layers included in a given style.

Map layers are map elements, for example: Borders, Background, Traffic Incidents, Markers, Labels, etc. Each element of the array contains all the information needed to render a layer. Note that a single element of a map, such as a road, may consist of several layers. You can hide specific map layers to get the level of detail you need and highlight the layers that are important for your use case. For example, you can toggle the visibility of the background layer using layersForRegexp(pattern:):

 let layers = try? map.layersForRegexp(pattern: NSRegularExpression(pattern: "background", options: []))
 layers?.forEach { $0.isVisible = false } // The background layer won't show on the map.
 layers?.forEach { $0.isVisible = true } // The background layer shows on the map.

An array of MapGestureDisableOption defines the map gestures to be disabled.

You can disable certain gestures, for example, double tapping and tapping by assigning these gestures to this field: map.disabledGestures = [.doubleTap, .tap]

A container for the main and the dark versions of the StyleDefinition.

If darkStyle is not provided, setting TomTomMap.styleMode to dark has no effect.

All Route objects that are currently rendered on the map.

This can be useful when doing collective actions on all routes, such as changing color, setting delegates, etc. For example, changing the color of all routes to UIColor.gray: map.allRoutes.forEach { $0.color = .gray }

A Boolean value indicating whether marker fading is allowed or not.

Marker fading means that as you move farther from a marker on the map, it progressively fades out to reflect increasing distance. By default this value is false.

A Boolean value indicating whether marker shrinking is allowed or not.

Marker shrinking means that as you move farther from a marker on the map, it gradually shrinks in size to reflect increasing distance. By default this value is false.

Sets the exclusive map gestures, prioritizing the specified gesture while blocking others gestures that happen simultaneously.

Adds a new Marker based on the given MarkerOptions.

Adds a new Line based on the given LineOptions.

Adds a new Polygon based on the given PolygonOptions.

Adds a new PolygonOverlay based on the given PolygonOverlayOptions.

Removes an annotation from the map with the given Annotation.

Adds a new Route based on the given RouteOptions.

Removes annotations having a particular tag from the map.

Zooms to the current markers on the map with the given tag to fit them all on the screen with the given margin.

Zooms to the current markers on the map with the given tag to fit them all on the screen with a 0px margin.

Removes all previously added Routes.

Adds a new Circle based on the given CircleOptions.

Remove a route from the map with the given Route.

Remove all annotations from the map that are tagless (tag is nil).

Zooms to the all markers on the map that are tagless (tag is nil) to fit them all on the screen with a 0px margin.

Zooms to all markers on the map that are tagless (tag is nil) so they all fit the screen with the given margin.

Sets the marker distance fading range.

Sets the marker distance shrinking range.

Returns an instance of CLLocationCoordinate2D from the given CGPoint.

Returns an instance of CGPoint from the given CLLocationCoordinate2D.

Brings the given Route to the uppermost layer.

Zooms to all current Routes with the given padding.

Selects an annotation identified by the given Annotation.

Selecting an annotation delegates a call to MapDelegate and MapDataSource.

Deselects an annotation identified by the given Annotation.

Takes a snapshot of the map and return a UIImage.

Takes a snapshot of the map without the given UIViews and return a UIImage.

Fetches an Array of Layers based on the given regex pattern.

The regex is applied to the Layer.id property.

• Example:

  let roads = NSRegularExpression(pattern: ".*[rR]oad.*", options: []))
  mapView.map.layersForRegexp(pattern: roads)
  

Traffic flow shows the difference between current and free-flow speed.

These differences are represented by the following colors: Green indicates that the speeds are the same, meaning there are no traffic jams. Red indicates that traffic is slower than free-flow, meaning that there are traffic jams. You can show real-time traffic flow layers on the map by calling this method.

Hide traffic flow layers from the map.

Traffic incidents shows specific traffic problems such as closed roads, rain, ice on the road, or accidents.

You can show real-time traffic incidents layers on the map by calling this method.

Hide traffic incidents layers from the map.

Register a TrafficIncidentObserver to be notified about traffic incidents clicks.

Show hillshading layers on the map.

Hillshading is an image pyramid that contains elevation data with terrain representation. It can be used for rendering hillshade that shows the topographical shape of hills and mountains.

Hide hillshading layers from the map.

Returns visible region of the map.

The visible region of the map is represented as CLLocationCoordinate2D coordinates, where: farLeft: The far-left coordinate. nearLeft: The near-left coordinate. farRight: The far-right coordinate. nearRight: The near-right coordinate.

Returns the current camera properties.

Camera properties can be: zoom, tilt, rotation, field of view, etc. These properties are updated when applyCamera(_:animationDuration:completion:) or moveCamera(_:) is called with conjunction to a CameraUpdate instance, or when the map camera has changed as the result of gesturing. The camera properties reflects the current state of the camera, therefore it can be as the last CameraUpdate that was applied or the altered state of the camera after gesturing.

Represents how the camera follows the current position.

There are five available tracking modes:

• none: No camera tracking.
• followNorthUp: Camera follows the current position.
• followRouteDirection: Camera follows the current position and heading, while adjusting tilt and scale to best present the route and its guidance instructions.
• followDirection: Camera follows the current position and heading.
• routeOverview: The operator tries to fit the routes in the current view, by changing the camera zoom and look-at parameters. It constantly adjusts these parameters to keep the remaining part of the route(s) in view. Tilt and heading parameters are set to 0 in this camera mode.

Applies a CameraUpdate with with a given duration for the animation.

In the Map Display SDK, every change to the camera’s position must be done using the CameraUpdate class. The CameraUpdate class specifies the camera’s location, zoom, tilt, and rotation to set.

Applies a CameraUpdate with no animation.

In the Map Display SDK, every change to the camera’s position must be done using the CameraUpdate class. The CameraUpdate class specifies the camera’s location, zoom, tilt, and rotation to set.

Stops the current ongoing CameraUpdate animation.

This can be useful in cases where multiple CameraUpdates are being dispatched and it is imperative to call this method in-between to prevent multiple animations colliding.

Fetches all map features, such as annotations and map layers at the given CLLocationCoordinate2D.

Fetches all map features, such as annotations and map layers at the given CLLocationCoordinate2D filtered by the given RenderedFeatureQueryOptions.

Fetches all map features, such as annotations and map layers within the given CoordinateBounds.

Fetches all map features, such as annotations and map layers within the given CoordinateBounds filtered by the given RenderedFeatureQueryOptions.

Provides different location services.

The location services are: start(): Starts the location engine. It might be called from a private queue. stop(): Stops the location engine. It might be called from a private queue. location: The last location received. It will be nil until a location has been received. addObserver: Add an observer to the location engine. removeObserver: Remove an observer from the location engine.

Validates if the location is valid or not.

Validation is checked by if the location is fixed or not. The GPS fix status indicates the quality of the signal, or the accuracy and reliability of the location being reported. The LocationProvider module provides the DefaultLocationValidator as a default validator, but it is also possible to create a custom one.

Type of the location marker’s visualization.

Can be used to change the location marker’s scale and or image, the options are:

• navigationChevron: The location marker is rendered in a chevron pattern that can be added to the marker’s scale.
• userLocation: The location marker is rendered as a position marker, with the heading to be added to the marker’s scale.
• custom: Gives the ability to add a custom .glb model as a location indicator. The project path that the custom model should be provided to is as follows: asset://file.glb. Markers size will be changed depending on current zoom level and scale parameter. For more information about the model core requirements and supported features, refer to LocationIndicator.custom.
• none: No location marker will be rendered on the map.

The default marker is LocationIndicator.navigationChevron with a scale of 1.

Starts the location engine.

The location engine will start updating the current location. After starting the location engine, it is possible to receive the last known location by calling: mapView.map.locationProvider.location Might be called from a private queue.

Stops the location engine.

The location engine stops updating the current location. Might be called from a private queue.

Show vehicle restrictions layers on the map respective to the given Vehicle.

Show vehicle restrictions layers on the map respective to the current Vehicle.

If a Vehicle wasn’t set, it is imperative to set the Vehicle before calling this function, and reload the style after calling function to see the vehicle restrictions layers on the map.

Hide vehicle restrictions layers from the map.

Updates the current Vehicle information.