SunLighting

AMD: require(["esri/views/3d/environment/SunLighting"], (SunLighting) => { /* code goes here */ });
ESM: import SunLighting from "@arcgis/core/views/3d/environment/SunLighting";
Class: esri/views/3d/environment/SunLighting
Inheritance: SunLighting SunLighting Accessor
Since: ArcGIS API for JavaScript 4.23

The SunLighting class allows you to change the lighting in the scene to sunlight. The position of the light is set to the sun's location.

scene-lightings

Example:

let view = new SceneView({
  container: "viewDiv",

  map: new Map({
    basemap: "satellite",
    ground: "world-elevation"
  }),
  environment: {
    lighting: {
      type: "sun"    // autocasts as new SunLighting()
    }
  }
});

The lighting visualization updates as soon as the type property changes:

view.environment.lighting = {
   type: "sun",
   directShadowsEnabled: true    // autocasts as new SunLighting({ directShadowsEnabled: true })
}
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
Boolean

Indicates whether to show ambient occlusion shading.

more details
SunLighting
Boolean

Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes.

more details
SunLighting
Date

The current date and time of the simulated sun.

more details
SunLighting
String

The name of the class.

more details
Accessor
Boolean

Indicates whether to show shadows cast by the sun.

more details
SunLighting
Number

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

more details
SunLighting
String

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

more details
SunLighting
Boolean

Indicates whether WaterSymbol3DLayer display reflections of surrounding terrain, buildings and other 3D objects.

more details
SunLighting

Property Details

ambientOcclusionEnabled Boolean

Indicates whether to show ambient occlusion shading.

Default Value:false
cameraTrackingEnabled Boolean

Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes.

Default Value:true
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:new Date("March 15, 2022 12:00:00 UTC")
declaredClass Stringreadonly inherited

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

directShadowsEnabled Boolean inherited

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 inherited

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 inherited

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

For SunLighting the type is always "sun".

waterReflectionEnabled Boolean

Indicates whether WaterSymbol3DLayer display reflections of surrounding terrain, buildings and other 3D objects.

Default Value:false

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

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

more details
Accessor
SunLighting

Creates a deep clone of this object.

more details
SunLighting

Create a clone of this while partially applying the provided webscene lighting settings.

more details
SunLighting
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

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.

Creates a deep clone of this object.

Returns
Type Description
SunLighting Creates a new clone of the instance calling this method.
cloneWithWebsceneLighting()

Create a clone of this while partially applying the provided webscene lighting settings.

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

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