Packagecom.esri.ags.tasks.supportClasses
Classpublic class FindParameters
InheritanceFindParameters Inheritance Object

Input parameters for a FindTask.

View the examples

See also

com.esri.ags.tasks.FindTask
Live sample - Find features
Live sample - Zoom to found features


Public Properties
 PropertyDefined By
  contains : Boolean = true
The contains parameter determines whether to look for an exact match of the search text or not.
FindParameters
  layerDefinitions : Array
Array of layer definition expressions that allows you to filter the features of individual layers in the results.
FindParameters
  layerIds : Array
The layers to perform the Find operation on.
FindParameters
  maxAllowableOffset : Number
The maximum allowable offset used for generalizing geometries returned by the Find operation.
FindParameters
  outSpatialReference : SpatialReference
The well-known ID of the spatial reference of the output geometries.
FindParameters
  returnGeometry : Boolean = false
If true, each feature in the FeatureSet includes the geometry.
FindParameters
  searchFields : Array
A list of names of the fields to search.
FindParameters
  searchText : String
The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters.
FindParameters
Property Detail
containsproperty
public var contains:Boolean = true

The contains parameter determines whether to look for an exact match of the search text or not. If true, searches for a value that contains the search text provided. This is a case-insensitive search. If false, searches for an exact match of the search text string. The exact match is case-sensitive.

The default value is true.

layerDefinitionsproperty 
public var layerDefinitions:Array

Since : ArcGIS API for Flex 2.0

Array of layer definition expressions that allows you to filter the features of individual layers in the results. Requires ArcGIS Server 10.0 or above.

layerIdsproperty 
public var layerIds:Array

The layers to perform the Find operation on. The ID is returned in layerInfos.


Example
ActionScript to use layerIds:
     myFindParameters.layerIds = [0,1,2];
maxAllowableOffsetproperty 
public var maxAllowableOffset:Number

Since : ArcGIS API for Flex 2.0

The maximum allowable offset used for generalizing geometries returned by the Find operation. The units are the same as the returned features. Requires ArcGIS Server 10.0 or above.

outSpatialReferenceproperty 
public var outSpatialReference:SpatialReference

The well-known ID of the spatial reference of the output geometries. If outSR is not specified, the output geometries are returned in the spatial reference of the map.

returnGeometryproperty 
public var returnGeometry:Boolean = false

If true, each feature in the FeatureSet includes the geometry. This should be set to false if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.

The default value is false.

searchFieldsproperty 
public var searchFields:Array

A list of names of the fields to search. If not specified, all fields will be searched.

searchTextproperty 
public var searchText:String

The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters. Wildcards inside search strings are not supported (use Query if you need this functionality). Use the contains parameter to switch between case sensitive or insensitive searches.

Examples
ActionScript to use FindParameters:
 myFindTask.execute( myFindParams );