com.tomtom.online.sdk.map

Interface UiSettings

All Superinterfaces:

Persistable, UIMapSettings

public interface UiSettings
extends UIMapSettings, Persistable

Settings for manipulating map settings related to UI (e.g. styling). To obtain this interface, call TomtomMap.getUiSettings()

Method Summary

Modifier and Type	Method and Description
CameraPosition	getCameraPosition() Get current camera position of the map.
com.tomtom.online.sdk.map.ui.compass.CompassView	getCompassView() The CompassView component.
CopyrightsViewAdapter	getCopyrightsViewAdapter() The CopyrightsViewAdapter object.
com.tomtom.online.sdk.map.ui.currentlocation.CurrentLocationView	getCurrentLocationView() The CenterOnCurrentLocationView component.
LogoView	getLogoView() The LogoView component.
MapLayersType	getMapLayersType() Get information about current map layer settings.
MapModeType	getMapModeType() Get current map mode type.
MapTilesType	getMapTilesType() Get information about current map tiles settings.
com.tomtom.online.sdk.map.ui.arrowbuttons.PanningControlsView	getPanningControlsView() The PanningControlsView component.
com.tomtom.online.sdk.map.ui.zoom.ZoomingControlsView	getZoomingControlsView() The ZoomingControlsView component.
double	getZoomLevel() Get current zoom level.
boolean	is2D() True the map is in 2D Mode, otherwise false.
boolean	isMyLocationEnabled() Verify whether location is enabled or not.
void	setCameraPosition(CameraPosition cameraPosition) Set map camera position.
void	setCopyrightsViewAdapter(CopyrightsViewAdapter adapter) Set CopyrightsViewAdapter to manage the copyrights view component.
void	setMapLayersType(MapLayersType mapLayerType) Set map layers.
void	setMapModeType(MapModeType mapModeType) Set map mode to 2D or 2.5D.
void	setMapTilesType(MapTilesType mapTilesType) Set map tiles to RASTER or VECTOR.

Methods inherited from interface com.tomtom.online.sdk.map.UIMapSettings

setStyleJson, setStyleUrl

Methods inherited from interface com.tomtom.online.sdk.map.Persistable

onViewStateRestored

Method Detail

is2D

boolean is2D()

True the map is in 2D Mode, otherwise false.

setMapModeType

void setMapModeType(MapModeType mapModeType)

Set map mode to 2D or 2.5D. Default value is set to MapModeType.MODE_2D.

setMapTilesType

void setMapTilesType(MapTilesType mapTilesType)

Set map tiles to RASTER or VECTOR. Default value is set to MapTilesType.VECTOR.

setMapLayersType

void setMapLayersType(MapLayersType mapLayerType)

Set map layers. Default value is set to MapLayersType.BASIC. When MapTilesType is set to MapTilesType.NONE, this method does nothing.

setCameraPosition

void setCameraPosition(CameraPosition cameraPosition)

Set map camera position. Using that, you can center map on a specified position, zoom to a certain zoom and rotate map.

getMapModeType

MapModeType getMapModeType()

Get current map mode type.

getMapTilesType

MapTilesType getMapTilesType()

Get information about current map tiles settings.

getMapLayersType

MapLayersType getMapLayersType()

Get information about current map layer settings.

getCameraPosition

CameraPosition getCameraPosition()

Get current camera position of the map.

isMyLocationEnabled

boolean isMyLocationEnabled()

Verify whether location is enabled or not. Use TomtomMap.isMyLocationEnabled().

getZoomLevel

double getZoomLevel()

Get current zoom level.

getCompassView

com.tomtom.online.sdk.map.ui.compass.CompassView getCompassView()

The CompassView component. It can be used to manage the Compass visibility on the map. Moreover it can be a proxy to obtain the ImageView used by the CompassView.

Returns:

the CompassView which is an interface to manage the compass on the map.

getCurrentLocationView

com.tomtom.online.sdk.map.ui.currentlocation.CurrentLocationView getCurrentLocationView()

The CenterOnCurrentLocationView component. It can be used to manage the CenterOnCurrentLocation button visibility on the map. Moreover it can be a proxy to obtain the ImageView used by the CenterOnCurrentLocationView.

Returns:

the CompassView which is an interface to manage the compass on the map.

getPanningControlsView

com.tomtom.online.sdk.map.ui.arrowbuttons.PanningControlsView getPanningControlsView()

The PanningControlsView component. It can be used to manage the PanningControlsView component visibility on the map. Moreover it can be a proxy to obtain the ArrowButtonsGroup view used by the PanningControlsView.

Returns:

the PanningControlsView which is an interface to manage the controls used to pan the map.

getZoomingControlsView

com.tomtom.online.sdk.map.ui.zoom.ZoomingControlsView getZoomingControlsView()

The ZoomingControlsView component. It can be used to manage the ZoomingControlsView component visibility on the map. Moreover it can be a proxy to obtain the ZoomButtonsGroup view used by the ZoomingControlsView.

Returns:

the ZoomingControlsView which is an interface to manage the controls used to zoom in and zoom out the map.

getLogoView

LogoView getLogoView()

The LogoView component. It can be used to manage TomTom logo component visible on the map.

Returns:

the LogoView which is an interface to manage TomTom logo on the map.

setCopyrightsViewAdapter

@Beta(year=2020,
      month=6)
void setCopyrightsViewAdapter(CopyrightsViewAdapter adapter)

Set CopyrightsViewAdapter to manage the copyrights view component.

getCopyrightsViewAdapter

@Beta(year=2020,
      month=6)
CopyrightsViewAdapter getCopyrightsViewAdapter()

The CopyrightsViewAdapter object. It can be used to manage the copyrights view component.

Returns:

the CopyrightsViewAdapter which is an interface to manage the copyrights view.