InitialViewProperties

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

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 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
String

The name of the class.

more details
more detailsAccessor
Environment

The initial environment settings of the WebScene.

more details
more detailsInitialViewProperties
SpatialReference

The spatial reference of the WebScene.

more details
more detailsInitialViewProperties
String

The viewing mode of the scene.

more details
more detailsInitialViewProperties
Viewpoint

The initial viewpoint of the WebScene.

more details
more detailsInitialViewProperties

Property Details

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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.

Known Values: global | local

Default Value:global
See also:

The initial viewpoint of the WebScene.

Method Overview

NameReturn TypeSummaryClass
Promise

Deprecated at 4.7.always() may be used to execute a function if creating an instance of the class is rejected or resolved.*

more details
more detailsInitialViewProperties
InitialViewProperties

Creates a deep clone of this object.

more details
more detailsInitialViewProperties
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).`

more details
more detailsInitialViewProperties
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.`

more details
more detailsInitialViewProperties
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.`

more details
more detailsInitialViewProperties
Promise

Deprecated at 4.7. Use otherwise() to call a function once creating an instance of the class is rejected.*

more details
more detailsInitialViewProperties
Promise

when() may be leveraged once an instance of the class is created.`

more details
more detailsInitialViewProperties

Method Details

always(callbackOrErrback){Promise}
Deprecated
  • Deprecated at 4.7. This method will be removed at 4.8.

Deprecated at 4.7. always() may be used to execute a function if creating an instance of the class is rejected or resolved. The input function will always execute no matter the response.

Parameter:
callbackOrErrback Function
optional

The function to execute when creating an instance of the class is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.

Creates a deep clone of this object.

Returns:
TypeDescription
InitialViewPropertiesCreates 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:
TypeDescription
BooleanIndicates 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:
TypeDescription
BooleanIndicates 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:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
otherwise(errback){Promise}
Deprecated
  • Deprecated at 4.7. This method will be removed at 4.8.

Deprecated at 4.7. Use otherwise() to call a function once creating an instance of the class is rejected.

Parameter:
errback Function
optional

The function to execute when creating an instance of the class fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
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: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns 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
});
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.