IFindElevationAtPointOptions

Interface

Options for findElevationAtPoint.

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

Properties

Hide inherited properties
PropertyTypeNotes

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

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
authentication: 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.

Inherited from Omit.authentication

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

lat

inherited
Interface Property
lat: number

The latitude of the specified point.

Inherited from queryParams.lat

lon

inherited
Interface Property
lon: number

The longitude of the specified point.

Inherited from queryParams.lon

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

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

relativeTo

optionalinherited
Interface Property
relativeTo: "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.
Inherited from queryParams.relativeTo

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

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