require(["esri/rest/support/PlaceResult"], (PlaceResult) => { /* code goes here */ });
import PlaceResult from "@arcgis/core/rest/support/PlaceResult.js";
esri/rest/support/PlaceResult
The PlaceResult object includes a single place that satisfies the search and
either: the distance from the search point
in meters, or falls within the extent of the search.
The PlacesQueryResult.results property is an array
of these objects.
- See also
require([
"esri/rest/places",
"esri/rest/support/PlacesQueryParameters"
], function(places, PlacesQueryParameters) {
const point = {
type: "point", // autocasts as new Point()
longitude: 17.81840,
latitude: 59.42145
};
const swedishPlacesQueryParameters = new PlacesQueryParameters({
apiKey: "YOUR_API_KEY",
categoryIds: ["11077"], // Bathroom Contractor
radius: 10000, // set radius to 10,000 meters
point
});
function findPlaces() {
places.queryPlacesNearPoint(swedishPlacesQueryParameters).then(showPlaces);
}
function showPlaces(placesSolveResult) {
// first PlaceResult object from PlacesQueryResult.results
console.log("PlaceResult: ", placesSolveResult.results[0]);
}
findPlaces();
});Constructors
-
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 |
|---|---|---|---|
| Category[] | An arrary of category objects for a place. | PlaceResult | |
| String | The name of the class. | Accessor | |
| Number | The distance, in meters, from the place to the search point. | PlaceResult | |
| Point | A location defined by X and Y coordinates in WGS84. | PlaceResult | |
| String | The name of the place, or point of interest. | PlaceResult | |
| String | The unique Id of this place. | PlaceResult |
Property Details
-
An arrary of category objects for a place. Each category object has a categoryId and a label. A category describes a type of place, such as "movie theater" or "zoo".
Categories are uniquely identified by a categoryId. For example, 17119 identifies a "Bicycle Store" and 10051 identifies a "Stadium". Note that a single place can belong to multiple categories (for example, a gas station could also have a super-market).
- See also
-
distance
Propertydistance Number -
The distance, in meters, from the place to the search point. This property is only returned by the queryPlacesNearPoint() method.
-
name
Propertyname String -
The name of the place, or point of interest. You can search for places by name using the searchText property in the queryPlacesNearPoint() and queryPlacesWithinExtent() methods.
-
placeId
PropertyplaceId String -
The unique Id of this place. This place Id can be passed to the places/{placeId} endpoint to retrieve additional details.
- See also
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
Method Details
-
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();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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
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");
Type Definitions
-
Each category object has a categoryId and a label. A category describes a type of place, such as "petting zoo" or "zoo".