SunLighting

AMD: require(["esri/webscene/SunLighting"], (SunLighting) => { /* code goes here */ });
ESM: import SunLighting from "@arcgis/core/webscene/SunLighting";
Class: esri/webscene/SunLighting
Inheritance: SunLighting Accessor
Subclasses: Lighting , SunLighting
Since: ArcGIS API for JavaScript 4.24

The sun lighting object is part of the webscene/Environment and contains information relating to how a SceneView is lit by the sun. This class contains all properties which can be persisted in a esri/Webscene.

See also:

Constructors

new SunLighting(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
Datemore details

The current date and time of the simulated sun.

more detailsSunLighting
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates whether to show shadows cast by the sun.

more detailsSunLighting
Numbermore details

The UTC time zone offset in hours that should be displayed in the UI to represent the date.

more detailsSunLighting
Stringmore details

Indicates that the light source is simulated position of the sun.

more detailsSunLighting

Property Details

date Date

The current date and time of the simulated sun. When setting the date, specifying the time zone is important, otherwise the time zone of the browser will be used. This might lead to different lighting for users in different time zones.

Default Value:null
declaredClass Stringreadonly inherited

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

directShadowsEnabled Boolean

Indicates whether to show shadows cast by the sun. Shadows are only displayed for real world 3D objects. Terrain doesn't cast shadows. In local scenes at small zoom levels, shadows are not displayed. For more control on which 3D objects cast shadows use the castShadows property available on ObjectSymbol3DLayer, FillSymbol3DLayer, ExtrudeSymbol3DLayer, and PathSymbol3DLayer.

Default Value:false
displayUTCOffset Number

The UTC time zone offset in hours that should be displayed in the UI to represent the date. This value does not have an impact on the actual lighting of the scene.

Default Value:null
type Stringreadonly

Indicates that the light source is simulated position of the sun.

For SunLighting the type is always "sun".

Method Overview

Name Return Type Summary Class
SunLightingmore details

Creates a deep clone of this object.

more detailsSunLighting

Method Details

clone(){SunLighting}

Creates a deep clone of this object.

Returns:
Type Description
SunLighting Creates a new clone of the instance calling this method.

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