public class

BingMapsLayer

extends TiledServiceLayer

java.lang.Object
↳	com.esri.android.map.Layer
	↳	com.esri.android.map.TiledLayer
		↳	com.esri.android.map.TiledServiceLayer
			↳	com.esri.android.map.bing.BingMapsLayer

Class Overview

BingMapsLayer class is used to define the Layer populated from Bing Maps that can be added to the MapView object.

BingMapsLayer allows you to work with maps from Bing Maps. Bing Maps requires a key in order to allow access to the tiles. Information on how to obtain a key can be found on this page: Getting a Bing Maps Key

The following are examples of how you can work with the BingMapsLayer class. The code will add a map with a Bing Maps Layer of Aerial style.

Java usage:

 MapView mv = new MapView(this);
 mv.addLayer(new BingMapsLayer(
 "[your Bing Maps key]", MapStyle.Aerial));
 setContentView(mv);

To initialize a Bing map in a WebMap please see the class description of the MapView.

Summary

Nested Classes
enum	BingMapsLayer.MapStyle	Map styles available for the imagery: Aerial - Aerial imagery AerialWithLabels - Aerial imagery with a road overlay Road - Roads without additional imagery.

Constants
double	BING_MAPS_XMAX	Maximum X coordinate in meters for the full extent of Bing Maps service.
double	BING_MAPS_XMIN	Minimum X coordinate in meters for the full extent of Bing Maps service.
double	BING_MAPS_YMAX	Maximum Y coordinate in meters for the full extent of Bing Maps service.
double	BING_MAPS_YMIN	Minimum Y coordinate in meters for the full extent of Bing Maps service.

[Expand]

Inherited Constants

From class com.esri.android.map.TiledServiceLayer

[Expand]

Inherited Fields

From class com.esri.android.map.TiledServiceLayer

From class com.esri.android.map.Layer

Public Constructors
	BingMapsLayer(String appId, BingMapsLayer.MapStyle mapStyle) Creates a BingMapsLayer object from Bing Maps key and map style.
	BingMapsLayer(String appId, BingMapsLayer.MapStyle mapStyle, boolean initLayer) Creates a BingMapsLayer object from Bing Maps key and map style.

Public Methods
String	getAppId() Returns the Bing Maps key.
Bitmap	getBingLogo(int width, int height) Returns the Bing Logo bitmap.
String	getCulture() Returns the culture of the layer (format: [language]-[REGION], e.g.: en-US) see Culture Parameter
URL	getLogoUrl() Returns a URL object for Bing Maps logo.
BingMapsLayer.MapStyle	getMapStyle() Returns the style of the Bing Maps layer.
String	getMapVersion() Returns the map version (format: v[map version], e.g.: v0).
void	refresh() Fetches the information for the tiles again if any of the parameters have changed (map version, map style, culture...) and refreshes the tiles accordingly.
void	reinitializeLayer(UserCredentials usercredentials) This method has no impact on the BingMapsLayer.
void	reinitializeLayer(String appID) Re-initializes the layer with the given appID.
void	setAppId(String appId) Sets the Bing Maps key.
void	setCulture(String culture) Sets the culture of the layer (format: [language]-[REGION], e.g.: en-US) see Culture Parameter
void	setMapStyle(BingMapsLayer.MapStyle mapStyle) Sets the map style of the Bing Maps layer.
void	setMapVersion(String mapVersion) Sets the map version (format: v[map version], e.g.: v0).

Protected Methods
byte[]	getTile(int lev, int col, int row) get byte array of the tile at the specified level, column and row.
void	initLayer() Initializes the layer.

[Expand]

Inherited Methods

From class com.esri.android.map.TiledServiceLayer

From class com.esri.android.map.TiledLayer

void	clearTiles() Cancels all current tile request.
float	getBrightness() Gets the brightness of the ArcGISTiledMapCacheLayer.
float	getContrast() Gets the contrast of the ArcGISTiledMapCacheLayer.
int	getCurrentLevel() Returns the current the level of detail(LOD).
float	getGamma() Gets the gamma of the ArcGISTiledMapCacheLayer.
boolean	isPopupAllowGeometryUpdate(Graphic graphic) Returns true if the popup allow the geometry to be updated, potentially based on some information carried by the `Graphic` provided.
boolean	isPopupDeletable(Graphic graphic) Returns true if the popup created is deletable, potentially based on some information carried by the `Graphic` provided.
boolean	isPopupEditable(Graphic graphic) Returns true if the popup created is editable, potentially based on some information carried by the `Graphic` provided.
boolean	isRenderNativeResolution() Returns true if rendering at native resolution is enabled.
void	setBrightness(float brightness) Sets the brightness of the ArcGISTiledMapCacheLayer.
void	setContrast(float contrast) Sets the contrast of the ArcGISTiledMapCacheLayer.
void	setGamma(float gamma) Sets the gamma of the ArcGISTiledMapCacheLayer.
void	setRenderNativeResolution(boolean renderNativeResolution) Sets to true to render the tiled layer in native resolution.

From class com.esri.android.map.Layer

void	changeStatus(OnStatusChangedListener.STATUS status) Changes the STATUS of the layer and notifies the listener.
abstract long	create()
Popup	createPopup(MapView mapView, int sublayerId, Graphic graphic) Creates the popup.
void	finalize()
UserCredentials	getCredentials() Gets a copy of the credentials attached to the Layer.
SpatialReference	getDefaultSpatialReference() Gets the defaultSpatialReference of the Layer.
float	getDpi()
Polygon	getExtent() Gets the current extent.
Envelope	getFullExtent() Returns the full extent of the layer.
int	getHeight() Gets the height of the Layer in screen units.
long	getID() Return the Layer runtime ID which is a long integer.
Envelope	getInitialExtent() Returns the initial extent of the layer.
double	getMaxScale() Gets max scale.
double	getMinScale() Gets min scale.
String	getName() Gets the name of the layer.
float	getOpacity() Gets the opacity of the Layer.
Layer	getParent() Returns parent layer if the layer is in a group layer otherwise returning null.
ExecutorService	getPoolExecutor() Returns the ThreadPoolExecutor based on the context.
ArcGISPopupInfo	getPopupInfo(int sublayerId) Gets the `PopupInfo` associated with the sub-layer id.
Map<Integer, ArcGISPopupInfo>	getPopupInfos() Gets the popup infos.
String	getQueryUrl(int subLayerId) Gets the query url.
double	getResolution() Gets the resolution of the Layer.
ExecutorService	getServiceExecutor() Returns the ThreadPoolExecutor based on the context.
SpatialReference	getSpatialReference() Gets the current spatial reference of the Layer.
String	getTitle() Gets the title of the Layer.
String	getUrl() Gets the URL of the map service associated with the layer.
int	getUrlHashCode() A convenience method that returns the hash code of the map service URL.
String	getWebMapLayerID() Gets the web map layer id.
int	getWidth() Gets the width of the Layer in screen units.
abstract void	initLayer() Initializes the layer.
void	initializeMinMaxScale(double initalMinScale, double initalMaxScale) honor the webmaplayer min/max scale first, if it is not override, then using service min/max if they are set.
boolean	isInitialized() Gets the initialized of the Layer.
boolean	isRecycled() Returns true or false if the Layer object has been recycled.
boolean	isShowLegend() Returns true if legend of the layer will be shown up; by default it is true; The property is usually defined in the web map, a operation layer legend could be on or off.
boolean	isVisible() Gets the visibility of the Layer.
boolean	isWebMapBaselayer() Returns true if the layer is used as base layer in a web map.
<T> T	loadServiceInfo(Callable<T> task) If the Layer is loaded as a WebMapLayer and the OnWebMapLoadListener is specified, the service information will be loaded interactively.
synchronized long	lock()
void	recycle() Releases resources referenced by the Layer so that they can be recycled.
void	reinitializeLayer(UserCredentials usercredentials) Re-initializes the layer with the given credentials.
void	setCredentials(UserCredentials credentials) Sets the credentials of the Layer.
void	setDefaultSpatialReference(SpatialReference defaultSpatialReference) Sets the defaultSpatialReference of the Layer.
void	setFullExtent(Envelope extent)
void	setInitialExtent(Envelope e) Sets the initial extent of layer.
void	setMaxScale(double maxScale) Sets max scale.
void	setMinScale(double minScale) Sets min scale.
void	setName(String name) Sets the layer name.
void	setOnStatusChangedListener(OnStatusChangedListener onStatusChangedListener) Sets the onStatusChangedListener.
void	setOpacity(float opacity) Sets the opacity of the Layer.
void	setPopupInfos(Map<Integer, ArcGISPopupInfo> popUpInfos) Sets the popup infos.
void	setQueryUrls(Map<Integer, String> queryUrls) Sets the query urls.
void	setUrl(String url) Sets the URL of the map service associated with the layer.
void	setVisible(boolean visible) Sets the visibility of the Layer.
void	unlock(long handle)
void	updateSpatialReferenceStatus(int SRStatus) The callback method is invoked when the layer is added to map.
boolean	verifyCredentials() Returns true if the credentials is valid.

From class java.lang.Object

From interface com.esri.android.map.popup.PopupLayer

Constants

public static final double BING_MAPS_XMAX

Maximum X coordinate in meters for the full extent of Bing Maps service.

Constant Value: 2.003750834278E7

public static final double BING_MAPS_XMIN

Minimum X coordinate in meters for the full extent of Bing Maps service.

Constant Value: -2.003750834278E7

public static final double BING_MAPS_YMAX

Maximum Y coordinate in meters for the full extent of Bing Maps service.

Constant Value: 2.0037508342787E7

public static final double BING_MAPS_YMIN

Minimum Y coordinate in meters for the full extent of Bing Maps service.

Constant Value: -2.003750834278E7

Public Constructors

public BingMapsLayer (String appId, BingMapsLayer.MapStyle mapStyle)

Creates a BingMapsLayer object from Bing Maps key and map style.

This constructor is used if you instantiate the BingMapsLayer pragmatically (see the class description for an example of this usage).

Parameters

appId	the Bing Maps key.
mapStyle	the map style. See `BingMapsLayer.MapStyle` for available values

public BingMapsLayer (String appId, BingMapsLayer.MapStyle mapStyle, boolean initLayer)

Creates a BingMapsLayer object from Bing Maps key and map style.

Parameters

appId	-the Bing Maps key.
mapStyle	-the map style.
initLayer	set to true to initialize the the layer, or the layer will not initialized.

Public Methods

public String getAppId ()

Returns the Bing Maps key.

Returns

the Bing Maps key

public Bitmap getBingLogo (int width, int height)

Returns the Bing Logo bitmap.

Parameters

width	- logo width in integer
height	- logo height in integer

Returns

a Bitmap object for Bing Logo

public String getCulture ()

Returns the culture of the layer (format: [language]-[REGION], e.g.: en-US)
see Culture Parameter

Returns

the culture of the layer

public URL getLogoUrl ()

Returns a URL object for Bing Maps logo.

Returns

a URL object for Bing Maps logo.

public BingMapsLayer.MapStyle getMapStyle ()

Returns the style of the Bing Maps layer.

Returns

the style of the layer

public String getMapVersion ()

Returns the map version (format: v[map version], e.g.: v0).

Returns

the map version

public void refresh ()

Fetches the information for the tiles again if any of the parameters have changed (map version, map style, culture...) and refreshes the tiles accordingly.

public void reinitializeLayer (UserCredentials usercredentials)

This method has no impact on the BingMapsLayer. Please use reinitializeLayer(String) instead.

Parameters

usercredentials	the usercredentials

public void reinitializeLayer (String appID)

Re-initializes the layer with the given appID.

Parameters

appID	the new appID.

public void setAppId (String appId)

Sets the Bing Maps key.

Parameters

appId	the Bing Maps key to set

public void setCulture (String culture)

Sets the culture of the layer (format: [language]-[REGION], e.g.: en-US)
see Culture Parameter

Parameters

culture	the culture to set

public void setMapStyle (BingMapsLayer.MapStyle mapStyle)

Sets the map style of the Bing Maps layer. see BingMapsLayer.MapStyle for available values.

Parameters

mapStyle	the map style to set

public void setMapVersion (String mapVersion)

Sets the map version (format: v[map version], e.g.: v0).

Parameters

mapVersion	the map version to set

Protected Methods

protected byte[] getTile (int lev, int col, int row)

get byte array of the tile at the specified level, column and row.

Throws

Exception

protected void initLayer ()

Initializes the layer. The implementation should submit the OnStatusChangedListener.STATUS event accordingly.

Classes

Enums

BingMapsLayer

Class Overview

Summary

Constants

public static final double BING_MAPS_XMAX

public static final double BING_MAPS_XMIN

public static final double BING_MAPS_YMAX

public static final double BING_MAPS_YMIN

Public Constructors

public BingMapsLayer (String appId, BingMapsLayer.MapStyle mapStyle)

Parameters

public BingMapsLayer (String appId, BingMapsLayer.MapStyle mapStyle, boolean initLayer)

Parameters

Public Methods

public String getAppId ()

Returns

public Bitmap getBingLogo (int width, int height)

Parameters

Returns

public String getCulture ()

Returns

public URL getLogoUrl ()

Returns

public BingMapsLayer.MapStyle getMapStyle ()

Returns

public String getMapVersion ()

Returns

public void refresh ()

public void reinitializeLayer (UserCredentials usercredentials)

Parameters

public void reinitializeLayer (String appID)

Parameters

public void setAppId (String appId)

Parameters

public void setCulture (String culture)

Parameters

public void setMapStyle (BingMapsLayer.MapStyle mapStyle)

Parameters

public void setMapVersion (String mapVersion)

Parameters

Protected Methods

protected byte[] getTile (int lev, int col, int row)

Throws

protected void initLayer ()