Skip to content

Interface

Options for findElevationAtPoint.

Inheritance: IFindElevationAtPointOptionsOmit<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.

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.

lat
inherited
number

The latitude of the specified point.

lon
inherited
number

The longitude of the specified point.

maxUrlLength
inherited
number

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

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

relativeTo
inherited
"meanSeaLevel" | "ellipsoid"

The reference position (datum) from which to measure elevation. The valid values are:

  • meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
  • ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
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.

authentication

optionalinherited
Interface Property

credentials

optionalinherited
Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

lat

inherited
Interface Property

lon

inherited
Interface Property

maxUrlLength

optionalinherited
Interface Property

params

optionalinherited
Interface Property

portal

optionalinherited
Interface Property

rawResponse

optionalinherited
Interface Property

relativeTo

optionalinherited
Interface Property

signal

optionalinherited
Interface Property

suppressWarnings

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