require(["esri/Viewpoint"], function(Viewpoint) { /* code goes here */ });
Class: esri/Viewpoint
Inheritance: Viewpoint Accessor
Since: ArcGIS API for JavaScript 4.0

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

See also:

Constructors

new Viewpoint(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.
NameTypeSummaryClass
Camera

The viewpoint camera (3D only).

more details
more detailsViewpoint
String

The name of the class.

more details
more detailsAccessor
Number

The rotation of due north in relation to the top of the view in degrees.

more details
more detailsViewpoint
Number

The scale of the viewpoint.

more details
more detailsViewpoint
Geometry

The target geometry framed by the viewpoint.

more details
more detailsViewpoint

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.

declaredClassStringreadonly inherited

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.

targetGeometryGeometry autocast

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

NameReturn TypeSummaryClass
Viewpoint

Create a deep clone of the viewpoint.

more details
more detailsViewpoint
*

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 detailsViewpoint
Object

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

more details
more detailsViewpoint

Method Details

clone(){Viewpoint}

Create a deep clone of the viewpoint.

Returns:
TypeDescription
ViewpointA 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 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.