Environment | References | ArcGIS Maps SDK for JavaScript

import Environment from "@arcgis/core/webscene/Environment.js";

Inheritance:: Environment→Accessor

Subclasses:: Environment

Since: ArcGIS Maps SDK 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 Presentation.slides in the presentation.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`EnvironmentProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`atmosphereEnabled`	`boolean`
`background`	`Background \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`lighting`	`SunLighting \| VirtualLighting`
`starsEnabled`	`boolean`
`weather`	`WeatherUnion`

atmosphereEnabled

Property

Type: boolean

Indicates whether atmosphere visualization is enabled.

Disabling the atmosphere will disable the following features:

Sky and haze
Any weather visualization
Natural light scattering in fog and haze around light emitters.

Default value: true

background

autocast Property

Type: Background | null | undefined

Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. By default this is simply a single, fully opaque, black color. Currently ColorBackground is the only type of background supported.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

lighting

autocast Property

Type: SunLighting | VirtualLighting

Settings for defining the lighting of the scene. The lighting can be either "sun" or "virtual".

starsEnabled

Property

Type: boolean

Indicates whether stars visualization is enabled.

Default value: true

weather

autocast Property

Type: WeatherUnion

Indicates the type of weather visualization in the scene. This setting does not have any effect in local scenes.

Known Value	Example
SunnyWeather
CloudyWeather
RainyWeather
SnowyWeather
FoggyWeather

Default value: SunnyWeather

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): Environment`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

Method

Signature: clone (): Environment

Creates a deep clone of this object.

Returns: Environment
Creates a deep clone of the instance calling this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.