HeightModelInfo
require(["esri/geometry/HeightModelInfo"], function(HeightModelInfo) { /* code goes here */ });esri/geometry/HeightModelInfoThe 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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The surface type or height model of the vertical coordinate system (VCS). more details | more details | HeightModelInfo | |
| String | The unit of the vertical coordinate system. more details | more details | HeightModelInfo | |
| String | The datum realization of the vertical coordinate system. more details | more details | HeightModelInfo |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- heightModelString
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"
- heightUnitString
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"
- vertCRSString
The datum realization of the vertical coordinate system. A SceneView will only render layers that define a HeightModelInfo with an identical
vertCRSto that of the scene, when using anellipsoidalheight model.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | HeightModelInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | HeightModelInfo |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter 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 ObjectA 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.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.