Optionalproperties: ArcGISGeocoderPropertiesProtected_capabilitiesThe default capabilities for a geocoder.
Protected Readonly_handlesProtected_idThe unique ID for this entity. Once set, this should never change.
Protected Readonly_itemThe item type for this entity when it participates in an App.
ReadonlyaddressThe schema that defines the input address fields.
The country code used to filter results.
ReadonlydefaultDefault address field values to use when they are missing in the input address. For instance, if a geocoder has a "City" input field, then setting its default value to "Victoria" would cause the geocoder to search for addresses within the city of Victoria by default if no city is specified.
OptionaliconURL to an icon that represents this feature source.
OptionalonThe action to be executed when a feature is added.
OptionalonThe action to be executed when a feature is edited.
OptionalqueryAn optional query service that the feature source can use to get features.
Capabilities of the feature source.
The address categories used to filter results.
Determines how a parent object should handle initialization failure in this object. The default is "warn".
"error": support/InitializeError!InitializeError is thrown."warn": Message is logged and
support/InitializableBase!InitializeWarningEvent is raised."ignore": support/InitializableBase!InitializeWarningEvent is
raised.A menu for actions specifically related to features from this source.
A menu for actions specifically related to features from this source.
Default settings that apply to features originating from this source.
A menu for actions specifically related to this source.
A menu for actions specifically related to this source.
The unique ID for this entity.
The item type for this entity when it participates in an App.
Relationships to other feature sources.
The utilities/RequestHelper!RequestHelper to use when making requests to external services. If not specified, a default implementation will be used.
Settings that affect whether a feature source participates in various tasks that are performed on a map.
The URL of the ArcGIS geocode server.
Protected_addCalled to add an attachment to a feature. Subclasses must override this if they support feature attachments.
The feature to add the attachment to.
The attachment to add to the feature.
Protected_addCalled to add new features. Subclasses must override this if they support adding features.
The features to add.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the feature is saved.
Protected_capabilitiesThe capabilities of the feature source.
Protected_createCalled to create the data/Schema!Schema representing the input address.
Protected_createCalled to create the data/FeatureSettings!FeatureSettings for this feature source.
Protected_createProtected_createCalled to create the data/_Relationship!Relationship collection for this feature source.
Protected_createCalled to create the data/Schema!Schema for this feature source.
Protected_createCalled to create the data/TaskSettings!TaskSettings for this feature source.
Protected_deleteCalled to remove attachments from a feature. Subclasses must override this if they support feature attachments.
The feature to delete attachments from.
The attachments or the IDs of the attachments to delete.
Protected_deleteCalled to delete features. Subclasses must override this if they support deleting features.
The IDs of the features to delete.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are deleted.
Protected_getCalled to retrieve attachments for a feature. Subclasses must override this if they support feature attachments.
The feature to get attachments for.
Protected_getCalled to retrieve features. Subclasses must override this if they support querying for features.
The unique IDs of features to retrieve.
Optionaloptions: FeatureReadOptionsOptions that control what gets returned.
Protected_getThe property keys and their metadata that are used to implement serializing and deserializing the class instance.
Protected_initializableCollections of child items to initialize. Items that fail to initialize are removed from the collection.
Protected_initializeProtected_isProtected_onProtected_onCalled to perform initialization of the support/InitializableBase!InitializableBase. Subclasses should override this method rather than initialize() to perform custom initialization.
Protected_postProtected_toConverts the value to a PropertyDef object.
The value to convert.
Protected_updateCalled to update features. Subclasses must override this if they support updating features.
The feature to update.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the feature is saved.
Adds an attachment to a feature.
The feature to add the attachment to.
The attachment to add to the feature.
Adds a new feature to the source. If the source does not support adding features, then an InvalidOperationError will be thrown (see capabilities).
The feature to add.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the feature is saved.
Adds a set of features to the source. If the source does not support adding features, then an InvalidOperationError will be thrown (see capabilities).
The features to add.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are saved.
Finds locations corresponding to multiple addresses. The geocoder must have the supportsBatchGeocoding capability (see capabilities).
The addresses to search for. Can either be a string like "123 Sesame Street", or a feature or JSON object representing an address. In the latter case, the address field names and types understood by the geocoder are defined by the addressSchema property. Only the attributes are used -- any geometries on input features are ignored.
Optionaloptions: GeocodeOptionsOptions that affect how the search is performed.
A set of features representing a candidate matches for each address. In addition to its normal attributes, each feature will have a special data/Feature!SCORE_FIELD attribute which is a number from 0 to 100 indicating a level of confidence in the match. It will also have a special tasks/geocoding/Geocoder!ADDRESS_FIELD attribute which is the input address that it matches.
Counts the number of locations corresponding to an address.
The address to search for. Can either be a string like "123 Sesame Street", or a feature or JSON object representing an address. In the latter case, the address field names and types understood by the geocoder are defined by the addressSchema property. Only the attributes are used -- any geometry on the input feature is ignored.
Optionaloptions: GeocodeOptionsOptions that affect how the search is performed.
A count resulting indicating the number of candidate matches for the address.
Deletes attachments from a feature.
The feature to delete attachments from.
The attachments or the IDs of the attachments to delete from the feature.
Deletes a feature from its source. If the source does not support deleting features, then an InvalidOperationError will be thrown (see capabilities).
The ID of the feature to delete.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are deleted.
Deletes a feature from its source. If the source does not support deleting features, then an InvalidOperationError will be thrown (see capabilities).
The feature to delete.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are deleted.
Deletes features from their source. If the source does not support deleting features, then an InvalidOperationError will be thrown (see capabilities).
The IDs of the features to delete.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are deleted.
Deletes features from their source. If the source does not support deleting features, then an InvalidOperationError will be thrown (see capabilities).
The features to delete.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are deleted.
Finds one or more locations corresponding to an address.
The address to search for. Can either be a string like "123 Sesame Street", or a feature or JSON object representing an address. In the latter case, the address field names and types understood by the geocoder are defined by the addressSchema property. Only the attributes are used -- any geometry on the input feature is ignored.
Optionaloptions: GeocodeOptionsOptions that affect how the search is performed.
A set of features representing candidate matches for the address. In addition to its normal attributes, each feature will have a special data/Feature!SCORE_FIELD attribute which is a number from 0 to 100 indicating a level of confidence in the match.
Gets any attachments associated with a feature.
The feature to get attachments for.
Gets a feature by ID. If no such feature exists, the promise is rejected with an instance of NotFoundError.
The ID of the feature to retrieve.
Optionaloptions: FeatureReadOptionsAdditional options that control how the feature is retrieved.
Gets a set of features by their IDs.
The IDs of the features to retrieve.
Optionaloptions: FeatureReadOptionsAdditional Options that control how the features are retrieved.
Returns the serializable properties.
OptionalserializeMode: SerializeModeOptional. If specified, only properties that support the given serialization mode will be returned.
Finds the address at a particular location. The geocoder must have the supportsReverseGeocoding capability (see capabilities).
The location to search for.
Optionaloptions: GeocodeOptionsOptions that affect how the search is performed.
A feature representing the address at the given location, or undefined if there is no match.
Suggests matching addresses to search for based on some input text. The geocoder must have the supportsSuggest capability (see capabilities).
The input text to search for.
Optionaloptions: GeocodeOptionsOptions that affect how the search is performed.
A list of formatted address suggestions.
Saves changes to an existing feature. If the source does not support updating features, then an InvalidOperationError will be thrown (see capabilities).
The feature to update.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the feature is saved.
Saves changes to a existing features. If the source does not support updating features, then an InvalidOperationError will be thrown (see capabilities).
The features to update.
Optionaloptions: FeatureWriteOptionsAdditional options that control how the features are saved.
StaticfromCreates an ArcGIS Geocoder from an ItemConfig that contains a $portalItem reference.
The portal item containing geocoder config.
OptionalarcGISGeocoderProperties: ArcGISGeocoderPropertiesThe configuration for the ArcGIS Geocoder.
Represents an ArcGIS geocoding service.