AGSBingMapLayer Class Reference

---

Description

An instance of this class allows you display maps from Bing Maps.

In a Model-View-Controller architecture, this object represents the Model. The corresponding View object, AGSTiledLayerView, is created when this layer is added to an instance of AGSMapView.

Defined in:

AGSBingMapLayer.h ( ArcGIS library)

Since:

1.0

Inheritance diagram for AGSBingMapLayer:

List of all members.

Public Member Functions
(BOOL)	- clearLocalTileCache
(void)	- dataChanged
(id)	- initWithAppID:style:
(void)	- layerDidFailToLoad:
(void)	- layerDidLoad
(NSOperation< AGSTileOperation > *)	- retrieveImageAsyncForTile:
Properties
NSString *	appID
id< AGSLayerDelegate >	delegate
NSError *	error
AGSEnvelope *	fullEnvelope
AGSEnvelope *	initialEnvelope
BOOL	loaded
NSString *	name
NSOperationQueue *	operationQueue
AGSSpatialReference *	spatialReference
AGSBingMapLayerStyle	style
id< AGSTiledLayerTileDelegate >	tileDelegate
AGSTileInfo *	tileInfo
BOOL	timeAware
AGSUnits	units

---

Member Function Documentation

- (BOOL) clearLocalTileCache

AGSBingMapLayer maintains a local cache on the device containing tiles retrieved from the map service. This makes redrawing the map much faster and also reduces overall network usage. This method can be used to clear the local cache.

Returns:

Returns NO if no tiles removed from cache.

Since:

1.0

- (void) dataChanged

This method tells the layer that the data has changed and it should be redrawn.

Since:

1.0

Implemented in AGSGraphicsLayer.

- (id) initWithAppID:		(NSString *)	appID
style:		(AGSBingMapLayerStyle)	style

Initialize this layer with an AppID and a map style.

Parameters:

	appID	The appID authorized to use Bing Maps.
	style	The style of the map. See style.

Returns:

A new Bing Maps layer object.

Since:

1.0

See also:

AGSBingMapLayerStyle

- (void) layerDidFailToLoad:

(NSError *)

error

Method to notify the delegate that a layer failed to load. This method will also post a "LayerFailedToLoad" notification that can be observed by the developer.

Parameters:

error

Information regarding the cause of the layer failing to load.

Since:

1.0

- (void) layerDidLoad

Method to notify the delegate that a layer successfully loaded. This method will also post a "LayerDidLoad" notification that can be observed by the developer.

Since:

1.0

- (NSOperation<AGSTileOperation>*) retrieveImageAsyncForTile:

(AGSTile *)

tile

Retrieve tile asynchronously. This method must be implemented by subclasses.

Parameters:

tile

The tile to get image for.

Returns:

NSOperation that implements the protocol AGSTileOperation for current tile request.

Since:

1.0

See also:

AGSTiledLayerTileDelegate

---

Property Documentation

- (NSString*) appID [read, copy]

An AppID which has been authorized to use Bing Maps.

Since:

1.0

See also:

Getting Started with Bing API

- (id<AGSLayerDelegate>) delegate [read, write, assign, inherited]

Delegate to be notified when the layer is loaded or fails to load. When this layer is loaded, a corresponding AGSLayerView object is automatically set as the delegate. This delegate must not be replaced.

Since:

1.0

- (NSError*) error [read, retain, inherited]

Information about the error associated with a layer.

Since:

1.0

- (AGSEnvelope*) fullEnvelope [read, retain]

Full extent of Bing Maps.

Since:

1.0

Implements AGSLayer.

- (AGSEnvelope*) initialEnvelope [read, retain]

Initial extent of Bing Maps.

Since:

1.0

Implements AGSLayer.

- (BOOL) loaded [read, assign, inherited]

A property indicating whether the layer is loaded and ready to be used. When the layer is loaded, the value becomes YES, and layer properties can be accessed.

Since:

1.0

See also:

AGSLayerDelegate

- (NSString*) name [read, retain, inherited]

The name of the layer. This property will be set by the framework when the layer is added to the map.

Since:

1.8

- (NSOperationQueue*) operationQueue [read, retain, inherited]

Operation queue used by tiled layer to make asynchronous requests. Default operation queue size is 4.

Since:

1.0

- (AGSSpatialReference*) spatialReference [read, retain]

Spatial Reference used by Bing Maps.

Since:

1.0

Implements AGSLayer.

- (AGSBingMapLayerStyle) style [read, assign]

The map style. Possible values include

• AGSBingMapLayerStyleAerial
• AGSBingMapLayerStyleAerialWithLabels
• AGSBingMapLayerStyleRoad

Since:

1.0

- (id<AGSTiledLayerTileDelegate>) tileDelegate [read, write, assign, inherited]

Delegate to be notified when a tile is retrieved asynchronously. When this layer is loaded, a corresponding View object is automatically set as the tileDelegate which should not be replaced.

Since:

1.0

- (AGSTileInfo*) tileInfo [read, retain]

Tiling scheme used by Bing Maps.

Since:

1.0

Implements AGSTiledLayer.

- (BOOL) timeAware [read, assign, inherited]

A property indicating whether the layer is time-aware.

Since:

1.0

- (AGSUnits) units [read, write, assign, inherited]

The units the layer is in. Possible values include

• AGSUnitsCentimeters
• AGSUnitsDecimalDegrees
• AGSUnitsDecimeters
• AGSUnitsFeet
• AGSUnitsInches
• AGSUnitsKilometers
• AGSUnitsMeters
• AGSUnitsMiles
• AGSUnitsMillimeters
• AGSUnitsNauticalMiles
• AGSUnitsPoints
• AGSUnitsUnknown
• AGSUnitsYards

Since:

1.0