InitialViewProperties | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

InitialViewProperties Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Environment	The initial environment settings of the WebScene.	InitialViewProperties
SpatialReference	The spatial reference of the WebScene.	InitialViewProperties
TimeExtent	The initial time extent of the WebScene.	InitialViewProperties
String	The viewing mode of the scene.	InitialViewProperties
Viewpoint	The initial viewpoint of the WebScene.	InitialViewProperties

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

environment Property environment Environmentautocast

The initial environment settings of the WebScene.

spatialReference Property spatialReference SpatialReferenceautocast

The spatial reference of the WebScene. This indicates the projected or geographic coordinate system used to locate geographic features in the map. In a SceneView the following supported coordinate systems are available.

timeExtent Property timeExtent TimeExtentautocast Since: ArcGIS Maps SDK for JavaScript 4.30 InitialViewProperties since 4.0, timeExtent added at 4.30.

The initial time extent of the WebScene.

viewingMode Property viewingMode String

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

viewpoint Property viewpoint Viewpointautocast

The initial viewpoint of the WebScene.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
InitialViewProperties	Creates a deep clone of this object.	InitialViewProperties
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){InitialViewProperties}

Creates a deep clone of this object.

Returns

Type	Description
InitialViewProperties	Creates a deep clone of the instance that called this method.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");