import LocationToAddressParameters from "@arcgis/core/rest/support/LocationToAddressParameters.js";const LocationToAddressParameters = await $arcgis.import("@arcgis/core/rest/support/LocationToAddressParameters.js");- Inheritance
- LocationToAddressParameters→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Input parameters for locationToAddress().
- See also
module
/rest/locator
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| readonly inherited | ||
| GeocodeFeatureType[] | null | undefined | | |
| | ||
| | ||
| | ||
| | ||
| | ||
| |
apiKey
- Since
- ArcGIS Maps SDK for JavaScript 5.1
An authorization string used to access a resource or service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.
featureTypes
- Type
- GeocodeFeatureType[] | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.1
The property limits the possible match types returned by the reverseGeocode operation.
language
- Since
- ArcGIS Maps SDK for JavaScript 5.1
This property sets the language in which reverse-geocoded addresses are returned. Addresses in many countries are available in more than one language; in these cases, this property can be used to specify which language should be used for addresses returned by the reverseGeocode operation.
location
The point at which to search for the closest address. The location should be in the same spatial reference as that of the geocode service.
locationType
- Type
- LocationType | null | undefined
Specifies whether the output geometry of "point-address" and "sub-address" matches should be the rooftop point
or street entrance location. Valid values are "rooftop" and "street". The default value is `"rooftop". See World Geocoding Service.
outSpatialReference
- Type
- SpatialReference | null
The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if finding locations by address.
preferredLabelValues
- Type
- GeocodePreferredLabel | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.1
Defines how city names are resolved when ambiguity exists.
| Possible Value | Description |
|---|---|
| local-city | Include the primary local city name in geocoding response output fields. This is the name of the city that the address is within, and may be different than the postal city. |
| postal-city | Include the primary postal city value in geocoding response output fields. This is the primary name assigned to the postal code of the address. |
Methods
| Method | Signature | Class |
|---|---|---|
| inherited static | fromJSON(json: any): any | |
| inherited | toJSON(): any |
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.