IFindPlacesNearPointOptions
Interface
Options for findPlacesNearPoint
.
Properties
Property | Type | Notes |
---|---|---|
string | IAuthenticationManager | The instance of | |
string[] | Filters places to those that match the category Ids. | |
RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. | |
{ [key: string]: any } | Additional Headers to pass into the request. | |
boolean | Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS. | |
number | If the length of a GET request's URL exceeds | |
number | Request results starting from the given offset. | |
number | The number of places that should be sent in the response for a single request. | |
Additional parameters to pass in the request. | ||
string | Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'. | |
number | The radius in meters to search for places - measured from the supplied | |
boolean | Return the raw response | |
string | Free search text for places against names, categories etc. | |
AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. | |
boolean | Suppress any ArcGIS REST JS related warnings for this request. | |
number | The x coordinate, or longitude, to search from, in WGS84 decimal degrees. | |
number | The y coordinate, or latitude, to search from, in WGS84 decimal degrees. |
categoryIds
categoryIds: string[]
Filters places to those that match the category Ids.
Places will be returned if they match any of the category Ids. If this property is not set, places will be returned regardless of their category.
You can obtain information on category Ids from theplaces/categories
endpoint. For example, to filter for places
where the category is "Bicycle Store", include the categoryId17117
in this property.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
hideToken: boolean
Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
offset
offset: number
Request results starting from the given offset.
This parameter works with the pageSize
parameter to fetch results from
subsequent pages. For example, with a page size of 2, setting theoffset
to 2
would return the 3rd and 4th results.
Regardless of paging, the maximum number of places that can be returned
by a single query is 200
. When a query results in more than 200
places, the response will contain the property"maxResultsExceeded":true
in addition to place results.
pageSize
pageSize: number
The number of places that should be sent in the response for a single request.
You can set this to any value up to 20
when you need to control the
size of responses that your app downloads.
If the query results in more than this page size, then the response object
will contain a next
url fragment. This fragment can be used to form a
request url to fetch the next page of results.
The maximum number of places that can be returned in total is 200
. If
a request reaches this limit without returning all of the available
places, the response will contain the property"maxResultsExceeded":true
in addition to place results.
portal
portal: string
Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
radius
radius: number
The radius in meters to search for places - measured from the supplied x
and y
coordinate.
A radius of 100 meters will result in a circular search area that is 200 meters in diameter. If omitted, the default search radius will be 1,000 meters.
searchText
searchText: string
Free search text for places against names, categories etc.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
authentication: string | IAuthenticationManager
The instance of
ApiKey
,ArcGISIdentityManager
orApplicationSession
to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.