IFindPlaceWithinExtentOptions

The instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!ApiKeyManager 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.

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 the places/categories endpoint. For example, to filter for places where the category is "Bicycle Store", include the categoryId 17117 in this property.

You can search up to a maximum of 10 category Ids.

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

Additional Headers to pass into the request.

Type declaration

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.

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

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 the offset to 2 would return the 3rd and 4th results.

Regardless of paging, the maximum number of places that can be returned in total is 200 .

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 pagination.nextUrl . This can be used to request the next page of results.

Regardless of paging, the maximum number of places that can be returned in total is 200 .

The default pageSize is 10.

Additional parameters to pass in the request.

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'.

Return the raw response

Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).

Type declaration

function(url: string, requestOptions: InternalRequestOptions): Promise<any>

Parameters

Parameter	Type
url	string
requestOptions	InternalRequestOptions

Returns 

Promise<any>

Free search text for places against names, categories etc.

An AbortSignal object instance; allows you to abort a request and via an AbortController.

Suppress any ArcGIS REST JS related warnings for this request.

The maximum x coordinate, or longitude, of the search extent, in WGS84 decimal degrees.

This is the furthest east that will be searched.

The minimum x coordinate, or longitude, of the search extent, in WGS84 decimal degrees.

This is the furthest west that will be searched.

The maximum y coordinate, or latitude, of the search extent, in WGS84 decimal degrees.

This is the furthest north that will be searched.

The minimum y coordinate, or latitude, of the search extent, in WGS84 decimal degrees.

This is the furthest south that will be searched.