AGSGPResultLayer Class Reference

Description

This dynamic layer is returned as a result of calling queryResultImageLayer from an asynchronous geoprocessing task that is associated with a result map service.

Defined in:
AGSGPResultLayer.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSGPResultLayer:
AGSDynamicLayer <AGSCoding> <AGSSecuredResource> AGSLayer

List of all members.

Public Member Functions

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

Properties

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

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
- (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) initWithURL: (NSURL *)  url  

Initialize this layer with a URL of a AGSGPResultLayer

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

Initialize this layer with a URL of a AGSGPResultLayer

Parameters:
url to dynamic map service.
cred AGSCredential to use to access secured resource.
Returns:
A new AGSGPResultLayer 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

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, retain]

The full extent of the layer.

Since:
1.0

Implements AGSLayer.

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

The initial extent of the layer.

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

- (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
- (AGSSpatialReference*) spatialReference [read, retain]

The spatial reference of the returned dynamic layer.

Since:
1.0

Implements AGSLayer.

- (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 AGSGPResultLayer resource in the ArcGIS Server REST Services Directory.

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