com.mapbox.mapboxsdk.maps

Class MapView

java.lang.Object

FrameLayout

com.mapbox.mapboxsdk.maps.MapView

All Implemented Interfaces:

com.mapbox.mapboxsdk.maps.NativeMapView.ViewCallback

public class MapView
extends FrameLayout
implements com.mapbox.mapboxsdk.maps.NativeMapView.ViewCallback

A MapView provides an embeddable map interface. You use this class to display map information and to manipulate the map contents from your application. You can center the map on a given coordinate, specify the size of the area you want to display, and style the features of the map to fit your application's use case.

Use of MapView requires a Mapbox API access token. Obtain an access token on the Mapbox account page.

Warning: Please note that you are responsible for getting permission to use the map data, and for ensuring your use adheres to the relevant terms of use.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapView.OnCameraDidChangeListener Interface definition for a callback to be invoked when the map region did change.
static interface	MapView.OnCameraIsChangingListener Interface definition for a callback to be invoked when the camera is changing.
static interface	MapView.OnCameraWillChangeListener Interface definition for a callback to be invoked when the camera will change.
static interface	MapView.OnCanRemoveUnusedStyleImageListener Interface definition for a callback to be invoked with an unused image identifier.
static interface	MapView.OnDidBecomeIdleListener Interface definition for a callback to be invoked when the map has entered the idle state.
static interface	MapView.OnDidFailLoadingMapListener Interface definition for a callback to be invoked when the map is changing.
static interface	MapView.OnDidFailLoadingTileListener Interface definition for a callback to be invoked when the tile failed to load.
static interface	MapView.OnDidFinishLoadingMapListener Interface definition for a callback to be invoked when the map finished loading.
static interface	MapView.OnDidFinishLoadingStyleListener Interface definition for a callback to be invoked when the map has loaded the style.
static interface	MapView.OnDidFinishRenderingFrameListener Interface definition for a callback to be invoked when the map finished rendering a frame.
static interface	MapView.OnDidFinishRenderingMapListener Interface definition for a callback to be invoked when the map is changing.
static interface	MapView.OnSourceChangedListener Interface definition for a callback to be invoked when a map source has changed.
static interface	MapView.OnStyleImageMissingListener Interface definition for a callback to be invoked with the id of a missing icon.
static interface	MapView.OnWillStartLoadingMapListener Interface definition for a callback to be invoked when the map will start loading.
static interface	MapView.OnWillStartRenderingFrameListener Interface definition for a callback to be invoked when the map will start rendering a frame.
static interface	MapView.OnWillStartRenderingMapListener Interface definition for a callback to be invoked when the map will start rendering the map.

Constructor Summary

Constructors

Constructor and Description
MapView(Context context)
MapView(Context context, AttributeSet attrs)
MapView(Context context, AttributeSet attrs, int defStyleAttr)
MapView(Context context, MapboxMapOptions options)

Method Summary

Modifier and Type	Method and Description
void	addOnCameraDidChangeListener(MapView.OnCameraDidChangeListener listener) Set a callback that's invoked when the camera region did change.
void	addOnCameraIsChangingListener(MapView.OnCameraIsChangingListener listener) Set a callback that's invoked when the camera is changing.
void	addOnCameraWillChangeListener(MapView.OnCameraWillChangeListener listener) Set a callback that's invoked when the camera region will change.
void	addOnCanRemoveUnusedStyleImageListener(MapView.OnCanRemoveUnusedStyleImageListener listener) Set a callback that's invoked when map needs to release unused image resources.
void	addOnDidBecomeIdleListener(MapView.OnDidBecomeIdleListener listener) Set a callback that's invoked when the map has entered the idle state.
void	addOnDidFailLoadingMapListener(MapView.OnDidFailLoadingMapListener listener) Set a callback that's invoked when the map failed to load.
void	addOnDidFailLoadingTileListener(MapView.OnDidFailLoadingTileListener listener) Set a callback that's invoked when the tile failed to load.
void	addOnDidFinishLoadingMapListener(MapView.OnDidFinishLoadingMapListener listener) Set a callback that's invoked when the map has finished loading.
void	addOnDidFinishLoadingStyleListener(MapView.OnDidFinishLoadingStyleListener listener) Set a callback that's invoked when the style has finished loading.
void	addOnDidFinishRenderingFrameListener(MapView.OnDidFinishRenderingFrameListener listener) Set a callback that's invoked when the map has finished rendering a frame.
void	addOnDidFinishRenderingMapListener(MapView.OnDidFinishRenderingMapListener listener) Set a callback that's invoked when the map has finished rendering.
void	addOnSourceChangedListener(MapView.OnSourceChangedListener listener) Set a callback that's invoked when a map source has changed.
void	addOnStyleImageMissingListener(MapView.OnStyleImageMissingListener listener) Set a callback that's invoked when the id of an icon is missing.
boolean	addOnTouchListener(OnTouchListener listener) Add an OnTouchListener which will be call when an event occurs
void	addOnWillStartLoadingMapListener(MapView.OnWillStartLoadingMapListener listener) Set a callback that's invoked when the map will start loading.
void	addOnWillStartRenderingFrameListener(MapView.OnWillStartRenderingFrameListener listener) Set a callback that's invoked when the map will start rendering a frame.
void	addOnWillStartRenderingMapListener(MapView.OnWillStartRenderingMapListener listener) Set a callback that's invoked when the map will start rendering.
void	getMapAsync(OnMapReadyCallback callback) Sets a callback object which will be triggered when the MapboxMap instance is ready to be used.
float	getPixelRatio() Returns the map pixel ratio, by default it returns the device pixel ratio.
View	getRenderView() Returns the View used for rendering OpenGL.
Bitmap	getViewContent()
protected ImageView	initialiseAttributionView()
protected CompassView	initialiseCompassView()
protected ImageView	initialiseLogoView()
protected void	initialize(Context context, MapboxMapOptions options)
boolean	isDestroyed() Returns if the map has been destroyed.
void	onCreate(Bundle savedInstanceState) You must call this method from the parent's Activity#onCreate(Bundle)} or Fragment#onViewCreated(View, Bundle).
void	onDestroy() You must call this method from the parent's Activity#onDestroy() or Fragment#onDestroyView().
boolean	onGenericMotionEvent(MotionEvent event)
boolean	onKeyDown(int keyCode, KeyEvent event)
boolean	onKeyLongPress(int keyCode, KeyEvent event)
boolean	onKeyUp(int keyCode, KeyEvent event)
void	onLowMemory() You must call this method from the parent's Activity#onLowMemory() or Fragment#onLowMemory().
void	onPause() You must call this method from the parent's Activity#onPause() or Fragment#onPause().
void	onResume() You must call this method from the parent's Activity#onResume() or Fragment#onResume().
void	onSaveInstanceState(Bundle outState) You must call this method from the parent's Activity#onSaveInstanceState(Bundle) or Fragment#onSaveInstanceState(Bundle).
protected void	onSizeChanged(int width, int height, int oldw, int oldh)
void	onStart() You must call this method from the parent's Activity#onStart() or Fragment#onStart()
void	onStop() You must call this method from the parent's Activity#onStop() or Fragment#onStop().
boolean	onTouchEvent(MotionEvent event)
boolean	onTrackballEvent(MotionEvent event)
void	queueEvent(java.lang.Runnable runnable) Queue a runnable to be executed on the map renderer thread.
void	removeOnCameraDidChangeListener(MapView.OnCameraDidChangeListener listener) Set a callback that's invoked when the camera region did change.
void	removeOnCameraIsChangingListener(MapView.OnCameraIsChangingListener listener) Remove a callback that's invoked when the camera is changing.
void	removeOnCameraWillChangeListener(MapView.OnCameraWillChangeListener listener) Remove a callback that's invoked when the camera region will change.
void	removeOnCanRemoveUnusedStyleImageListener(MapView.OnCanRemoveUnusedStyleImageListener listener) Removes a callback that's invoked when map needs to release unused image resources.
void	removeOnDidBecomeIdleListener(MapView.OnDidBecomeIdleListener listener) Remove a callback that's invoked when the map has entered the idle state.
void	removeOnDidFailLoadingMapListener(MapView.OnDidFailLoadingMapListener listener) Set a callback that's invoked when the map failed to load.
void	removeOnDidFailLoadingTileListener(MapView.OnDidFailLoadingTileListener listener) Set a callback that's invoked when the tile failed to load.
void	removeOnDidFinishLoadingMapListener(MapView.OnDidFinishLoadingMapListener listener) Set a callback that's invoked when the map has finished loading.
void	removeOnDidFinishLoadingStyleListener(MapView.OnDidFinishLoadingStyleListener listener) Set a callback that's invoked when the style has finished loading.
void	removeOnDidFinishRenderingFrameListener(MapView.OnDidFinishRenderingFrameListener listener) Set a callback that's invoked when the map has finished rendering a frame.
void	removeOnDidFinishRenderingMapListener(MapView.OnDidFinishRenderingMapListener listener) Remove a callback that's invoked when the map has finished rendering.
void	removeOnSourceChangedListener(MapView.OnSourceChangedListener listener) Set a callback that's invoked when a map source has changed.
void	removeOnStyleImageMissingListener(MapView.OnStyleImageMissingListener listener) Set a callback that's invoked when a map source has changed.
boolean	removeOnTouchListener(OnTouchListener listener) Remove an OnTouchListener previously registered
void	removeOnWillStartLoadingMapListener(MapView.OnWillStartLoadingMapListener listener) Set a callback that's invoked when the map will start loading.
void	removeOnWillStartRenderingFrameListener(MapView.OnWillStartRenderingFrameListener listener) Set a callback that's invoked when the map will start rendering a frame.
void	removeOnWillStartRenderingMapListener(MapView.OnWillStartRenderingMapListener listener) Set a callback that's invoked when the map will start rendering.
static void	setMapStrictModeEnabled(boolean strictModeEnabled) Sets the strict mode that will throw the MapStrictModeException whenever the map would fail silently otherwise.
void	setMaximumFps(int maximumFps) The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapView

@UiThread
public MapView(@NonNull
                         Context context)

MapView

@UiThread
public MapView(@NonNull
                         Context context,
                         @Nullable
                         AttributeSet attrs)

MapView

@UiThread
public MapView(@NonNull
                         Context context,
                         @Nullable
                         AttributeSet attrs,
                         int defStyleAttr)

MapView

@UiThread
public MapView(@NonNull
                         Context context,
                         @Nullable
                         MapboxMapOptions options)

Method Detail

initialize

@CallSuper
 @UiThread
protected void initialize(@NonNull
                                                Context context,
                                                @NonNull
                                                MapboxMapOptions options)

initialiseCompassView

protected CompassView initialiseCompassView()

initialiseAttributionView

protected ImageView initialiseAttributionView()

initialiseLogoView

protected ImageView initialiseLogoView()

onCreate

@UiThread
public void onCreate(@Nullable
                               Bundle savedInstanceState)

You must call this method from the parent's Activity#onCreate(Bundle)} or Fragment#onViewCreated(View, Bundle).

You must set a valid access token with Mapbox.getInstance(Context, String) before you call this method or an exception will be thrown.

Parameters:

savedInstanceState - Pass in the parent's savedInstanceState.

See Also:

Mapbox.getInstance(Context, String)

onSaveInstanceState

@UiThread
public void onSaveInstanceState(@NonNull
                                          Bundle outState)

You must call this method from the parent's Activity#onSaveInstanceState(Bundle) or Fragment#onSaveInstanceState(Bundle).

Parameters:

outState - Pass in the parent's outState.

onStart

@UiThread
public void onStart()

You must call this method from the parent's Activity#onStart() or Fragment#onStart()

onResume

@UiThread
public void onResume()

You must call this method from the parent's Activity#onResume() or Fragment#onResume().

onPause

@UiThread
public void onPause()

You must call this method from the parent's Activity#onPause() or Fragment#onPause().

onStop

@UiThread
public void onStop()

You must call this method from the parent's Activity#onStop() or Fragment#onStop().

onDestroy

@UiThread
public void onDestroy()

You must call this method from the parent's Activity#onDestroy() or Fragment#onDestroyView().

queueEvent

public void queueEvent(@NonNull
                       java.lang.Runnable runnable)

Queue a runnable to be executed on the map renderer thread.

Parameters:

runnable - the runnable to queue

setMaximumFps

public void setMaximumFps(int maximumFps)

The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.

Parameters:

maximumFps - Can be set to arbitrary integer values.

isDestroyed

@UiThread
public boolean isDestroyed()

Returns if the map has been destroyed.

This method can be used to determine if the result of an asynchronous operation should be set.

Returns:

true, if the map has been destroyed

getRenderView

@NonNull
 @UiThread
public View getRenderView()

Returns the View used for rendering OpenGL.

The type of the returned view is either a GLSurfaceView or a TextureView.

Returns:

the view used for rendering OpenGL

addOnTouchListener

public boolean addOnTouchListener(OnTouchListener listener)

Add an OnTouchListener which will be call when an event occurs

Parameters:

listener - listener to be called when touch event occurs

Returns:

true if listener has been successfully registered

removeOnTouchListener

public boolean removeOnTouchListener(OnTouchListener listener)

Remove an OnTouchListener previously registered

Parameters:

listener - listener to be called when touch event occurs

Returns:

true if listener has been successfully unregistered

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

onKeyDown

public boolean onKeyDown(int keyCode,
                         @NonNull
                         KeyEvent event)

onKeyLongPress

public boolean onKeyLongPress(int keyCode,
                              KeyEvent event)

onKeyUp

public boolean onKeyUp(int keyCode,
                       @NonNull
                       KeyEvent event)

onTrackballEvent

public boolean onTrackballEvent(@NonNull
                                MotionEvent event)

onGenericMotionEvent

public boolean onGenericMotionEvent(@NonNull
                                    MotionEvent event)

onLowMemory

@UiThread
public void onLowMemory()

You must call this method from the parent's Activity#onLowMemory() or Fragment#onLowMemory().

onSizeChanged

protected void onSizeChanged(int width,
                             int height,
                             int oldw,
                             int oldh)

getPixelRatio

public float getPixelRatio()

Returns the map pixel ratio, by default it returns the device pixel ratio. Can be overwritten using MapboxMapOptions.pixelRatio(float).

Returns:

the current map pixel ratio

getViewContent

@Nullable
public Bitmap getViewContent()

Specified by:

getViewContent in interface com.mapbox.mapboxsdk.maps.NativeMapView.ViewCallback

addOnCameraWillChangeListener

public void addOnCameraWillChangeListener(@NonNull
                                          MapView.OnCameraWillChangeListener listener)

Set a callback that's invoked when the camera region will change.

Parameters:

listener - The callback that's invoked when the camera region will change

removeOnCameraWillChangeListener

public void removeOnCameraWillChangeListener(@NonNull
                                             MapView.OnCameraWillChangeListener listener)

Remove a callback that's invoked when the camera region will change.

Parameters:

listener - The callback that's invoked when the camera region will change

addOnCameraIsChangingListener

public void addOnCameraIsChangingListener(@NonNull
                                          MapView.OnCameraIsChangingListener listener)

Set a callback that's invoked when the camera is changing.

Parameters:

listener - The callback that's invoked when the camera is changing

removeOnCameraIsChangingListener

public void removeOnCameraIsChangingListener(@NonNull
                                             MapView.OnCameraIsChangingListener listener)

Remove a callback that's invoked when the camera is changing.

Parameters:

listener - The callback that's invoked when the camera is changing

addOnCameraDidChangeListener

public void addOnCameraDidChangeListener(@NonNull
                                         MapView.OnCameraDidChangeListener listener)

Set a callback that's invoked when the camera region did change.

Parameters:

listener - The callback that's invoked when the camera region did change

removeOnCameraDidChangeListener

public void removeOnCameraDidChangeListener(@NonNull
                                            MapView.OnCameraDidChangeListener listener)

Set a callback that's invoked when the camera region did change.

Parameters:

listener - The callback that's invoked when the camera region did change

addOnWillStartLoadingMapListener

public void addOnWillStartLoadingMapListener(@NonNull
                                             MapView.OnWillStartLoadingMapListener listener)

Set a callback that's invoked when the map will start loading.

Parameters:

listener - The callback that's invoked when the map will start loading

removeOnWillStartLoadingMapListener

public void removeOnWillStartLoadingMapListener(@NonNull
                                                MapView.OnWillStartLoadingMapListener listener)

Set a callback that's invoked when the map will start loading.

Parameters:

listener - The callback that's invoked when the map will start loading

addOnDidFinishLoadingMapListener

public void addOnDidFinishLoadingMapListener(@NonNull
                                             MapView.OnDidFinishLoadingMapListener listener)

Set a callback that's invoked when the map has finished loading.

Parameters:

listener - The callback that's invoked when the map has finished loading

removeOnDidFinishLoadingMapListener

public void removeOnDidFinishLoadingMapListener(@NonNull
                                                MapView.OnDidFinishLoadingMapListener listener)

Set a callback that's invoked when the map has finished loading.

Parameters:

listener - The callback that's invoked when the map has finished loading

addOnDidFailLoadingMapListener

public void addOnDidFailLoadingMapListener(@NonNull
                                           MapView.OnDidFailLoadingMapListener listener)

Set a callback that's invoked when the map failed to load.

Parameters:

listener - The callback that's invoked when the map failed to load

removeOnDidFailLoadingMapListener

public void removeOnDidFailLoadingMapListener(@NonNull
                                              MapView.OnDidFailLoadingMapListener listener)

Set a callback that's invoked when the map failed to load.

Parameters:

listener - The callback that's invoked when the map failed to load

addOnDidFailLoadingTileListener

public void addOnDidFailLoadingTileListener(@NonNull
                                            MapView.OnDidFailLoadingTileListener listener)

Set a callback that's invoked when the tile failed to load.

Parameters:

listener - The callback that's invoked when the tile failed to load

removeOnDidFailLoadingTileListener

public void removeOnDidFailLoadingTileListener(@NonNull
                                               MapView.OnDidFailLoadingTileListener listener)

Set a callback that's invoked when the tile failed to load.

Parameters:

listener - The callback that's invoked when the tile failed to load

addOnWillStartRenderingFrameListener

public void addOnWillStartRenderingFrameListener(@NonNull
                                                 MapView.OnWillStartRenderingFrameListener listener)

Set a callback that's invoked when the map will start rendering a frame.

Parameters:

listener - The callback that's invoked when the camera will start rendering a frame

removeOnWillStartRenderingFrameListener

public void removeOnWillStartRenderingFrameListener(@NonNull
                                                    MapView.OnWillStartRenderingFrameListener listener)

Set a callback that's invoked when the map will start rendering a frame.

Parameters:

listener - The callback that's invoked when the camera will start rendering a frame

addOnDidFinishRenderingFrameListener

public void addOnDidFinishRenderingFrameListener(@NonNull
                                                 MapView.OnDidFinishRenderingFrameListener listener)

Set a callback that's invoked when the map has finished rendering a frame.

Parameters:

listener - The callback that's invoked when the map has finished rendering a frame

removeOnDidFinishRenderingFrameListener

public void removeOnDidFinishRenderingFrameListener(@NonNull
                                                    MapView.OnDidFinishRenderingFrameListener listener)

Set a callback that's invoked when the map has finished rendering a frame.

Parameters:

listener - The callback that's invoked when the map has finished rendering a frame

addOnWillStartRenderingMapListener

public void addOnWillStartRenderingMapListener(@NonNull
                                               MapView.OnWillStartRenderingMapListener listener)

Set a callback that's invoked when the map will start rendering.

Parameters:

listener - The callback that's invoked when the map will start rendering

removeOnWillStartRenderingMapListener

public void removeOnWillStartRenderingMapListener(@NonNull
                                                  MapView.OnWillStartRenderingMapListener listener)

Set a callback that's invoked when the map will start rendering.

Parameters:

listener - The callback that's invoked when the map will start rendering

addOnDidFinishRenderingMapListener

public void addOnDidFinishRenderingMapListener(@NonNull
                                               MapView.OnDidFinishRenderingMapListener listener)

Set a callback that's invoked when the map has finished rendering.

Parameters:

listener - The callback that's invoked when the map has finished rendering

removeOnDidFinishRenderingMapListener

public void removeOnDidFinishRenderingMapListener(MapView.OnDidFinishRenderingMapListener listener)

Remove a callback that's invoked when the map has finished rendering.

Parameters:

listener - The callback that's invoked when the map has has finished rendering.

addOnDidBecomeIdleListener

public void addOnDidBecomeIdleListener(@NonNull
                                       MapView.OnDidBecomeIdleListener listener)

Set a callback that's invoked when the map has entered the idle state.

Parameters:

listener - The callback that's invoked when the map has entered the idle state.

removeOnDidBecomeIdleListener

public void removeOnDidBecomeIdleListener(@NonNull
                                          MapView.OnDidBecomeIdleListener listener)

Remove a callback that's invoked when the map has entered the idle state.

Parameters:

listener - The callback that's invoked when the map has entered the idle state.

addOnDidFinishLoadingStyleListener

public void addOnDidFinishLoadingStyleListener(@NonNull
                                               MapView.OnDidFinishLoadingStyleListener listener)

Set a callback that's invoked when the style has finished loading.

Parameters:

listener - The callback that's invoked when the style has finished loading

removeOnDidFinishLoadingStyleListener

public void removeOnDidFinishLoadingStyleListener(@NonNull
                                                  MapView.OnDidFinishLoadingStyleListener listener)

Set a callback that's invoked when the style has finished loading.

Parameters:

listener - The callback that's invoked when the style has finished loading

addOnSourceChangedListener

public void addOnSourceChangedListener(@NonNull
                                       MapView.OnSourceChangedListener listener)

Set a callback that's invoked when a map source has changed.

Parameters:

listener - The callback that's invoked when the source has changed

removeOnSourceChangedListener

public void removeOnSourceChangedListener(@NonNull
                                          MapView.OnSourceChangedListener listener)

Set a callback that's invoked when a map source has changed.

Parameters:

listener - The callback that's invoked when the source has changed

addOnStyleImageMissingListener

public void addOnStyleImageMissingListener(@NonNull
                                           MapView.OnStyleImageMissingListener listener)

Set a callback that's invoked when the id of an icon is missing.

Parameters:

listener - The callback that's invoked when the id of an icon is missing

removeOnStyleImageMissingListener

public void removeOnStyleImageMissingListener(@NonNull
                                              MapView.OnStyleImageMissingListener listener)

Set a callback that's invoked when a map source has changed.

Parameters:

listener - The callback that's invoked when the source has changed

addOnCanRemoveUnusedStyleImageListener

public void addOnCanRemoveUnusedStyleImageListener(@NonNull
                                                   MapView.OnCanRemoveUnusedStyleImageListener listener)

Set a callback that's invoked when map needs to release unused image resources.

A callback will be called only for unused images that were provided by the client via MapView.OnStyleImageMissingListener.onStyleImageMissing(String) listener interface.

By default, platform will remove unused images from the style. By adding listener, default behavior can be overridden and client can control whether to release unused resources.

Parameters:

listener - The callback that's invoked when map needs to release unused image resources

removeOnCanRemoveUnusedStyleImageListener

public void removeOnCanRemoveUnusedStyleImageListener(@NonNull
                                                      MapView.OnCanRemoveUnusedStyleImageListener listener)

Removes a callback that's invoked when map needs to release unused image resources.

When all listeners are removed, platform will fallback to default behavior, which is to remove unused images from the style.

Parameters:

listener - The callback that's invoked when map needs to release unused image resources

getMapAsync

@UiThread
public void getMapAsync(@NonNull
                                  OnMapReadyCallback callback)

Sets a callback object which will be triggered when the MapboxMap instance is ready to be used.

Parameters:

callback - The callback object that will be triggered when the map is ready to be used.

setMapStrictModeEnabled

public static void setMapStrictModeEnabled(boolean strictModeEnabled)

Sets the strict mode that will throw the MapStrictModeException whenever the map would fail silently otherwise.

Parameters:

strictModeEnabled - true to enable the strict mode, false otherwise