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
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
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.

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

Show inherited methods Hide inherited methods
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)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

Returns
Type Description
Environment Creates a deep clone of the instance calling this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.