AGSFindParameters Class Reference
Description
Instances of this class represent parameters for AGSFindTask operations. Parameters provide criteria for performing a search on the map service. Parameters are passed as an argument to executeWithParameters: on AGSFindTask.
- Defined in:
- AGSFindTask.h ( ArcGIS library)
- Since:
- 1.0
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
Properties | |
| BOOL | contains |
| NSArray * | layerDefinitions |
| NSArray * | layerIds |
| double | maxAllowableOffset |
| AGSSpatialReference * | outSpatialReference |
| BOOL | returnGeometry |
| NSArray * | searchFields |
| NSString * | searchText |
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) 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
- (BOOL) contains [read, write, assign] |
If NO, AGSFindTask searches for an exact match of searchText and in a case sensitive manner. Otherwise, it searches for a value that contains the searchText and in a case agnostic manner. Default is YES.
- 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] |
The IDs of layers to to be searched. This parameter must be specified.
- Since:
- 1.0
- (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 spatial reference. If a spatial reference 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
- (AGSSpatialReference*) outSpatialReference [read, write, retain] |
The spatial reference of the result geometries. By default, geometries are returned in the spatial reference of the map service.
- 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
- (NSArray*) searchFields [read, write, retain] |
The names of fields to be searched. If this parameter is not specified, all fields are searched.
- Since:
- 1.0
- (NSString*) searchText [read, write, copy] |
The text to be searched.
- Since:
- 1.0