# Interface ArcGISGeocoderProperties

Properties that can be passed into the constructor for ArcGISGeocoder.

interface ArcGISGeocoderProperties {
$portalItem?: PortalItemLike;
addressSchema?: SchemaProperties;
attachmentTypes?: string[];
categories?: string[];
countryCode?: string;
defaultAddressValues?: Record<string, unknown>;
failureMode?: FailureMode;
featureActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>;
featureSettings?: FeatureSettingsProperties;
featureSourceActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>;
hyperlinks?: (HyperlinkProperties | Hyperlink)[];
iconUrl?: string;
id?: string;
onAddFeature?: Action;
onEditFeature?: Action;
relationships?: (Relationship | RelationshipProperties)[];
requestHelper?: ArcGISRequestHelper;
schema?: SchemaProperties;
taskSettings?: TaskSettingsProperties;
title?: string;
url?: string;
}

#### Hierarchy (view full)

- GeocoderProperties
  - ArcGISGeocoderProperties

#####
Index

### Properties

$portalItem?
addressSchema?
attachmentTypes?
categories?
countryCode?
defaultAddressValues?
failureMode?
featureActions?
featureSettings?
featureSourceActions?
hyperlinks?
iconUrl?
id?
onAddFeature?
onEditFeature?
relationships?
requestHelper?
schema?
taskSettings?
title?
url?

##
Properties

### `Optional`$portalItem

$portalItem?: PortalItemLike

When present, the geocoder will be loaded from the given item in Portal.

### `Optional` addressSchema

addressSchema?: SchemaProperties

See tasks/geocoding/Geocoder!Geocoder.addressSchema.

Inherited from GeocoderProperties.addressSchema

### `Optional` attachmentTypes

attachmentTypes?: string[]

See data/FeatureSource!FeatureSource.attachmentTypes.

Inherited from GeocoderProperties.attachmentTypes

### `Optional` categories

categories?: string[]

See ArcGISGeocoder.categories.

### `Optional` countryCode

countryCode?: string

See ArcGISGeocoder.countryCode.

### `Optional` defaultAddressValues

defaultAddressValues?: Record<string, unknown>

See tasks/geocoding/Geocoder!Geocoder.defaultAddressValues.

Inherited from GeocoderProperties.defaultAddressValues

### `Optional` failureMode

failureMode?: FailureMode

See support/InitializableBase!InitializableBase.failureMode.

Inherited from GeocoderProperties.failureMode

### `Optional` featureActions

featureActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>

A menu for actions specifically related to features from this source.

Inherited from GeocoderProperties.featureActions

### `Optional` featureSettings

featureSettings?: FeatureSettingsProperties

See data/FeatureSource!FeatureSource.featureSettings.

Inherited from GeocoderProperties.featureSettings

### `Optional` featureSourceActions

featureSourceActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>

A menu for actions specifically related to this source.

Inherited from GeocoderProperties.featureSourceActions

### `Optional` hyperlinks

hyperlinks?: (HyperlinkProperties | Hyperlink)[]

See data/FeatureSource!FeatureSource.hyperlinks.

Inherited from GeocoderProperties.hyperlinks

### `Optional` iconUrl

iconUrl?: string

See data/FeatureSource!FeatureSource.iconUrl.

Inherited from GeocoderProperties.iconUrl

### `Optional` id

id?: string

The unique ID to assign to the entity. If not specified, one will be generated.

Inherited from GeocoderProperties.id

### `Optional` onAddFeature

onAddFeature?: Action

See data/FeatureSource!FeatureSource.onAddFeature.

Inherited from GeocoderProperties.onAddFeature

### `Optional` onEditFeature

onEditFeature?: Action

See data/FeatureSource!FeatureSource.onEditFeature.

Inherited from GeocoderProperties.onEditFeature

### `Optional` relationships

relationships?: (Relationship | RelationshipProperties)[]

See data/FeatureSource!FeatureSource.relationships.

Inherited from GeocoderProperties.relationships

### `Optional` requestHelper

requestHelper?: ArcGISRequestHelper

See ArcGISGeocoder.requestHelper.

### `Optional` schema

schema?: SchemaProperties

See data/FeatureSource!FeatureSource.schema.

Inherited from GeocoderProperties.schema

### `Optional` taskSettings

taskSettings?: TaskSettingsProperties

See data/FeatureSource!FeatureSource.taskSettings.

Inherited from GeocoderProperties.taskSettings

### `Optional` title

title?: string

See tasks/geocoding/Geocoder!Geocoder.title.

Inherited from GeocoderProperties.title

### `Optional` url

url?: string

See ArcGISGeocoder.url.