IFindPlaceWithinExtentOptions

Interface

Options for findPlacesNearPoint.

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

Properties

Hide inherited properties
PropertyTypeNotes
authentication
 inherited 

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

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 

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.

suppressWarnings
 inherited 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

xmax
 inherited 
number

The maximum x coordinate, or longitude, of the search extent.

xmin
 inherited 
number

The minimum x coordinate, or longitude, of the search extent.

ymax
 inherited 
number

The maximum y coordinate, or latitude, of the search extent.

ymin
 inherited 
number

The minimum y coordinate, or latitude, of the search extent.

authentication

optionalinherited
Interface Property
authentication: string | IAuthenticationManager

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

Inherited from Omit.authentication

categoryIds

optionalinherited
Interface Property
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.

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

Inherited from queryParams.categoryIds

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

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

Inherited from Omit.credentials

headers

optionalinherited
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any
Inherited from Omit.headers

hideToken

optionalinherited
Interface Property
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.

Inherited from Omit.hideToken

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

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

Inherited from Omit.maxUrlLength

offset

optionalinherited
Interface Property
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 in total is 200.

Inherited from queryParams.offset

pageSize

optionalinherited
Interface Property
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 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.

Inherited from queryParams.pageSize

params

optionalinherited
Interface Property
params: IParams

Additional parameters to pass in the request.

Inherited from Omit.params

portal

optionalinherited
Interface Property
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'.

Inherited from Omit.portal

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

Inherited from Omit.rawResponse

searchText

optionalinherited
Interface Property
searchText: string

Free search text for places against names, categories etc.

Inherited from queryParams.searchText

signal

optionalinherited
Interface Property
signal: AbortSignal

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

Inherited from Omit.signal

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

Inherited from Omit.suppressWarnings

xmax

inherited
Interface Property
xmax: number

The maximum x coordinate, or longitude, of the search extent.

This is the furthest east that will be searched.

Inherited from queryParams.xmax

xmin

inherited
Interface Property
xmin: number

The minimum x coordinate, or longitude, of the search extent.

This is the furthest west that will be searched.

Inherited from queryParams.xmin

ymax

inherited
Interface Property
ymax: number

The maximum y coordinate, or latitude, of the search extent.

This is the furthest north that will be searched.

Inherited from queryParams.ymax

ymin

inherited
Interface Property
ymin: number

The minimum y coordinate, or latitude, of the search extent.

This is the furthest south that will be searched.

Inherited from queryParams.ymin

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