Skip to content
import PlacesParameters from "@arcgis/core/rest/support/PlacesParameters.js";
Inheritance:
PlacesParametersAccessor
Subclasses:
FetchPlaceParameters, PlacesQueryParameters
Since
ArcGIS Maps SDK for JavaScript 4.27

The following properties define common properties for use with places. Please see the sublasses that extend this class for more information about working with places.

See also

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
declaredClass
readonly inherited
"cim" | "png" | "svg" | null | undefined
url

apiKey

Property
Type
string | null | undefined

An authorization string used to access a resource or service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

See also

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

icon

Property
Type
"cim" | "png" | "svg" | null | undefined
Since
ArcGIS Maps SDK for JavaScript 4.30

Determines whether icons are returned and the type of icons returned. The PNG icons are provided as 48 x 48 pixels but for map display the recommended size is 16 x 16 pixels. Icons are not returned if the value is null.

url

Property
Type
string

URL to the places service. The places service is a ready-to-use service that can search for businesses and geographic locations around the world. It allows you to discover, locate, and return detailed information about a place.

Default value
"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1"