Class: FindParametersE-mail This Topic Printable Version Give Us Feedback

Description

This data object is used as the findParameters argument to FindTask.execute method. It specifies the search criteria for a find operation.

Class hierarchy

esri.tasks.FindParameters

Constructor

Constructor Description
esri.tasks.FindParameters() Creates a new FindParameters object. The constructor takes no parameters.

Properties

Property Type Description
contains Boolean If "false", the operation searches for an exact match of the searchText string. Otherwise, it searches for a value that contains the searchText provided. The default is "true".
layerIds Number[] The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISMapServiceLayer layerInfos.
outSpatialReference SpatialReference The spatial reference of the output geometries. If outSR is not specified, the output geometries are returned in the spatial reference of the map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
returnGeometry Boolean If "true", the result set include the geometry associated with each result. The default is "false".
searchFields String[] The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched.
searchText String The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters.
Constructor Detail

esri.tasks.FindParameters()

Creates a new FindParameters object. The constructor takes no parameters.
Properties Detail

<Boolean> contains

If "false", the operation searches for an exact match of the searchText string. Otherwise, it searches for a value that contains the searchText provided. The default is "true".
Known values: true | false
Default value: true

<Number[]> layerIds

The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISMapServiceLayer layerInfos.

<SpatialReference> outSpatialReference

The spatial reference of the output geometries. If outSR is not specified, the output geometries are returned in the spatial reference of the map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.

<Boolean> returnGeometry

If "true", the result set include the geometry associated with each result. The default is "false".
Known values: true | false
Default value: false

<String[]> searchFields

The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched.

<String> searchText

The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters.