require(["esri/webscene/InitialViewProperties"], (InitialViewProperties) => { /* code goes here */ });
import InitialViewProperties from "@arcgis/core/webscene/InitialViewProperties.js";
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
-
Parameterproperties 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. | Accessor | |
| Environment | The initial environment settings of the WebScene. | InitialViewProperties | |
| SpatialReference | The spatial reference of the WebScene. | InitialViewProperties | |
| String | The viewing mode of the scene. | InitialViewProperties | |
| Viewpoint | The initial viewpoint of the WebScene. | InitialViewProperties |
Property Details
-
environment
Propertyenvironment Environmentautocast -
The initial environment settings of the WebScene.
-
spatialReference
PropertyspatialReference 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
PropertyviewingMode 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
Method Overview
| Name | 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
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
Methodclone(){InitialViewProperties} -
Creates a deep clone of this object.
ReturnsType Description InitialViewProperties Creates a deep clone of the instance that called this method.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");