require(["esri/rest/support/FetchPlaceParameters"], (FetchPlaceParameters) => { /* code goes here */ });
import FetchPlaceParameters from "@arcgis/core/rest/support/FetchPlaceParameters.js";
esri/rest/support/FetchPlaceParameters
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
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
-
new FetchPlaceParameters(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | An authorization string used to access a resource or service. more details | PlacesParameters | |
String | The name of the class. more details | Accessor | |
String | The Id of the place that you want to fetch additional details. more details | FetchPlaceParameters | |
String[] | The array of fields that define the attributes to return for a place. more details | FetchPlaceParameters | |
String | URL to the places service. more details | PlacesParameters |
Property Details
-
An authorization string used to access a resource or service. API keys are generated and managed in the ArcGIS Developer dashboard. 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
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
placeId String
-
The Id of the place that you want to fetch additional details. This is required.
-
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.
- See also
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(groupKey)inherited
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");