InitialViewProperties

AMD: require(["esri/webscene/InitialViewProperties"], (InitialViewProperties) => { /* code goes here */ });
ESM: import InitialViewProperties from "@arcgis/core/webscene/InitialViewProperties";
Class: esri/webscene/InitialViewProperties
Inheritance: InitialViewProperties Accessor
Since: ArcGIS Maps SDK 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Environment

The initial environment settings of the WebScene.

more details
InitialViewProperties
SpatialReference

The spatial reference of the WebScene.

more details
InitialViewProperties
String

The viewing mode of the scene.

more details
InitialViewProperties
Viewpoint

The initial viewpoint of the WebScene.

more details
InitialViewProperties

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

environment Environmentautocast

The initial environment settings of the WebScene.

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.

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 Viewpointautocast

The initial viewpoint of the WebScene.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
InitialViewProperties

Creates a deep clone of this object.

more details
InitialViewProperties
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

Creates a deep clone of this object.

Returns
Type Description
InitialViewProperties Creates a deep clone of the instance that called this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.