require(["esri/rest/support/PlacesQueryResult"], (PlacesQueryResult) => { /* code goes here */ });
import PlacesQueryResult from "@arcgis/core/rest/support/PlacesQueryResult.js";
esri/rest/support/PlacesQueryResult
The PlacesQueryResult object includes the results from the
queryPlacesNearPoint() and
queryPlacesWithinExtent() methods.
Along with the results themselves, the previous or next set
of query parameters are also included. The results are an array of PlaceResult
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) {
// results from the queryPlacesNearPoint() method
console.log("PlacesQueryResult: ", placesSolveResult);
}
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 |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| PlacesQueryParameters | The query parameters for the next set of results. | PlacesQueryResult | |
| PlacesQueryParameters | The query parameters for the previous set of results. | PlacesQueryResult | |
| PlaceResult[] | An array of results from searching for places using the queryPlacesNearPoint() and queryPlacesWithinExtent() methods. | PlacesQueryResult |
Property Details
-
nextQueryParams
PropertynextQueryParams PlacesQueryParameters -
The query parameters for the next set of results.
-
previousQueryParams
PropertypreviousQueryParams PlacesQueryParameters -
The query parameters for the previous set of results.
-
results
Propertyresults PlaceResult[] -
An array of results from searching for places using the queryPlacesNearPoint() and queryPlacesWithinExtent() methods.
- 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");