• esri/views

GroundView

AMD: require(["esri/views/GroundView"], (GroundView) => { /* code goes here */ });
ESM: import GroundView from "@arcgis/core/views/GroundView";
Class: esri/views/GroundView
Inheritance: GroundView Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7

This class represents the view for the Ground of a map. It can be used to sample elevation from the terrain surface that is currently visible in the view or to access the LayerViews of the layers in the ground. An instance of this class can be accessed through SceneView.groundView.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
ElevationSampler

An elevation sampler that may be used to sample and query elevation values from the ground surface that is currently being displayed.

more details
GroundView
Collection<LayerView>

A collection containing a hierarchical list of all the created LayerViews of the layers in the ground.

more details
GroundView
Boolean

Value is true when any of the ground layer views are updating.

more details
GroundView

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

elevationSampler ElevationSamplerreadonly

An elevation sampler that may be used to sample and query elevation values from the ground surface that is currently being displayed.

The elevation sampler is not supported for MapView and may be null while the ground surface display is being initialized.

The resolution of the sampled values depends on the ground elevation display resolution (high resolution close to the camera, low resolution far away from the camera). Because of the dynamic nature of the display resolution, the demResolution property of the returned sampler will always return `{ min: -1, max: -1 }.

If higher or more consistent sample resolution is required, then consider creating a sampler at the desired resolution using ElevationLayer.createSampler or Ground.createSampler.

Example
let elevationSampler = view.groundView.elevationSampler;
// watch for changes in the elevationSampler
elevationSampler.on('changed', function() {
  // get z-values from the elevation displayed in the view
  let zEnrichedGeometry = elevationSampler.queryElevation(geometry);
});
layerViews Collection<LayerView>readonly

A collection containing a hierarchical list of all the created LayerViews of the layers in the ground.

See also
updating Booleanreadonly

Value is true when any of the ground layer views are updating.

Default Value:false

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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