AGSLayer Class Reference


Description

A base class for all layers, tiled or dynamic. Sub-classes must provide implementation for the spatialReference, fullEnvelope, initialEnvelope, and units properties declared by this class. They must also update the loaded property and notify the delegate when appropriate.

Will fire notifications for LayerDidLoad and LayerFailedToLoad.

See also:
Conceptual Doc: Overview of Layers
Since:
1.0
Inheritance diagram for AGSLayer:
AGSDynamicLayer AGSTiledLayer AGSDynamicMapServiceLayer AGSGPResultLayer AGSGraphicsLayer AGSImageServiceLayer AGSBingMapLayer AGSLocalTiledLayer AGSOpenStreetMapLayer AGSTiledMapServiceLayer

List of all members.

Public Member Functions

(void) - dataChanged
(void) - layerDidFailToLoad:
(void) - layerDidLoad

Properties

id< AGSLayerDelegatedelegate
NSError * error
AGSEnvelopefullEnvelope
AGSEnvelopeinitialEnvelope
BOOL loaded
NSString * name
BOOL renderNativeResolution
AGSSpatialReferencespatialReference
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

Property Documentation

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

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]

Information about the error associated with a layer.

Since:
1.0
- (AGSEnvelope*) fullEnvelope [read, assign]

Full extent of the layer.

Since:
1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, and AGSOpenStreetMapLayer.

- (AGSEnvelope*) initialEnvelope [read, assign]

Initial extent of the layer.

Since:
1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, AGSGraphicsLayer, and AGSOpenStreetMapLayer.

- (BOOL) loaded [read, assign]

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]

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

Since:
1.8
- (BOOL) renderNativeResolution [read, assign]

Gets a value that determines if the layer renders at the native resolution. This property will not have any affect on iOS devices without a retina display. If using an iOS device with a retina display and you want to take advantage of that display you can set this value to YES. If YES, this layer will use more memory and network bandwidth, but the layer will render at a higher resolution. This property is not settable for every layer type.

Since:
2.1

Implemented in AGSGPResultLayer, AGSGraphicsLayer, AGSDynamicMapServiceLayer, AGSImageServiceLayer, AGSTiledMapServiceLayer, and AGSLocalTiledLayer.

- (AGSSpatialReference*) spatialReference [read, assign]

The spatial reference of the layer.

Since:
1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, and AGSOpenStreetMapLayer.

- (BOOL) timeAware [read, assign]

A property indicating whether the layer is time-aware.

Since:
1.0
- (AGSUnits) units [read, write, assign]

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