HeightModelInfo

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

The height model info defines the characteristics of a vertical coordinate system. In a SceneView, the height model info of a WebScene is used to avoid rendering layers that have incompatible vertical coordinate systems. A height model info object is defined by a surface type, a vertical unit, and an optional datum realization.

See also

Constructors

new HeightModelInfo(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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
String

The surface type or height model of the vertical coordinate system (VCS).

more details
HeightModelInfo
String

The unit of the vertical coordinate system.

more details
HeightModelInfo
String

The datum realization of the vertical coordinate system.

more details
HeightModelInfo

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

heightModel String

The surface type or height model of the vertical coordinate system (VCS). A SceneView will only render layers containing data that is compatible with the HeightModelInfo of the scene.

Value Description
gravity-related-height A gravity-related VCS may set its zero point through a local mean sea level or a benchmark, and is compatible with other gravity-related VCS for the purposes of rendering.
ellipsoidal An ellipsoidal VCS defines heights that are referenced to an ellipsoid of a geographic coordinate system.

Possible Values:"gravity-related-height"|"ellipsoidal"

Default Value:"gravity-related-height"
heightUnit String

The unit of the vertical coordinate system. A SceneView will use this property to check that the vertical data of layers that define a HeightModelInfo is compatible with the view.

Possible Values:"meters"|"feet"|"us-feet"|"clarke-feet"|"clarke-yards"|"clarke-links"|"sears-yards"|"sears-feet"|"sears-chains"|"benoit-1895-b-chains"|"indian-yards"|"indian-1937-yards"|"gold-coast-feet"|"sears-1922-truncated-chains"|"50-kilometers"|"150-kilometers"

Default Value:"meters"
vertCRS String

The datum realization of the vertical coordinate system. A SceneView will only render layers that define a HeightModelInfo with an identical vertCRS to that of the scene, when using an ellipsoidal height model.

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
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
HeightModelInfo
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
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
HeightModelInfo

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.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.
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");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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