Skip to content
Guides API

GeocodeParameters

GeocodeParameters = object

Defined in: src/ExpoArcgis.types.ts:1292

Parameters for geocoder.geocode. Mirrors the native GeocodeParameters.

Properties

Section titled “Properties”

categories?

Section titled “categories?”

optional categories?: string[]

Defined in: src/ExpoArcgis.types.ts:1318

Place categories to filter by (e.g. ['Coffee shop']).

countryCode?

Section titled “countryCode?”

optional countryCode?: string

Defined in: src/ExpoArcgis.types.ts:1316

Two/three-letter country code to constrain the search.

locatorUrl?

Section titled “locatorUrl?”

optional locatorUrl?: string

Defined in: src/ExpoArcgis.types.ts:1325

Locator to use. An online geocode-service URL, or a local path to an offline locator (.loc) for disconnected geocoding. Defaults to the ArcGIS World Geocoding Service.

maxResults?

Section titled “maxResults?”

optional maxResults?: number

Defined in: src/ExpoArcgis.types.ts:1303

Maximum number of matches to return.

outputSpatialReference?

Section titled “outputSpatialReference?”

optional outputSpatialReference?: number

Defined in: src/ExpoArcgis.types.ts:1314

WKID of the spatial reference for returned locations (e.g. 3857 for Web Mercator, 4326 for WGS84). When omitted the locator returns coordinates in its own SR.

preferredSearchLocation?

Section titled “preferredSearchLocation?”

optional preferredSearchLocation?: PointGeometry

Defined in: src/ExpoArcgis.types.ts:1320

A point near which results are preferred.

resultAttributeNames?

Section titled “resultAttributeNames?”

optional resultAttributeNames?: string[]

Defined in: src/ExpoArcgis.types.ts:1309

Attribute names to include on each result (e.g. ['*'] for all, or ['Match_addr', 'City', 'Region'] for a specific subset). When omitted the locator returns its default set.

searchValues?

Section titled “searchValues?”

optional searchValues?: Record<string, string>

Defined in: src/ExpoArcgis.types.ts:1301

Structured address fields for multi-field geocoding (e.g. { Address: "380 New York St", City: "Redlands", Region: "CA", Postal: "92373" }). When provided, the SDK’s multi-field overload is used instead of the single-line text search. Field names must match the locator’s input fields (the World Geocoder accepts Address, Address2, Address3, City, Region, Postal, PostalExt, CountryCode). If both searchValues and searchText are supplied, searchValues takes precedence.