public interface

MapSettings

com.neomades.maps.MapSettings

Class Overview

Map Settings.

Summary

Constants
int MAP_TYPE_HYBRID Satellite maps with a transparent layer of major streets.
int MAP_TYPE_NONE No base map tiles (Show nothing on Android).
int MAP_TYPE_NORMAL Basic maps.
int MAP_TYPE_SATELLITE Satellite maps with no labels.
int MAP_TYPE_TERRAIN Terrain maps.
Public Methods
abstract int getMapType()
Gets the type of map that is currently displayed.
abstract boolean isBuildingsEnabled()
Returns if the buildings are currently shown over the map.
abstract boolean isCompassEnabled()
Returns if the compass visual control is currently shown over the map.
abstract boolean isIndoorEnabled()
Returns if the indoor layers are currently shown on the map.
abstract boolean isMyLocationEnabled()
Returns if the user's location is displayed on the map.
abstract boolean isRotateGesturesEnabled()
Returns if the rotate gestures are currently permitted on the map.
abstract boolean isScrollGesturesEnabled()
Returns if the scroll gestures are currently permitted on the map.
abstract boolean isTiltGesturesEnabled()
Returns if the tilt gestures are currently permitted on the map.
abstract boolean isTrafficEnabled()
Returns if the traffic layer is shown or not.
abstract boolean isZoomControlsEnabled()
Returns if the zoom visual controls are currently shown over the map.
abstract boolean isZoomGesturesEnabled()
Returns if the zoom gestures (pinch or double tap) are currently permitted on the map.
abstract MapSettings setBuildingsEnabled(boolean enabled)
Enables or disables the display of buildings on the map.
abstract MapSettings setCompassEnabled(boolean enabled)
Enables or disables the compass visual control, that is displayed over the map.
abstract MapSettings setIndoorEnabled(boolean enabled)
Enables or disables indoor maps.
abstract MapSettings setMapType(int mapType)
Sets the map type currently shown by the map.
abstract MapSettings setMyLocationEnabled(boolean enabled)
Sets whether the map can try to retrieve and display the user's location.
abstract MapSettings setRotateGesturesEnabled(boolean enabled)
Sets whether the rotate gestures are enabled on the map.
abstract MapSettings setScrollGesturesEnabled(boolean enabled)
Sets whether the scroll gestures are enabled on the map.
abstract MapSettings setTiltGesturesEnabled(boolean enabled)
Sets whether the tilt gestures are enabled on the map.
abstract MapSettings setTrafficEnabled(boolean enabled)
Turns the traffic layer on or off.
abstract MapSettings setZoomControlsEnabled(boolean enabled)
Enables or disables the visual controls that let the user zoom in or zoom out the map.
abstract MapSettings setZoomGesturesEnabled(boolean enabled)
Sets whether the zoom gestures (pinch or double tap) are enabled on the map.

Constants

public static final int MAP_TYPE_HYBRID

Satellite maps with a transparent layer of major streets.

Constant Value: 4 (0x00000004)

public static final int MAP_TYPE_NONE

No base map tiles (Show nothing on Android).

Constant Value: 0 (0x00000000)

public static final int MAP_TYPE_NORMAL

Basic maps.

Constant Value: 1 (0x00000001)

public static final int MAP_TYPE_SATELLITE

Satellite maps with no labels.

Constant Value: 2 (0x00000002)

public static final int MAP_TYPE_TERRAIN

Terrain maps.

Constant Value: 3 (0x00000003)

Public Methods

public abstract int getMapType ()

Gets the type of map that is currently displayed. See MAP_TYPE_NORMAL, MAP_TYPE_SATELLITE, MAP_TYPE_TERRAIN for possible values.

Returns
  • the map type.

public abstract boolean isBuildingsEnabled ()

Returns if the buildings are currently shown over the map.

Returns
  • the buildingsEnabled option

public abstract boolean isCompassEnabled ()

Returns if the compass visual control is currently shown over the map.

Returns
  • the compassEnabled option

public abstract boolean isIndoorEnabled ()

Returns if the indoor layers are currently shown on the map.

Cross Platform considerations

Available only for the Android platform. Returns false for the other platforms.

Returns
  • the indoorEnabled option

public abstract boolean isMyLocationEnabled ()

Returns if the user's location is displayed on the map.

Cross Platform considerations

Available only for the Android platform. Returns false for the other platforms.

Returns
  • if my location should be visible

public abstract boolean isRotateGesturesEnabled ()

Returns if the rotate gestures are currently permitted on the map.

Returns
  • the rotateGesturesEnabled option

public abstract boolean isScrollGesturesEnabled ()

Returns if the scroll gestures are currently permitted on the map.

Returns
  • the scrollGesturesEnabled option

public abstract boolean isTiltGesturesEnabled ()

Returns if the tilt gestures are currently permitted on the map.

Returns
  • the tiltGesturesEnabled option

public abstract boolean isTrafficEnabled ()

Returns if the traffic layer is shown or not.

Returns
  • the trafficEnabled option

public abstract boolean isZoomControlsEnabled ()

Returns if the zoom visual controls are currently shown over the map.

Cross Platform considerations

Always returns false for the iOS platform, as there are no zoom controls over the map.

Returns
  • the zoomControlsEnabled option

public abstract boolean isZoomGesturesEnabled ()

Returns if the zoom gestures (pinch or double tap) are currently permitted on the map.

Returns
  • the zoomGesturesEnabled option

public abstract MapSettings setBuildingsEnabled (boolean enabled)

Enables or disables the display of buildings on the map.

Cross Platform considerations

For the Android platform, the buildings are displayed only when the current map type is MAP_TYPE_NORMAL. For the iOS platform, the buildings display when the current map type is MAP_TYPE_NORMAL or MAP_TYPE_TERRAIN.

Returns
  • this settings instance

public abstract MapSettings setCompassEnabled (boolean enabled)

Enables or disables the compass visual control, that is displayed over the map. This control usually appears when the user rotates the map with a rotate gesture.

Returns
  • this settings instance

public abstract MapSettings setIndoorEnabled (boolean enabled)

Enables or disables indoor maps. This lets the user see the indoor map of a building for example.

Cross Platform considerations

Available only for the Android platform.

Returns
  • this settings instance

public abstract MapSettings setMapType (int mapType)

Sets the map type currently shown by the map.

Parameters
mapType the map type, which must be one of the following : MAP_TYPE_HYBRID, MAP_TYPE_NONE, MAP_TYPE_NORMAL, MAP_TYPE_SATELLITE or MAP_TYPE_TERRAIN
Returns
  • this settings instance

public abstract MapSettings setMyLocationEnabled (boolean enabled)

Sets whether the map can try to retrieve and display the user's location.

Parameters
enabled true to show the user position
Returns
  • this settings instance

public abstract MapSettings setRotateGesturesEnabled (boolean enabled)

Sets whether the rotate gestures are enabled on the map.

Returns
  • this settings instance

public abstract MapSettings setScrollGesturesEnabled (boolean enabled)

Sets whether the scroll gestures are enabled on the map.

Returns
  • this settings instance

public abstract MapSettings setTiltGesturesEnabled (boolean enabled)

Sets whether the tilt gestures are enabled on the map.

Returns
  • this settings instance

public abstract MapSettings setTrafficEnabled (boolean enabled)

Turns the traffic layer on or off.

Cross Platform considerations

Available only for the Android platform.

Parameters
enabled true to show traffic.
Returns
  • this settings instance

public abstract MapSettings setZoomControlsEnabled (boolean enabled)

Enables or disables the visual controls that let the user zoom in or zoom out the map.

Cross Platform considerations

Available only for the Android platform. The other platforms do not have any zoom controls.

Returns
  • this settings instance

public abstract MapSettings setZoomGesturesEnabled (boolean enabled)

Sets whether the zoom gestures (pinch or double tap) are enabled on the map.

Returns
  • this settings instance