Search

The current active menu of the Search component.

Attribute

active-menu

Default value

"none"

The source object currently selected. Can be either a LayerSearchSource or a LocatorSearchSource.

Default value

null

The selected source's index. This value is -1 when all sources are selected.

Attribute

active-source-index

Default value

0

String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the component.

Attribute

all-placeholder

Default value

"Find address or place"

The combined collection of defaultSources and sources. The defaultSources displays first in the Search UI.

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.

Attribute

auto-destroy-disabled

Default value

false

Indicates whether to automatically navigate to the selected result. If true, will not automatically navigate to the selected result.

Attribute

auto-navigate-disabled

Default value

false

By default, the component will automatically select and zoom to the first geocoded result. When true, the findAddressCandidates operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a search-complete event handler and get the results through the event object.

Attribute

auto-select-disabled

Default value

false

A read-only property that is a Collection of LayerSearchSource and/or LocatorSearchSource. This property may contain ArcGIS Portal locators and any web map or web scene configurable search sources. Web maps or web scenes may contain map/feature service feature layer(s), and/or table(s) as sources.

This property is used to populate the Search UI if the sources property is not set.

When true, the component is visually withdrawn and cannot be interacted with.

Attribute

disabled

Default value

false

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

Read more...

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"search"

When true, will not include defaultSources in the Search UI.

Attribute

include-default-sources-disabled

Default value

false

The component's default label.

Attribute

label

When true, will disable location services within the component.

Note: The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports Window.isSecureContext (currently Chrome and Firefox).

Attribute

location-disabled

Default value

false

The maximum number of results returned by the component if not specified by the source.

Attribute

max-results

Default value

6

The maximum number of suggestions returned by the component if not specified by the source.

If working with the default ArcGIS Online Geocoding service, the default remains at 5.

Attribute

max-suggestions

Default value

6

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

The minimum number of characters needed for the search if not specified by the source.

Attribute

min-suggest-characters

Default value

3

By default, the graphic can be clicked to display a Popup. When true, disables displaying the Popup on feature click.

Attribute

popup-disabled

Default value

false

A customized PopupTemplate for the selected feature. Note that any templates defined on allSources take precedence over those defined directly on the template.

Default value

null

It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.

Attribute

position

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

Attribute

reference-element

The graphic used to highlight the resulting feature or location.

Note: A graphic will be placed in the View's graphics for layer that do not support the highlight method.

Default value

null

If true, the resultGraphic will not display at the location of the selected feature.

Attribute

result-graphic-disabled

Default value

false

An array of objects, each containing a SearchResult from the search.

Default value

null

By default, the "All" option is displayed by default to search all sources:

When true, no option to search all sources at once is available:

Attribute

search-all-disabled

Default value

false

The value of the search box input text string.

Attribute

search-term

The result selected from a search.

See also

• arcgisSelectResult
• select()

Default value

null

The Search component may be used to search features in a map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer or OGCFeatureLayer, or table, or geocode locations with a locator. The sources property defines the sources from which to search for the view specified by the Search component instance. There are two types of sources:

• LayerSearchSource
• LocatorSearchSource

Any combination of these sources may be used together in the same instance of the Search component.

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

The current state of the component.

Attribute

state

Default value

"ready"

An array of results from the suggest method.

This is available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Default value

null

If true, disables suggestions for the component.

This is only available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Attribute

suggestions-disabled

Default value

false

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Search component will be associated with a map or scene component rather than using the view property.

Default value

null

Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. It also hides any open menus.

Returns

void

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
const arcgisSearch = document.querySelector("arcgis-search");
document.body.append(arcgisSearch);
await arcgisSearch.componentOnReady();
console.log("arcgis-search is ready to go!");

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified locator(s) and returns any applicable results.

Parameters

Returns

Promise<SearchResponse | null | undefined>

Brings focus to the component's text input.

Returns

Promise<void>

Performs a suggest() request on the active Locator. It also uses the current value of the component or one that is passed in.

Suggestions are available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Parameters

Returns

Promise<SuggestResponse | null | undefined>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is ready to be interacted with.

Fires when a result is cleared from the input box or a new result is selected.

Fires when the search() method is called and returns its results.

Fires when the search() method starts.

Fires when a search result is selected.

Fires when the suggest method is called and returns its results.

Fires when the suggest() method starts.