PlacesQueryResult

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

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
Example
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

PlacesQueryResult

Constructor
new PlacesQueryResult(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

The name of the class.

Accessor

The query parameters for the next set of results.

PlacesQueryResult

The query parameters for the previous set of results.

PlacesQueryResult

An array of results from searching for places using the queryPlacesNearPoint() and queryPlacesWithinExtent() methods.

PlacesQueryResult

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

nextQueryParams

Property
nextQueryParams PlacesQueryParameters

The query parameters for the next set of results.

previousQueryParams

Property
previousQueryParams PlacesQueryParameters

The query parameters for the previous set of results.

results

Property
results PlaceResult[]

An array of results from searching for places using the queryPlacesNearPoint() and queryPlacesWithinExtent() methods.

See also

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.