Viewpoint
require(["esri/Viewpoint"], function(Viewpoint) { /* code goes here */ });esri/ViewpointDescribes a point of view for a 2D or 3D view. In a 2D view, the viewpoint is determined using a center point and scale value. In a 3D view, it is determined using a camera position. The Viewpoint can be bookmarked for later use, or used for navigation purposes.
Constructors
- new Viewpoint(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 | |
|---|---|---|---|---|
| Camera | The viewpoint camera (3D only). more details | more details | Viewpoint | |
| String | The name of the class. more details | more details | Accessor | |
| Number | The rotation of due north in relation to the top of the view in degrees. more details | more details | Viewpoint | |
| Number | The scale of the viewpoint. more details | more details | Viewpoint | |
| Geometry | The target geometry framed by the viewpoint. more details | more details | Viewpoint |
Property Details
The viewpoint camera (3D only).
Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- rotationNumber
The rotation of due north in relation to the top of the view in degrees.
- Default Value:0
- See also:
- MapView.rotation
Examples:// due north is rotated 90 degrees, pointing to the right side of the view viewpoint.rotation = 90;// due north is rotated 180 degrees, pointing to the bottom of the view viewpoint.rotation = 180;// due north is rotated 270 degrees, pointing to the left side of the view viewpoint.rotation = 270;// due north is rotated 0 degrees, pointing to the top of the view (the default) viewpoint.rotation = 0; // 360 or multiple of 360 (e.g. 720) works here as well.
- scaleNumber
The scale of the viewpoint.
The target geometry framed by the viewpoint.
Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Viewpoint | Create a deep clone of the viewpoint. more details | more details | Viewpoint | |
| * | 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 | Viewpoint | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Viewpoint |
Method Details
- clone(){Viewpoint}
Create a deep clone of the viewpoint.
Returns:Type Description Viewpoint A deep clone of the Viewpoint object that called this method.
- 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.