AGSIdentifyParameters Class Reference
Description
Instances of this class represent parameters for AGSIdentifyTask operations. Parameters specify the criteria according to which features should be identified in the map. Parameters are passed as an argument to executeWithParameters: on AGSIdentifyTask.
- Defined in:
- AGSIdentifyTask.h ( ArcGIS library)
- Since:
- 1.0
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
Static Public Member Functions | |
| (id) | + identifyParameters |
Properties | |
| NSUInteger | dpi |
| AGSGeometry * | geometry |
| NSArray * | layerDefinitions |
| NSArray * | layerIds |
| AGSIdentifyParametersLayerOption | layerOption |
| NSArray * | layerTimeOptions |
| AGSEnvelope * | mapEnvelope |
| double | maxAllowableOffset |
| BOOL | returnGeometry |
| CGSize | size |
| AGSSpatialReference * | spatialReference |
| AGSTimeExtent * | timeExtent |
| NSUInteger | tolerance |
Member Function Documentation
| - (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
| + (id) identifyParameters |
Initialize autoreleased Identify parameters object with defaults.
- Returns:
- A new, autoreleased, identify parameters object.
- 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
Property Documentation
- (NSUInteger) dpi [read, write, assign] |
Resolution of the map in dots per inch. This property, in conjuction with size, and mapEnvelope, is used by the server to determine which layers are visible. It is also used to calculate a distance, based on the specified tolerance, within which to identify features. This defaults to the ppi in UIDevice(Utility), but it should be set by the user to match the dpi property of the associated map service layer (if any).
- Since:
- 1.0
- (AGSGeometry*) geometry [read, write, retain] |
The geometry according to which features should be identified. AGSPoint is most commonly used for identifying features at a location, but AGSPolygon may also be used for searching within an area.
- Since:
- 1.0
- (NSArray*) layerDefinitions [read, write, retain] |
Array of AGSLayerDefinition objects that allows you to filter the features of individual layers. Definition expressions for layers that are currently not visible will be ignored by the server.
- Availability:
- This feature is only available with services from ArcGIS Server 10.0 or above
- Since:
- 1.0
- (NSArray*) layerIds [read, write, retain] |
Subset of layers within which features should be identified. The layers are specified as a list of layer IDs.
- Since:
- 1.0
- (AGSIdentifyParametersLayerOption) layerOption [read, write, assign] |
Layers within which the features should be identified. Possible values include
AGSIdentifyParametersLayerOptionTop: Top-most layer at the specified locationAGSIdentifyParametersLayerOptionVisible: Visible layers at the specified locationAGSIdentifyParametersLayerOptionAll: All layers at the specified location
By default, only features within the top-most layer are identified.
You can further restrict the set of layers included in the operation by specifying layerIds. When both layerOption and layerIds are specified, the server treats it as a boolean "AND" operator.
- Since:
- 1.0
- (NSArray*) layerTimeOptions [read, write, retain] |
An array of AGSLayerTimeOptions specifiying time related properties for time-aware sub-layers. By default, this array is nil, and the defaults specified in the service are used.
- Availability:
- This feature is only available with services from ArcGIS Server 10.0 or above
- Since:
- 1.8
- (AGSEnvelope*) mapEnvelope [read, write, retain] |
- (double) maxAllowableOffset [read, write, assign] |
The maximum allowable offset used for generalizing geometries returned by the query operation. The default is 0. If 0 is specified the value is not passed to the server in a query. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.
- Availability:
- This feature is only available with services from ArcGIS Server 10.0 or above
- Since:
- 1.0
- (BOOL) returnGeometry [read, write, assign] |
Whether or not the returned results should contain geometries. By default, geometries are returned. You can reduce the size of the result payload by excluding the geometries if you don't intend to display those results on the map.
- Since:
- 1.0
- (CGSize) size [read, write, assign] |
Size of the AGSMapView in pixels. This property, in conjuction with dpi, and mapEnvelope, is used by the server to determine which layers are visible.
- Since:
- 1.0
- (AGSSpatialReference*) spatialReference [read, write, retain] |
The spatial reference of the input and output geometries as well as of the mapEnvelope. If not specified, the geometry and the mapEnvelope are assumed to be in the spatial reference of the map service, and the identified features will also be returned in the spatial reference of the map service.
- Since:
- 1.0
- (AGSTimeExtent*) timeExtent [read, write, retain] |
The time extent of the map. Will be used only for time-aware layers to identify features that have a time stamp/period that falls within the time extent.
- Availability:
- This feature is only available with services from ArcGIS Server 10.0 or above
- Since:
- 1.8
- (NSUInteger) tolerance [read, write, assign] |
The distance, in screen pixels, from the specified geometry within which features should be identified.
- Since:
- 1.0