HeightModelInfo | References | ArcGIS Maps SDK for JavaScript

import HeightModelInfo from "@arcgis/core/geometry/HeightModelInfo.js";

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

Vertical coordinate systems

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`HeightModelInfoProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`heightModel` readonly	`HeightModel`
`heightUnit` readonly	`ProjectionLengthUnit`
`vertCRS` readonly	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

heightModel

readonly Property

Type: HeightModel

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.

Default value: "gravity-related-height"

heightUnit

readonly Property

Type: ProjectionLengthUnit

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.

Default value: "meters"

vertCRS

readonly Property

Type: string | null | undefined

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.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

Type definitions

HeightModel

Type definition

Type: "gravity-related-height" | "ellipsoidal"