AGSTiledLayer Class Reference

---

Description

A base class for layers which displays cached maps. You would typically work with one or more sub-classes of this class, for instance, AGSTiledMapServiceLayer.

In a Model-View-Controller architecture, this object represents the Model. The corresponding View object, AGSTiledLayerView, is created when subclasses, for instance AGSTiledMapServiceLayer, are added to the map.

Defined in:

AGSTiledLayer.h (ArcGIS library)

Since:

1.0

Inheritance diagram for AGSTiledLayer:

List of all members.

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

---

Member Function Documentation

- (void) dataChanged

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

Since:

1.0

Implemented in AGSGraphicsLayer.

- (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

- (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, assign, inherited]

Full extent of the layer.

Since:

1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, and AGSOpenStreetMapLayer.

- (AGSEnvelope*) initialEnvelope [read, assign, inherited]

Initial extent of the layer.

Since:

1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, AGSGraphicsLayer, and AGSOpenStreetMapLayer.

- (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]

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

Since:

1.0

- (AGSSpatialReference*) spatialReference [read, assign, inherited]

The spatial reference of the layer.

Since:

1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, and AGSOpenStreetMapLayer.

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

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 for the layer. This property must be implemented by subclasses.

Since:

1.0

Implemented in AGSBingMapLayer, and AGSOpenStreetMapLayer.

- (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