Environment

Property Overview

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.

lighting SunLighting|VirtualLightingautocast

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

weather SunnyWeather|CloudyWeather|RainyWeather|SnowyWeather|FoggyWeatherautocast

Indicates the type of weather visualization in the scene.

Default Value:SunnyWeather

Method Overview

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");