com.tomtom.online.sdk.map

Package com.tomtom.online.sdk.map

Types

AnimationDuration	`data class AnimationDuration` Describes the duration of an animation associated with a user-facing action. Creating an instance with the .createDefault method uses the default duration, defined internally in the SDK.
Annotation	`interface Annotation : Serializable` The base interface that describes common methods used by each element that can be added to the map (e.g., marker or overlay).
ApiKeyType	`class ApiKeyType` Enum for TomTom services API keys
BalloonViewAdapter	`interface BalloonViewAdapter<T : MarkerBalloon!, E : MapPoint!>` The adapter of balloon view. An implement interface to inflate a balloon adapter.
BaseBalloonViewAdapter	`abstract class BaseBalloonViewAdapter<T : MarkerBalloon!> : BalloonViewAdapter<T, Marker!>` Base adapter for markers balloons. Implementation of adapter design pattern.
BaseGpsPositionIndicator	`open class BaseGpsPositionIndicator : GpsIndicator` Base class defining the position indicator that can be added to the map.
BaseMarkerBalloon	`open class BaseMarkerBalloon : MarkerBalloon` Model of the `MarkerBalloon` view. You can add properties to the model. Properties will be serialize to `String` and restored after rotation.
BuildConfig	`class BuildConfig` `class BuildConfig`
CameraCallbacksExtension	`interface CameraCallbacksExtension` Interface defining callbacks regarded to camera events.
CameraFocusArea	`data class CameraFocusArea` A class that describes the starting position of the map with a bounding box, together with its bearing, pitch, and padding. To construct, use CameraFocusArea.Builder.
CameraPosition	`data class CameraPosition` A class that that describes all camera position parameters, such as location, zoom level, pitch angle, and bearing. To construct, use a CameraPositionBuilder.
Chevron	`interface Chevron : NativeObject` Base interface defining a chevron indicator that can be added to the map. When a new location is set, animation is used to move the chevron.
ChevronBuilder	`open class ChevronBuilder` Builder for the `Chevron`. It is required to pass a valid `Icon` and optionally a starting `ChevronPosition`.
ChevronPosition	`open class ChevronPosition : Serializable` Describes a chevron position on the map.
Circle	`interface Circle : Overlay, MapPoint` The base interface defining a circle that can be added to the map.
DashDescriptor	`open class DashDescriptor` Class used to describe dash length and gap between dashes.
DefaultGpsPositionIndicator	`open class DefaultGpsPositionIndicator : BaseGpsPositionIndicator` Default GPS indicator implementation. The GPS position icon is shown without any accuracy radius, when accuracy is less than 10 meters. On the other hand, when accuracy is more than 10000 meters, the indicator is dimmed (gray icon). Otherwise, the radius showing GPS accuracy is visible.
DefaultOnTrafficFlowClickListener	`open class DefaultOnTrafficFlowClickListener : OnTrafficFlowClickListener` Default implementation `OnTrafficFlowClickListener`. To write a custom traffic click listener implement `OnTrafficFlowClickListener` and set implementation to `TrafficSettings#setOnTrafficFlowClickListener(OnTrafficFlowClickListener)`. Default implementation show popup with information about traffic flow.
DefaultOnTrafficIncidentClickListener	`open class DefaultOnTrafficIncidentClickListener : OnTrafficIncidentsClickListener` Default implementation for traffic incident click listener. When traffic cluster clicked zoom in map. When traffic incident flow clicked show popup. When traffic incident poi clicked show popup.
DisplaySettings	`interface DisplaySettings` This interface defines operations on displayed map components (e.g. retrieving rendered features).
DrivingSettings	`interface DrivingSettings : Persistable` Advanced settings for driving options manipulation. To obtain this interface, call `TomtomMap#getDrivingSettings()`.
GpsIndicator	`interface GpsIndicator : Serializable` The base interface defining a GPS indicator that can be added to the map.
Icon	`open class Icon` Class that represents image on the map. It can be used e.g. as a visual representation of a marker.
LayerSetConfiguration	`open class LayerSetConfiguration` Class representing a custom layer set configuration.
LocationSourceExtension	`interface LocationSourceExtension` Interface to provide location data for TomtomMap object. A TomtomMap has a built-in location provider based on FusedLocation from Google Play Services. However, the user can provide custom location provider and override the default implementation.
LogoSettings	`interface LogoSettings` Settings for manipulating logo colors. To obtain this interface, call `TomtomMap#getLogoSettings()`
MapBalloonViewAdapter	`abstract class MapBalloonViewAdapter<T : MarkerBalloon!> : BalloonViewAdapter<T, MapPoint!>` View adapter for map balloon - balloon displayed on map and related with point on the map.
MapCallbacksExtension	`interface MapCallbacksExtension` Interface defining callbacks regarded map events.
MapConstants	`open class MapConstants` Map related constants.
MapFragment	`open class MapFragment : Fragment` Fragment is the simplest way to place a map in an application. It is a wrapper around a map view that handles map lifecycle.
MapInfoExtension	`interface MapInfoExtension` Interface to provide information about general map settings (e.e.g user location, locale)
MapLayers	`open class MapLayers` Settings to manipulate map layers options.
MapManipulationExtension	`interface MapManipulationExtension` This interface defines map operations that allow the application of map manipulation operations, e.g., center a map on the given location, or zoom to a specific level.
MapPadding	`open class MapPadding` Encapsulates map padding from each side
MapPoint	`interface MapPoint` The representation of the point on the map.
MapProperties	`open class MapProperties` Initial configuration of the map.
MapStyleSource	`class MapStyleSource` Defines the mode in which a map will be loaded.
MapTiles	`open class MapTiles` Settings to manipulate map tiles options.
MapView	`open class MapView : FrameLayout, UiComponentsLayer, UIMapSettings` A view used to display a map. When you want to use this view directly, you need to pass forward all life cycle methods to this class (e.g. onPause, onResume).
MapViewExtension	`interface MapViewExtension` Interface that provides methods to manipulate map mode and layouts (e.g. set 2D/3D mode, turn on/off traffic layer).
Marker	`interface Marker : Annotation, MapPoint` Base interface defining marker that can be added to the map.
MarkerAnchor	`class MarkerAnchor : Serializable` The anchor property of the marker.
MarkerBalloon	`interface MarkerBalloon : Serializable` A marker balloon is a model of the view of a box above the marker.
MarkerBuilder	`open class MarkerBuilder` Builder class used to construct marker object that can be added to the map.
MarkerExtension	`interface MarkerExtension` Basic settings for markers manipulation.
MarkersCallbackExtension	`interface MarkersCallbackExtension` Callback interface for methods that are called to register for markers events.
MarkerSettings	`interface MarkerSettings : MarkerExtension, MarkersCallbackExtension, Persistable, TomtomMapCallback.OnMapTapListener, TomtomMapCallback.OnMapChangedListener` Advanced settings for markers manipulation. To obtain this interface, call TomtomMap.getMarkerSettings
NativeMapConfig	`open class NativeMapConfig`
OnMapReadyCallback	`interface OnMapReadyCallback` Callback interface executed when the map is ready to be used. The instance of this interface is set to `MapFragment`, and the `OnMapReadyCallback#onMapReady(TomtomMap)` is triggered when the map is fully initialized and not-null.
OnMarkerSelectedListener	`interface OnMarkerSelectedListener` A listener which defines the behavior for a selected and unselected marker.
OnTrafficFlowClickListener	`interface OnTrafficFlowClickListener` A callback executed when traffic flow on the map is clicked.
OnTrafficIncidentsClickListener	`interface OnTrafficIncidentsClickListener` A callback executed when traffic incidents are clicked.
Overlay	`interface Overlay : Annotation` A base interface defining map overlay (e.g., circle, polygon).
OverlaysCallbackExtension	`interface OverlaysCallbackExtension` Callback interface for methods that are called to register for overlays events.
OverlaySettings	`interface OverlaySettings : TomtomMapCallback.OnMapTapListener, OverlaysCallbackExtension, Persistable` Settings for overlays manipulation. To obtain this interface, call `TomtomMap#getOverlaySettings()`.
Persistable	`interface Persistable` Interface used to save and restore map state.
Polygon	`interface Polygon : Overlay` A base interface defining polygon that can be added to the map.
Polyline	`interface Polyline : Overlay` A base interface defining polyline that can be added to the map.
Route	`interface Route : Annotation` A base interface defining a route that can be added to the map.
RouteBuilder	`open class RouteBuilder` Builder class used to construct route object that can be added to the map.
RouteCallbackExtension	`interface RouteCallbackExtension` Callback interface for methods that are called to register for annotations (e.g. markers) events.
RouteExtension	`interface RouteExtension` Interface for route manipulation with the map.
RouteSettings	`interface RouteSettings : RouteExtension, TomtomMapCallback.OnMapTapListener, RouteCallbackExtension, Persistable` Advanced settings for routes manipulation. To obtain this interface, call `TomtomMap#getRouteSettings()`
RouteStyle	`open class RouteStyle` Specifies properties of the route like: width, fillColor and outlineColor.
SimpleMarkerBalloon	`open class SimpleMarkerBalloon : BaseMarkerBalloon` Class used for creating a simple marker balloon with one text property Subclass of `BaseMarkerBalloon`.
SingleLayoutBalloonViewAdapter	`open class SingleLayoutBalloonViewAdapter : BaseBalloonViewAdapter<BaseMarkerBalloon!>` Adapter which inflate one single layout for all balloons.
StyleSettings	`interface StyleSettings : Style, UIMapSettings` Advanced settings for style manipulation. To obtain this interface, call `TomtomMap#getStyleSettings()`
TextBalloonViewAdapter	`open class TextBalloonViewAdapter : SingleLayoutBalloonViewAdapter` View the adapter and inflater for the "single line" marker balloon.
TomtomMap	`interface TomtomMap : RouteExtension, MarkerExtension, MapManipulationExtension, MapInfoExtension, MapCallbacksExtension, MapViewExtension, MarkersCallbackExtension, OverlaysCallbackExtension, RouteCallbackExtension, LocationSourceExtension, OnRequestPermissionsResultCallback, CameraCallbacksExtension` Interface that is the main entry point for all methods related to the map. `TomtomMap` is obtained using the `MapFragment#getAsyncMap(OnMapReadyCallback)` method on a `MapFragment`.
TomtomMapCallback	`interface TomtomMapCallback` An interface that provides types to interact with the map.
TrafficExtensions	`interface TrafficExtensions` Traffic extensions
TrafficFlowBalloonViewAdapter	`abstract class TrafficFlowBalloonViewAdapter : MapBalloonViewAdapter<TrafficFlowMapBalloon!>` Default abstract implementation for inflating traffic balloon model. Extends `TrafficFlowBalloonViewAdapter` to provide own implementation of traffic view adapter.
TrafficFlowMapBalloon	`open class TrafficFlowMapBalloon : BaseMarkerBalloon` Model of balloon for traffic flows. Model keep information about traffic flows which are in the immediate vicinity of the clicked area.
TrafficFlowType	`interface TrafficFlowType` The style to be used to render the tile. When style is absolute, the colors will reflect the absolute speed measured. Calls using relative style return the speed relative to free-flow, highlighting areas of congestion. Relative-delay displays relative speeds only where they are different from the free flow speeds. Reduced-sensitivity displays relative speeds but larger difference from free flow (depending on FRC) is required for segment to change the color. There are various types of traffic flow to use. - absolute: reflect the absolute speed - relative: speed relative to free-flow, highlighting areas of congestion - relative-delay: relative speed values different from the ones for the free flow - reduced-sensitivity: - only for raster.
TrafficIncidentsBalloonViewAdapter	`abstract class TrafficIncidentsBalloonViewAdapter : MapBalloonViewAdapter<TrafficIncidentsMapBalloon!>` Default abstract implementation for inflating traffic balloon model. Extends `TrafficIncidentsBalloonViewAdapter` to provide own implementation of traffic view adapter.
TrafficIncidentsMapBalloon	`open class TrafficIncidentsMapBalloon : BaseMarkerBalloon` Representation of traffic incident balloon displayed on map when traffic incident shown.
TrafficIncidentsType	`interface TrafficIncidentsType` The style to be used to render the tile. There are various types of traffic incidents to use. - S1: the basic traffic incidents style - S2: similar to S1 with rounded ends on tubes - S3: similar to S2 with wider shadows.
TrafficSelectedState	`open class TrafficSelectedState : Serializable` Keep information about selected traffic flow.
TrafficSettings	`interface TrafficSettings : TrafficExtensions, TomtomMapCallback.OnMapTapListener, Persistable, TomtomMapCallback.OnMapChangedListener` Settings for manipulating traffic settings related to traffic (e.g. flows). To obtain this interface, call `TomtomMap#getTrafficSettings()`
UiComponentsLayer	`interface UiComponentsLayer` Interface that represents UI components added on top of the map (e.g. compass view).
UIMapSettings	`interface UIMapSettings` Map display settings.
UiSettings	`interface UiSettings : UIMapSettings, Persistable` Settings for manipulating map settings related to UI (e.g. styling). To obtain this interface, call `TomtomMap#getUiSettings()`

Exceptions

UnsupportedStyleConfigurationException

open class UnsupportedStyleConfigurationException : RuntimeException

This exception is raised when the map was initialized with map styles and a legacy method was used.