InitialViewProperties
require(["esri/webscene/InitialViewProperties"], function(InitialViewProperties) { /* code goes here */ });
esri/webscene/InitialViewProperties
Represents the initial viewing state of the WebScene when displayed in a SceneView. It contains the initial viewpoint as well as the initial environment settings.
Constructors
- new InitialViewProperties(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 | |
Environment | The initial environment settings of the WebScene. more details | more details | InitialViewProperties | |
SpatialReference | The spatial reference of the WebScene. more details | more details | InitialViewProperties | |
String | The viewing mode of the scene. more details | more details | InitialViewProperties | |
Viewpoint | The initial viewpoint of the WebScene. more details | more details | InitialViewProperties |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- environmentEnvironmentautocast
The initial environment settings of the WebScene.
- spatialReferenceSpatialReferenceautocast
The spatial reference of the WebScene. This indicates the Projected Coordinate System or the Geographic Coordinate System used to locate geographic features in the map. In a SceneView the following supported coordinate systems are available.
- viewingModeString
The viewing mode of the scene. Global scenes allow the user to navigate the globe. Local scenes allow for navigation and feature display in a particular "localized" area. Users may also navigate the view's camera below the surface of a basemap in local scenes.
Possible Values: global | local
- Default Value:global
- See also:
The initial viewpoint of the WebScene.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
InitialViewProperties | Creates a deep clone of this object. more details | more details | InitialViewProperties | |
Boolean |
| more details | InitialViewProperties | |
Boolean |
| more details | InitialViewProperties | |
Boolean |
| more details | InitialViewProperties | |
Promise |
| more details | InitialViewProperties |
Method Details
- clone(){InitialViewProperties}
Creates a deep clone of this object.
Returns:Type Description InitialViewProperties Creates a deep clone of the instance that called this method.
- isFulfilled(){Boolean}
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
- isRejected(){Boolean}
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been rejected.
- isResolved(){Boolean}
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been resolved.
- when(callback, errback){Promise}Since: ArcGIS API for JavaScript 4.6
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
Returns:Type Description Promise Returns a new promise for the result of callback
that may be used to chain additional functions.Example:// Although this example uses MapView, any class instance that is a promise may use then() in the same way var view = new MapView(); view.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });