ElevationSampler

map.ground.load()
  .then(function() {
    // create an elevation sampler from a given extent
    return view.map.ground.createElevationSampler(extent);
  })
  .then(function(elevationSampler) {
    // use the elevation sampler to get z-values for a point, multipoint or polyline geometry
    let zEnrichedGeometry = elevationSampler.queryElevation(geometry);
  });

let elevationSampler = view.groundView.elevationSampler;
// listen for elevation changes in the view
elevationSampler.on('changed', function() {
  // enrich geometry with z-values from the elevation displayed in the view
  let zEnrichedGeometry = elevationSampler.queryElevation(point);
});

Property Overview

Property Details

demResolution Objectreadonly

The minimum and maximum resolution of the data in the sampler.

Properties

min Number The minimum resolution.

max Number The maximum resolution.

extent Extentreadonly

Since: ArcGIS Maps SDK for JavaScript 4.9

The extent within which the sampler can be queried.

noDataValue Numberreadonly

Since: ArcGIS Maps SDK for JavaScript 4.9

The value that is used to represent areas where there is no data available.

spatialReference SpatialReferencereadonly

Since: ArcGIS Maps SDK for JavaScript 4.24

The spatial reference of the sampler.

Method Overview

Method Details

elevationAt(x, y){Number}

Since: ArcGIS Maps SDK for JavaScript 4.24

Get elevation for a coordinate specified in the spatial reference of the sampler. This is typically faster than ElevationSampler when getting elevation for many coordinates that are guaranteed to be in the spatial reference of the sampler. If the coordinate is outside of the elevation sampler extent, then the samplers ElevationSampler will be returned.

Parameters

x Number The x coordinate.

y Number The y coordinate.

Returns

Type	Description
Number	The sampled elevation.

on(type, handler?){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters

type String|String[] The name of the event or the events to listen for.

handler? Function The function to call when the event is fired, if modifiers were specified.

Returns

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

Example

view.groundView.elevationSampler.on("changed", function(evt) {
 console.log("elevation has changed");
});

queryElevation(geometry){Point|Multipoint|Polyline}

Query elevation for a Point, Polyline or Multipoint geometry. A query will return a new geometry for which the z-values for each coordinate in the geometry are obtained from the elevation sampler. If the geometry used for the query is outside of the elevation sampler extent, then the returned geometry has the samplers ElevationSampler as z-values.

Parameter

geometry Point|Multipoint|Polyline The geometry to use for sampling elevation data.

Returns

Type	Description
Point | Multipoint | Polyline	The sampled geometry.

Event Overview

Event Details

changed

Fires when the data in the sampler has changed. This event is only relevant for dynamic elevation samplers such as the elevation sampler on the GroundView.

Example

view.groundView.elevationSampler.on("changed", function(evt) {
 console.log("elevation has changed");
});