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)
-
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 |
---|---|---|---|
Boolean | Specifies whether the atmosphere should be displayed. more details | Environment | |
Background | Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. more details | Environment | |
String | The name of the class. more details | Accessor | |
SunLighting|VirtualLighting | Settings for defining the lighting of the scene. more details | Environment | |
Boolean | Specifies whether stars should be displayed in the sky. more details | Environment | |
SunnyWeather|CloudyWeather|RainyWeather|SnowyWeather|FoggyWeather | 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
null
displays a single, fully opaque, black color.- Default Value:null
-
Since: ArcGIS Maps SDK 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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Environment | Creates a deep clone of this object. more details | Environment | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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(){Environment}
-
Creates a deep clone of this object.
ReturnsType Description Environment Creates a deep clone of the instance calling this method.
-
Since: ArcGIS Maps SDK for JavaScript 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");