FetchPlaceParameters

AMD: require(["esri/rest/support/FetchPlaceParameters"], (FetchPlaceParameters) => { /* code goes here */ });
ESM: import FetchPlaceParameters from "@arcgis/core/rest/support/FetchPlaceParameters.js";
Class: esri/rest/support/FetchPlaceParameters
Inheritance: FetchPlaceParameters PlacesParameters Accessor
Since: ArcGIS Maps SDK for JavaScript 4.27

The following properties define the parameters for the fetchPlace() method pointing to a url that represents a places service. The places service is a ready-to-use service that can search for businesses and geographic locations around the world. It allows you to discover, locate, and return detailed information about a place.

See also
Example
require([
 "esri/rest/places",
 "esri/rest/support/FetchPlaceParameters"
], function(places, FetchPlaceParameters) {
   const swedishFetchPlaceParameters = new FetchPlaceParameters({
     apiKey: "YOUR_API_KEY",
     placeId: "571624acd79b8a99897357a25b744a20",  // really good plumber
     requestedFields: ["address", "description", "hours", "socialMedia"]
   });

   function fetchPlaceDetails() {
     places.fetchPlace(swedishFetchPlaceParameters).then(showPlaceDetails);
   }

   function showPlaceDetails(fetchResult) {
     console.log("Fetch place result: ", fetchResult);
   }

   fetchPlaceDetails();
});

Constructors

FetchPlaceParameters

Constructor
new FetchPlaceParameters(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

An authorization string used to access a resource or service.

PlacesParameters

The name of the class.

Accessor

Determines whether icons are returned and the type of icons returned.

PlacesParameters

The Id of the place that you want to fetch additional details.

FetchPlaceParameters

The array of fields that define the attributes to return for a place.

FetchPlaceParameters

URL to the places service.

PlacesParameters

Property Details

apiKey

Inherited
Property
apiKey String
Inherited from PlacesParameters

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.

See also

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

icon

Inherited
Property
icon String
Inherited from PlacesParameters
Since: ArcGIS Maps SDK for JavaScript 4.30 PlacesParameters since 4.27, icon added at 4.30.

Determines whether icons are returned and the type of icons returned. The PNG icons are provided as 48 x 48 pixels but for map display the recommended size is 16 x 16 pixels. Icons are not returned if the value is null.

Possible Values:"cim" |"png" |"svg"

placeId

Property
placeId String

The Id of the place that you want to fetch additional details. This is required.

requestedFields

Property
requestedFields String[]

The array of fields that define the attributes to return for a place. Use this property to define the attributes you would like returned. This is required.

url

Inherited
Property
url String
Inherited from PlacesParameters

URL to the places service. The places service is a ready-to-use service that can search for businesses and geographic locations around the world. It allows you to discover, locate, and return detailed information about a place.

Default Value:"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1"

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.