AGSDynamicMapServiceLayer Class Reference

Description

An instance of this class allows you to display maps from a dynamic map service of ArcGIS Server. For example, http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Demographics/ESRI_Census_USA/MapServer. A dynamic map service generates map images on the fly.

In a Model-View-Controller architecture, this object represents the Model. The corresponding View object, AGSDynamicLayerView, is created when this layer is added to the map.

Defined in:
AGSDynamicMapServiceLayer.h (ArcGIS library)
See also:
AGSTiledMapServiceLayer for cached map services.
Since:
1.0
Inheritance diagram for AGSDynamicMapServiceLayer:
AGSDynamicLayer <AGSCoding> <AGSSecuredResource> AGSLayer

List of all members.

Public Member Functions

(void) - dataChanged
(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(NSOperation
< AGSDynamicLayerDrawingOperation > *) 		- exportMapImage:
(id) - initWithJSON:
(id) - initWithJSON:URL:
(id) - initWithMapServiceInfo:
(id) - initWithURL:
(id) - initWithURL:credential:
(void) - layerDidFailToLoad:
(void) - layerDidLoad
(void) - resubmitWithURL:credential:

Static Public Member Functions

(id) + dynamicMapServiceLayerWithMapServiceInfo:
(id) + dynamicMapServiceLayerWithURL:
(id) + dynamicMapServiceLayerWithURL:credential:

Properties

AGSCredential * credential
id< AGSLayerDelegate > delegate
NSUInteger dpi
NSError * error
id< AGSExportMapImageDelegate > exportDelegate
AGSEnvelope * fullEnvelope
AGSImageFormat imageFormat
AGSEnvelope * initialEnvelope
NSArray * layerDefinitions
BOOL loaded
AGSMapServiceInfo * mapServiceInfo
double maxScale
double minScale
AGSSpatialReference * spatialReference
BOOL timeAware
BOOL transparent
AGSUnits units
NSURL * URL
NSArray * visibleLayers

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) decodeWithJSON: (NSDictionary *)  json   [optional, inherited]

Decode object from JSON representation.

Parameters:
json The JSON representation of the object to be decoded.
Since:
1.0
+ (id) dynamicMapServiceLayerWithMapServiceInfo: (AGSMapServiceInfo *)  info  

A method to get an initialized, autoreleased layer using an AGSMapServiceInfo object. Use this method if you already have an AGSMapServiceInfo so that another round trip to the server does not occur to retrieve this information.

Parameters:
info Previously retrieved map service info.
Returns:
A new, autoreleased, dynamic map service layer object.
Since:
1.0
+ (id) dynamicMapServiceLayerWithURL: (NSURL *)  url  

A method to get an initialized, autoreleased layer with a URL of an ArcGIS Server dynamic map service.

Parameters:
url URL to a dynamic map service.
Returns:
A new, autoreleased, dynamic map service layer object.
Since:
1.0
+ (id) dynamicMapServiceLayerWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 

A method to get an initialized, autoreleased layer with a URL of an ArcGIS Server dynamic map service.

Parameters:
url URL to dynamic map service.
cred AGSCredential used to access a secured resource.
Returns:
A new, autoreleased, dynamic map service layer object.
Since:
1.0
- (NSDictionary *) encodeToJSON   [optional, inherited]

Encode and return JSON representation for object.

Returns:
JSON representation of object.
Since:
1.0
- (NSOperation<AGSDynamicLayerDrawingOperation>*) exportMapImage: (AGSExportImageParams *)  params  

Get new map image. The exportDelegate is notified when the image is exported. This method must be implemented by subclasses.

Parameters:
params The input parameters for the export image operation.
Since:
1.0
- (id) initWithJSON: (NSDictionary *)  json   [optional, inherited]

Initialize and return object from JSON representation.

Parameters:
json The JSON representation of the object to be created.
Returns:
Object decoded from JSON representation.
Since:
1.0
- (id) initWithJSON: (NSDictionary *)  json
URL: (NSURL *)  url 

For completeness, this is to be used when you have a raw dictionary from the REST endpoint.

Parameters:
json The JSON dictionary to initialize a dynamic map service layer.
url URL pointing to a dynamic map resource.
Since:
1.0
- (id) initWithMapServiceInfo: (AGSMapServiceInfo *)  info  

Initialize this layer with an AGSMapServiceInfo object. Use this method if you already have an AGSMapServiceInfo so that another round trip to the server does not occur to retrieve this information.

Parameters:
info Previously retrieved map service info.
Returns:
A new dynamic map service layer object.
Since:
1.0
- (id) initWithURL: (NSURL *)  url  

Initialize this layer with a URL of an ArcGIS Server dynamic map service

Parameters:
url URL to a dynamic map service.
Returns:
A new dynamic map service layer object.
Since:
1.0
- (id) initWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 

Initialize this layer with a URL of an ArcGIS Server dynamic map service as well as a credential to a secured resource.

Parameters:
url URL to a dynamic map service.
cred AGSCredential to access a secured resource.
Returns:
A new dynamic map service layer object.
Since:
1.0
- (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
- (void) resubmitWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 

If the layer failed to load with a specific url and credential, you can resubmit it with a new URL and credential. This function does nothing if the layer is already loaded. This function also does nothing if the layer is currently trying to load.

Parameters:
url URL to the dynamic map service.
cred AGSCredential to access the secured resource.
Since:
1.0

Property Documentation

- (AGSCredential*) credential [read, copy]

The credential to be used to access secured resources.

Since:
1.0

Reimplemented from <AGSSecuredResource>.

- (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
- (NSUInteger) dpi [read, write, assign]

The DPI (dots-per-inch) resolution of map images generated by the map service.

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

Information about the error associated with a layer.

Since:
1.0
- (id<AGSExportMapImageDelegate>) exportDelegate [read, write, assign, inherited]

Delegate to be notified of events related to exporting the map image. When this layer is loaded, a corresponding View object is automatically set as the exportDelegate which should not be replaced.

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

Full extent of the layer.

Since:
1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, and AGSOpenStreetMapLayer.

- (AGSImageFormat) imageFormat [read, write, assign]

The image format of the map. Possible values include

  • AGSImageFormatPNG32
  • AGSImageFormatPNG24
  • AGSImageFormatPNG8
  • AGSImageFormatPNG
  • AGSImageFormatJPG
  • AGSImageFormatGIF

Please consult the ArcGIS Server REST Services Directory to ensure the map service supports the requested image format.

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

Initial extent of the layer.

Since:
1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, AGSGraphicsLayer, and AGSOpenStreetMapLayer.

- (NSArray*) layerDefinitions [read, write, retain]

The array of AGSLayerDefinition objects that allow you to filter the features of individual layers in the exported map image.

Since:
1.0
- (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
- (AGSMapServiceInfo*) mapServiceInfo [read, retain]

Information about the map service.

Since:
1.0
- (double) maxScale [read, assign, inherited]

The maximum scale of the layer.

Since:
1.0

Implemented in AGSGraphicsLayer.

- (double) minScale [read, assign, inherited]

The minimum scale of the layer.

Since:
1.0

Implemented in AGSGraphicsLayer.

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

The spatial reference of the layer.

Since:
1.0

Implemented in AGSBingMapLayer, AGSGPResultLayer, and AGSOpenStreetMapLayer.

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

A property indicating whether the layer is time-aware.

Since:
1.0
- (BOOL) transparent [read, write, assign]

A property indicating whether or not images generated by the map service should be transparent.

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
- (NSURL*) URL [read, copy]

URL of the dynamic map service resource in the ArcGIS Server REST Services Directory. For example, http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Demographics/ESRI_Census_USA/MapServer.

Since:
1.0
- (NSArray*) visibleLayers [read, write, retain]

The layers to be included in the map image exported by the map service.

Since:
1.0
Copyright © 1995-2010 Esri. All rights reserved.