InitialViewProperties

ESM: import InitialViewProperties from "@arcgis/core/webscene/InitialViewProperties.js";
CDN: const InitialViewProperties = await $arcgis.import("@arcgis/core/webscene/InitialViewProperties.js");
Class: @arcgis/core/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

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
Name Type Summary Class

List of initial analyses.

InitialViewProperties

The name of the class.

Accessor

The initial environment settings of the WebScene.

InitialViewProperties

The spatial reference of the WebScene.

InitialViewProperties

The initial time extent of the WebScene.

InitialViewProperties

The viewing mode of the scene.

InitialViewProperties

The initial viewpoint of the WebScene.

InitialViewProperties

Property Details

analyses

Property
analyses Collection<SliceAnalysis>autocast
Since: ArcGIS Maps SDK for JavaScript 4.33 InitialViewProperties since 4.0, analyses added at 4.33.

List of initial analyses. Only SliceAnalysis are currently supported in the initial view properties.

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 SpatialReference |null |undefinedautocast

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 TimeExtent |null |undefinedautocast
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 Viewpoint |null |undefinedautocast

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.

Accessor
this

Creates a deep clone of this object.

InitialViewProperties

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(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns
Type Description
this A deep clone of the class instance that invoked 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");

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