MapView

MapView init method.

Ensure that MapsDisplayService.apiKey is set before calling this method, or use the public init(mapOptions: MapOptions) initializer as follows:

lazy var mapView: MapView = {
    let mapOptions = MapOptions(apiKey: "YOUR MAP KEY")
    let mapView = MapView(mapOptions: mapOptions)
    return mapView
}()

MapView init method, initializes the map with the given MapOptions.

If MapsDisplayService.apiKey was set before calling this method, it will be overwritten with the MapOptions apiKey.

MapView init method.

Ensure that MapsDisplayService.apiKey is set before calling this method, or use the public init(mapOptions: MapOptions) initializer as follows:

lazy var mapView: MapView = {
    let mapOptions = MapOptions(apiKey: "YOUR MAP KEY")
    let mapView = MapView(mapOptions: mapOptions)
    return mapView
}()

MapView init with coder method.

If you are using xib or storyboards, ensure that make sure that MapsDisplayService.apiKey is set before loading the MapView.

The MapViewDelegate protocol that informs you when the MapView object is ready to be used.

The map management object 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. For more information, refer toTomTomMap.

Tells the closure that the specified map view is ready to be used.

When the map view is fully initialized you can use the TomTomMap object to interact with it. The closure passes the ready-to-use TomTomMap of the fully initialized MapView.

Notifies when a new frame is rendered as a texture.

When set, rendering performance may drop.

Object for setting the map camera. Use it to set parameters such as:

• Position
• Zoom
• Tilt
• Rotation Can be used with UIView.animated.

Example:

UIView.animate(withDuration: 5,
               delay: 2,
               options: [.beginFromCurrentState,
                         .allowUserInteraction,
                         .curveEaseIn],
               animations: {
                   self.mapView.cameraUpdate = CameraUpdate(rotation: 180.0)

               }) { _ in }

}

Preferred frames per second. Default value: 60 fps.

The application’s view will choose a frame rate as close as possible to the chosen preferred frames per second based on the capabilities of the screen’s refresh rate.

Sets the scale view’s unit system.

The scale view is located in the lower-right corner of the map. It appears when zooming in or out, then disappears after 5 seconds without any map interaction. It also disappears when the map is tilted or when the scale is out of range.

By default the units are set to metric or imperial based on the system settings. You can change them by modifying this property. For example:

mapView.scaleViewUnitSystem = .uk // UK units system.
mapView.scaleViewUnitSystem = .us // US units system.
mapView.scaleViewUnitSystem = .metric // Metric units system.

Sets the edge insets of the map view to determine space for the safe area.

The safe area is the part of the viewport that is considered completely visible by the user, not covered by UI components such as buttons or sliders.

By default, the edge insets are zero.

Replaces the list of data providers used as an alternative tile source.

Tiles from the old data providers are loaded through the new data providers. If no data provider loads, the default data provider is used internally.

The layout guide that represents the portion of the map view obscured by map scale.

A UILayoutGuide represent a rectangle in the layout engine. It will not be part of the view hierarchy, but may be applied with NSLayoutConstraint.

A Boolean value that determines whether the map view is hidden.

Sets a closure that will be triggered when the map instance is ready to use. The closure will be executed on the main thread.

When the map view is fully initialized you can use the TomTomMap object to interact with it. The closure passes the ready-to-use TomTomMap of the fully initialized MapView.

Tells the view that its window object changed.

Additionally, this implementation validates the display link of the renderer, and adds the current location button to the map view if the view hierarchy is ready.

This represents the compass button on the map. This button provides a quick way for users to change the map to have a northern orientation.

This represents the button that shows the user’s current location on the map.

This represents the scale view on the map. This view provides a quick way for users to change visibility and the scale units.

The ZoomControlsViewModel controls the visibility of the zoom controls and lets you set custom zoom-in and zoom-out icons.

The LogoViewModel allows for control over the visibility a of the logo view.

Sets the scale view visibility on the map.

Sets the logo view visibility on the map.

Compass button visibility policy.

Sets the control compass button visibility on the map. Default value: .visibleWhenNeeded

Current location button visibility policy.

Sets the control current location visibility on the map. Default value: .hidden

Whether the current location button is visible at the moment.