import PlaceResult from "@arcgis/core/rest/support/PlaceResult.js";const PlaceResult = await $arcgis.import("@arcgis/core/rest/support/PlaceResult.js");- 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 PlacesQueryParameters.extent of the search.
The PlacesQueryResult.results property is an array
of these objects.
- Example
- const [places, PlacesQueryParameters] = await $arcgis.import(["@arcgis/core/rest/places.js","@arcgis/core/rest/support/PlacesQueryParameters.js"]);const point = {type: "point", // autocasts as new Point()longitude: 17.81840,latitude: 59.42145};const swedishPlacesQueryParameters = new PlacesQueryParameters({apiKey: "YOUR_API_KEY",categoryIds: ["63be6904847c3692a84b9b4c"], // Bathroom Contractorradius: 10000, // set radius to 10,000 meterspoint});function findPlaces() {places.queryPlacesNearPoint(swedishPlacesQueryParameters).then(showPlaces);}function showPlaces(placesSolveResult) {// first PlaceResult object from PlacesQueryResult.resultsconsole.log("PlaceResult: ", placesSolveResult.results[0]);}findPlaces();
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
categories
- Type
- Category[]
An array 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
The distance, in meters, from the place to the search point. This property is only returned by the queryPlacesNearPoint() method.
name
- Type
- string
The name of the place, or point of interest. You can search for places by name using the PlacesQueryParameters.searchText property in the queryPlacesNearPoint() and queryPlacesWithinExtent() methods.
placeId
- Type
- string
The unique Id of this place. This place Id can be passed to the places/{placeId} endpoint to retrieve additional details.
- See also
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".
categoryId
- Type
- number
The Id of the category of the place. Categories are uniquely identified by a categoryId.