SearchProps

SearchProps = ViewProps & object

Defined in: packages/expo-arcgis-toolkit/src/Search.tsx:43

Type Declaration

currentQuery?

optional currentQuery?: string

The query the search starts with.

enableResultListView?

optional enableResultListView?: boolean

Shows the Toolkit’s list of results.

Default

true

geoView?

optional geoView?: RefObject<GeoViewHandle | null>

The view the search is for, which moves to the results: a <MapView>, <SceneView> or <LocalSceneView> ref.

Default

the view the search is placed in

noResultsMessage?

optional noResultsMessage?: string

Shown when nothing is found.

Default

the Toolkit's ("No results found", localized)

onQueryChange?

optional onQueryChange?: (query) => void

Called with the query as the user types it.

Parameters

query

string

Returns

void

prompt?

optional prompt?: string

Shown in the empty field.

Default

the Toolkit's ("Find a place or address", localized)

queryCenter?

optional queryCenter?: "view" | { latitude: number; longitude: number; }

Where results are prioritized: 'view' for the view’s center as it moves, or a point.

Default

none

repeatSearch?

optional repeatSearch?: boolean

Offers “Repeat search here” once the view has moved away from the results (the Toolkit’s geoViewExtent and isGeoViewNavigating, from the view).

Default

false

resultMode?

optional resultMode?: "single" | "multiple" | "automatic"

How many results a search returns: one, several, or ('automatic') what the query suggests.

Default

'automatic'

resultsOverlay?

optional resultsOverlay?: RefObject<GraphicsOverlayRef | null>

The overlay the results are drawn into: a <GraphicsOverlay> ref, declared in the view. Without one, the results show in the list only, as in the Toolkit.

sources?

optional sources?: SearchSource[]

Where to search.

Default

the Toolkit's: the world geocoder