require(["esri/webscene/Environment"], (Environment) => { /* code goes here */ });
import Environment from "@arcgis/core/webscene/Environment.js";
esri/webscene/Environment
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
-
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 |
---|---|---|---|
Specifies whether the atmosphere should be displayed. | Environment | ||
Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. | Environment | ||
The name of the class. | Accessor | ||
Settings for defining the lighting of the scene. | Environment | ||
Specifies whether stars should be displayed in the sky. | Environment | ||
Indicates the type of weather visualization in the scene. | Environment |
Property Details
-
atmosphereEnabled
atmosphereEnabled Boolean
-
Specifies whether the atmosphere should be displayed. Typically this consists of haze and sky.
- Default Value:true
-
background
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
-
lighting
lighting SunLighting |VirtualLightingautocast
-
Settings for defining the lighting of the scene. The lighting can be either "sun" or "virtual".
- Default Value:SunLighting
-
starsEnabled
starsEnabled Boolean
-
Specifies whether stars should be displayed in the sky.
- Default Value:true
-
weather
weather SunnyWeather |CloudyWeather |RainyWeather |SnowyWeather |FoggyWeatherautocast
-
Indicates the type of weather visualization in the scene.
- Default Value:SunnyWeather
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of this object. | Environment | ||
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
clone(){Environment}
-
Creates a deep clone of this object.
ReturnsType Description Environment Creates a deep clone of the instance calling 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 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"); }
-
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");