types | API Reference | ArcGIS Maps SDK for JavaScript 4.33

types

ESM: import * as types from "@arcgis/core/widgets/Search/types.js";

CDN: const types = await $arcgis.import("@arcgis/core/widgets/Search/types.js");

Object: @arcgis/core/widgets/Search/types

Since: ArcGIS Maps SDK for JavaScript 4.33

A module for importing types used in Search modules.

Type Definitions

BaseSearchResponse Type Definition BaseSearchResponse

Base interface of common response properties returned from the search and suggest methods.

Properties: activeSourceIndex Number

The index of the source from which the search result was obtained.

searchTerm String

The searched expression.

numResults Number

The number of search results.

BaseSearchResults Type Definition BaseSearchResults

Base interface of common search result properties returned from the search and suggest methods.

Properties: source LayerSearchSource|LocatorSearchSource

The search source.

sourceIndex Number

The index.

error Error

optional
The search error.

SearchResponse Type Definition SearchResponse BaseSearchResponse

When resolved, returns this response after calling search.

Properties: results SearchResults []

An array of objects representing the results of search.

errors SearchResults []

An array of suggest errors.

SearchResult Type Definition SearchResult

The result object returned from the search results.

Properties: extent Extent|null|undefined

The extent, or bounding box, of the returned feature.

feature Graphic

The resulting feature or location obtained from the search.

target Graphic

The resulting target obtained from the search.

name String

The name of the result.

key String|Number|null|undefined

The key related to the suggest result.

sourceIndex Number|null|undefined

The index.

SearchResults Type Definition SearchResults BaseSearchResults

The array of results returned from the search.

SuggestResponse Type Definition SuggestResponse BaseSearchResponse

Result of calling suggest.

Properties: results SuggestResults []

An array of objects representing the results of search.

errors SuggestResults []

An array of search errors.

SuggestResult Type Definition SuggestResult

The result object returned from a suggest.

Properties: location Point

optional
The location of the suggest result.

key String|Number|null|undefined

The key related to the suggest result.

text String|null|undefined

The string name of the suggested location to geocode.

sourceIndex Number|null|undefined

The index of the currently selected result.

SuggestResults Type Definition SuggestResults BaseSearchResults

The array of results returned from the suggest.