Skip to content

Interface

Options for findPlacesNearPoint.

Inheritance: IFindPlaceWithinExtentOptionsOmit<IRequestOptions"httpMethod" | "f">queryParams

Properties

Hide inherited properties
PropertyTypeNotes
string | IAuthenticationManager

The instance of ArcGISIdentityManager, ApplicationCredentialsManager or 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.

categoryIds
inherited
string[]

Filters places to those that match the category Ids.

credentials
inherited
RequestCredentials

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

headers
inherited
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
inherited
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.

iconIconOptions
maxUrlLength
inherited
number

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

offset
inherited
number

Request results starting from the given offset.

pageSize
inherited
number

The number of places that should be sent in the response for a single request.

params
inherited
IParams

Additional parameters to pass in the request.

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

rawResponse
inherited
boolean

Return the raw response

searchText
inherited
string

Free search text for places against names, categories etc.

signal
inherited
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.

xmax
inherited
number

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

xmin
inherited
number

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

ymax
inherited
number

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

ymin
inherited
number

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

authentication

optionalinherited
Interface Property

categoryIds

optionalinherited
Interface Property

credentials

optionalinherited
Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

icon

optional
Interface Property

maxUrlLength

optionalinherited
Interface Property

offset

optionalinherited
Interface Property

pageSize

optionalinherited
Interface Property

params

optionalinherited
Interface Property

portal

optionalinherited
Interface Property

rawResponse

optionalinherited
Interface Property

searchText

optionalinherited
Interface Property

signal

optionalinherited
Interface Property

suppressWarnings

optionalinherited
Interface Property

xmax

inherited
Interface Property

xmin

inherited
Interface Property

ymax

inherited
Interface Property

ymin

inherited
Interface Property

Methods

Hide inherited methods
MethodReturnsNotes
request(url, requestOptions)
inherited
Promise<any>

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

request

optionalinherited
Interface Method
request(urlstring, requestOptionsInternalRequestOptions): Promise<any>

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

Parameters
ParameterTypeNotes
urlstring
requestOptionsInternalRequestOptions
Returns 
Promise<any>
Inherited from Omit.request

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