Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/webscene/Environment"], function(Environment) { /* code goes here */ });
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:
  • esri/webscene/InitialView
  • Slide

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

Specifies whether the atmosphere should be displayed.

more details
more detailsEnvironment
Background

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

more details
more detailsEnvironment
String

The name of the class.

more details
more detailsAccessor
Lighting

Settings for defining the lighting of the scene.

more details
more detailsEnvironment
Boolean

Specifies whether stars should be displayed in the sky.

more details
more detailsEnvironment

Property Details

atmosphereEnabled Boolean

Specifies whether the atmosphere should be displayed. Typically this consists of haze and sky.

Default Value:true

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.

starsEnabled Boolean

Specifies whether stars should be displayed in the sky.

Default Value:true

Method Overview

NameReturn TypeSummaryClass
Environment

Creates a deep clone of this object.

more details
more detailsEnvironment

Method Details

clone(){Environment}

Creates a deep clone of this object.

Returns:
TypeDescription
EnvironmentCreates a deep clone of the instance calling this method.

API Reference search results

NameTypeModule
Loading...