GroundView

AMD: require(["esri/views/GroundView"], (GroundView) => { /* code goes here */ });
ESM: import GroundView from "@arcgis/core/views/GroundView.js";
Class: esri/views/GroundView
Inheritance: GroundViewAccessor
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

The name of the class.

Accessor

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

GroundView

The extent represents the visible portion of ground within the view as an instance of Extent.

GroundView

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

GroundView

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

GroundView

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

elevationSampler

Property
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.createElevationSampler or Ground.createElevationSampler.

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);
});

extent

Property
extent Extentreadonly
Since: ArcGIS Maps SDK for JavaScript 4.28 GroundView since 4.7, extent added at 4.28.

The extent represents the visible portion of ground within the view as an instance of Extent. The ground view extent is computed based on the ground surface elevation at the center of the view, while the SceneView extent is computed at the elevation of all of the scene content at the center of the view. The ground view extent may be more appropriate when synchronizing the viewpoint of a MapView and a SceneView.

Default Value:null

layerViews

Property
layerViews Collection<LayerView>readonly

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

See also

updating

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

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
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

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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.