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
Booleanmore details

Specifies whether the atmosphere should be displayed.

more detailsEnvironment
Backgroundmore details

Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed.

more detailsEnvironment
Stringmore details

The name of the class.

more detailsAccessor
SunLighting|VirtualLightingmore details

Settings for defining the lighting of the scene.

more detailsEnvironment
Booleanmore details

Specifies whether stars should be displayed in the sky.

more detailsEnvironment
SunnyWeather|CloudyWeather|RainyWeather|SnowyWeather|FoggyWeathermore details

Indicates the type of weather visualization in the scene.

more detailsEnvironment

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
Environmentmore details

Creates a deep clone of this object.

more detailsEnvironment
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor

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)inherited
Since: 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.

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