LayerSearchSource

AMD: require(["esri/widgets/Search/LayerSearchSource"], (LayerSearchSource) => { /* code goes here */ });
ESM: import LayerSearchSource from "@arcgis/core/widgets/Search/LayerSearchSource";
Class: esri/widgets/Search/LayerSearchSource
Inheritance: LayerSearchSource SearchSource Accessor
Since: ArcGIS API for JavaScript 4.11

The following properties define a Layer-based source whose features may be searched by a Search widget instance.

For string field searches, there is no leading wildcard. This effectively makes exactMatch true, which will remove unnecessary search results and suggestions.

Layers created from client-side graphics are not supported.

See also

Constructors

new LayerSearchSource(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Boolean

Indicates whether to automatically navigate to the selected result once selected.

more details
SearchSource
String

The name of the class.

more details
Accessor
String

The results are displayed using this field.

more details
LayerSearchSource
Boolean

Indicates to only return results that match the search value exactly.

more details
LayerSearchSource
Object

For filtering suggests or search results.

more details
SearchSource
GetResultsHandler

Function used to get search results.

more details
SearchSource
GetSuggestionsParameters

Function used to get search suggestions.

more details
SearchSource
Layer

The layer queried in the search.

more details
LayerSearchSource
Number

Indicates the maximum number of search results to return.

more details
SearchSource
Number

Indicates the maximum number of suggestions to return for the widget's input.

more details
SearchSource
Number

Indicates the minimum number of characters required before querying for a suggestion.

more details
SearchSource
String

The name of the source for display.

more details
LayerSearchSource
String[]

One or more field names used to order the query results.

more details
LayerSearchSource
String[]

Specifies the fields returned with the search results.

more details
SearchSource
String

Used as a hint for the source input text.

more details
SearchSource
Boolean

Indicates whether to display a Popup when a selected result is clicked.

more details
SearchSource
PopupTemplate

The popup template used to display search results.

more details
SearchSource
String

Specify this to prefix the user's input of the search text.

more details
SearchSource
Boolean

Indicates whether to show a graphic on the map for the selected source using the resultSymbol.

more details
SearchSource
Symbol

The symbol used to display the result.

more details
SearchSource
String[]

An array of string values representing the names of fields in the feature layer to search.

more details
LayerSearchSource
String

A template string used to display multiple fields in a defined order when results are displayed.

more details
LayerSearchSource
String

Specify this to add a suffix to the user's input for the search value.

more details
SearchSource
Boolean

Indicates whether to display suggestions as the user enters input text in the widget.

more details
SearchSource
String

A template string used to display multiple fields in a defined order when suggestions are displayed.

more details
LayerSearchSource
Boolean

Indicates whether to constrain the search results to the view's extent.

more details
SearchSource
Number

The set zoom scale for the resulting search result.

more details
SearchSource

Property Details

autoNavigate Boolean inherited

Indicates whether to automatically navigate to the selected result once selected.

Default Value:true
declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

displayField String

The results are displayed using this field. Defaults to the layer's displayField or the first string field.

exactMatch Boolean

Indicates to only return results that match the search value exactly. This property only applies to string field searches. exactMatch is always true when searching fields of type number.

Default Value:false
filter Object inherited

For filtering suggests or search results. Setting a value here takes precedence over withinViewEnabled. Please see the object specification table below for details.

Properties
where String
optional

The where clause specified for filtering suggests or search results.

geometry Geometry
optional

The filter geometry for suggests or search results. Extent is the only supported geometry when working with locator sources. See Find Address Candidates for additional information.

Example
const theExtent = new Extent({
  xmin: 11376463,
  ymin: -5163501,
  xmax: 18890529,
  ymax: -662888,
  spatialReference: {
    wkid: 3857
  }
});

const searchExtent = {
  geometry: theExtent,
  where: "TERRITORY = 'Northern Territory'"
};

const sources = [{
  layer: featureLayerTourism,
  placeholder: "Darwin",
  maxResults: 5,
  searchFields: ["POI"],
  displayField: "POI",
  name: "In a Sunburned Country",
  filter: searchExtent
}];

const searchWidget = new Search({
  view: view,
  sources: sources
});

Function used to get search results. See GetResultsHandler for the function definition. When resolved, returns an object containing an array of search results.

Default Value:null
See also

Function used to get search suggestions. See GetSuggestionsParameters for the function definition. When resolved, returns an object containing an array of suggest results.

Default Value:null
See also
layer Layer

The layer queried in the search. This is required. The layer can be a map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer or OGCFeatureLayer. See the SceneLayer Guide page on how to publish SceneLayers with associated feature layers.

Feature layers created from client-side graphics are not supported.

maxResults Number inherited

Indicates the maximum number of search results to return.

Default Value:6
maxSuggestions Number inherited

Indicates the maximum number of suggestions to return for the widget's input.

Default Value:6
minSuggestCharacters Number inherited

Indicates the minimum number of characters required before querying for a suggestion.

Default Value:1
name String

The name of the source for display.

orderByFields String[]

One or more field names used to order the query results. Specfiy ASC (ascending) or DESC (descending) after the field name to control the order. The default order is ASC.

outFields String[] inherited

Specifies the fields returned with the search results.

placeholder String inherited

Used as a hint for the source input text.

popupEnabled Boolean inherited

Indicates whether to display a Popup when a selected result is clicked.

popupTemplate PopupTemplate inherited

The popup template used to display search results. If no popup is needed, set the source's popupTemplate to null.

This property should be set in instances where there is no existing PopupTemplate configured. For example, feature sources will default to any existing popupTemplate configured on the layer.

prefix String inherited

Specify this to prefix the user's input of the search text.

resultGraphicEnabled Boolean inherited

Indicates whether to show a graphic on the map for the selected source using the resultSymbol.

resultSymbol Symbol inherited

The symbol used to display the result.

Known Limitations

This property only applies when the layer/locator/source is not part of the map.

searchFields String[]

An array of string values representing the names of fields in the feature layer to search.

searchTemplate String

A template string used to display multiple fields in a defined order when results are displayed.

Example
LayerSearchSource.searchTemplate = "{County}, {State}";
suffix String inherited

Specify this to add a suffix to the user's input for the search value.

suggestionsEnabled Boolean inherited

Indicates whether to display suggestions as the user enters input text in the widget.

Default Value:true
suggestionTemplate String

A template string used to display multiple fields in a defined order when suggestions are displayed. This takes precedence over displayField. Field names in the template must have the following format: {FieldName}. An example suggestionTemplate could look something like: Name: {OWNER}, Parcel: {PARCEL_ID}.

Example
LayerSearchSource.suggestionTemplate = "Name: {OWNER}, Parcel: {PARCEL_ID}";
withinViewEnabled Boolean inherited

Indicates whether to constrain the search results to the view's extent.

Default Value:false
zoomScale Number inherited

The set zoom scale for the resulting search result. This scale is automatically honored.

Default Value:null
Example
let searchWidget = new Search({
  view: view,
  sources: [
    {
      layer: featureLayer,
      searchFields: ["Name", "Team"],
      name: "LayerSearchSource",
      zoomScale: 500000
    }
  ]
});

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
LayerSearchSource

Creates a deep clone of this object.

more details
LayerSearchSource
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
LayerSearchSource
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
LayerSearchSource

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

Creates a deep clone of this object.

Returns
Type Description
LayerSearchSource A clone of the new LayerSearchSource instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.