PlaceResult

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

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
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) {
     // first PlaceResult object from PlacesQueryResult.results
     console.log("PlaceResult: ", placesSolveResult.results[0]);
   }

   findPlaces();
});

Constructors

new PlaceResult(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
Category[]

An arrary of category objects for a place.

more details
PlaceResult
String

The name of the class.

more details
Accessor
Number

The distance, in meters, from the place to the search point.

more details
PlaceResult
Point

A location defined by X and Y coordinates in WGS84.

more details
PlaceResult
String

The name of the place, or point of interest.

more details
PlaceResult
String

The unique Id of this place.

more details
PlaceResult

Property Details

categories Category[]

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
declaredClass Stringreadonly inherited

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

distance Number

The distance, in meters, from the place to the search point. This property is only returned by the queryPlacesNearPoint() method.

location Point

A location defined by X and Y coordinates in WGS84.

See also
name 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 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

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.

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();
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(groupKey){Boolean}inherited

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(groupKey)inherited

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");

Type Definitions

Category

Each category object has a categoryId and a label. A category describes a type of place, such as "petting zoo" or "zoo".

Properties
categoryId Number

The Id of the category of the place. Categories are uniquely identified by a categoryId.

label String

The name of the the category.

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