InitialViewProperties | References | ArcGIS Maps SDK for JavaScript

import InitialViewProperties from "@arcgis/core/webscene/InitialViewProperties.js";

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`InitialViewPropertiesProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`analyses`	`Collection<WebSceneSliceAnalysis>`
`declaredClass` readonly inherited	`string`	Accessor
`environment`	`WebSceneEnvironment`
`spatialReference`	`SpatialReference \| null \| undefined`
`timeExtent`	`TimeExtent \| null \| undefined`
`viewingMode`	`"local" \| "global"`
`viewpoint`	`Viewpoint \| null \| undefined`

analyses

autocast Property

Type: Collection<WebSceneSliceAnalysis>

Since: ArcGIS Maps SDK for JavaScript 4.33

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

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

environment

autocast Property

Type: WebSceneEnvironment

The initial environment settings of the WebScene.

spatialReference

autocast Property

Type: SpatialReference | null | undefined

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

autocast Property

Type: TimeExtent | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.30

The initial time extent of the WebScene.

viewingMode

Property

Type: "local" | "global"

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.

See also

Sample - Create a local scene

Default value: "global"

viewpoint

autocast Property

Type: Viewpoint | null | undefined

The initial viewpoint of the WebScene.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.