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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | 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 | |
| SunLighting|VirtualLighting | 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 | |
| SunnyWeather|CloudyWeather|RainyWeather|SnowyWeather|FoggyWeather | more details Indicates the type of weather visualization in the scene. | 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
nulldisplays a single, fully opaque, black color.- Default Value:null
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
-
Settings for defining the lighting of the scene. The lighting can be either "sun" or "virtual".
- Default Value:SunLighting
-
starsEnabled Boolean
-
Specifies whether stars should be displayed in the sky.
- Default Value:true
-
Indicates the type of weather visualization in the scene.
- Default Value:SunnyWeather
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Environment | more details Creates a deep clone of this object. | more details | Environment | |
| more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor |
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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.