Lighting

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

The lighting object is part of the Environment and contains information relating to how a SceneView is lit.

See also:

Constructors

new Lighting(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 time and date for which the sun position and light direction is computed.

more detailsLighting
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates whether to show shadows cast by the sun.

more detailsLighting
Numbermore details

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

more detailsLighting

Property Details

date Date

The time and date for which the sun position and light direction is computed.

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.

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.

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

Method Overview

Name Return Type Summary Class
Lightingmore details

Creates a deep clone of this object.

more detailsLighting
Booleanmore details

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more detailsLighting
Booleanmore details

isRejected() may be used to verify if creating an instance of the class is rejected.

more detailsLighting
Booleanmore details

isResolved() may be used to verify if creating an instance of the class is resolved.

more detailsLighting
Promisemore details

when() may be leveraged once an instance of the class is created.

more detailsLighting

Method Details

clone(){Lighting}

Creates a deep clone of this object.

Returns:
Type Description
Lighting Creates a new clone of the instance calling this method.
isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
when(callback, errback){Promise}
Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

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