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)

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.

OptionaladdressSchema

addressSchema?: SchemaProperties

See tasks/geocoding/Geocoder!Geocoder.addressSchema.

OptionalattachmentTypes

attachmentTypes?: string[]

See data/FeatureSource!FeatureSource.attachmentTypes.

Optionalcategories

categories?: string[]

See ArcGISGeocoder.categories.

OptionalcountryCode

countryCode?: string

See ArcGISGeocoder.countryCode.

OptionaldefaultAddressValues

defaultAddressValues?: Record<string, unknown>

See tasks/geocoding/Geocoder!Geocoder.defaultAddressValues.

OptionalfailureMode

failureMode?: FailureMode

See support/InitializableBase!InitializableBase.failureMode.

OptionalfeatureActions

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

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

OptionalfeatureSettings

featureSettings?: FeatureSettingsProperties

See data/FeatureSource!FeatureSource.featureSettings.

OptionalfeatureSourceActions

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

A menu for actions specifically related to this source.

Optionalhyperlinks

hyperlinks?: (HyperlinkProperties | Hyperlink)[]

See data/FeatureSource!FeatureSource.hyperlinks.

OptionaliconUrl

iconUrl?: string

See data/FeatureSource!FeatureSource.iconUrl.

Optionalid

id?: string

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

OptionalonAddFeature

onAddFeature?: Action

See data/FeatureSource!FeatureSource.onAddFeature.

OptionalonEditFeature

onEditFeature?: Action

See data/FeatureSource!FeatureSource.onEditFeature.

Optionalrelationships

relationships?: (Relationship | RelationshipProperties)[]

See data/FeatureSource!FeatureSource.relationships.

OptionalrequestHelper

requestHelper?: ArcGISRequestHelper

See ArcGISGeocoder.requestHelper.

Optionalschema

schema?: SchemaProperties

See data/FeatureSource!FeatureSource.schema.

OptionaltaskSettings

taskSettings?: TaskSettingsProperties

See data/FeatureSource!FeatureSource.taskSettings.

Optionaltitle

title?: string

See tasks/geocoding/Geocoder!Geocoder.title.

Optionalurl

url?: string

See ArcGISGeocoder.url.

Settings

Member Visibility

On This Page

Properties