Environment

Environment

AMD: require(["esri/webscene/Environment"], (Environment) => { /* code goes here */ });

ESM: import Environment from "@arcgis/core/webscene/Environment";

Class: esri/webscene/Environment

Inheritance: Environment Accessor

Since: ArcGIS API for JavaScript 4.0

Represents settings that affect the environment in which the WebScene is displayed (such as lighting). It is part of the initial state of the WebScene as well as slides in the presentation.

See also:

Constructors

new Environment(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

Type	Summary	Class
Boolean	more details Specifies whether the atmosphere should be displayed.	more details	Environment
Background	more details Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed.	more details	Environment
String	more details The name of the class.	more details	Accessor
Lighting	more details Settings for defining the lighting of the scene.	more details	Environment
Boolean	more details Specifies whether stars should be displayed in the sky.	more details	Environment

Property Details

atmosphereEnabled Boolean

Specifies whether the atmosphere should be displayed. Typically this consists of haze and sky.

Default Value:true

background Backgroundautocast

Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. The default value of null displays a single, fully opaque, black color.

Default Value:null

declaredClass Stringreadonly inherited Since: ArcGIS API for JavaScript 4.7

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

lighting Lightingautocast

Settings for defining the lighting of the scene.

starsEnabled Boolean

Specifies whether stars should be displayed in the sky.

Default Value:true

Method Overview

Name	Return Type	Summary	Class
	Environment	more details Creates a deep clone of this object.	more details	Environment

Method Details

clone(){Environment}

Creates a deep clone of this object.

Returns:

Type	Description
Environment	Creates a deep clone of the instance calling this method.

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?