require(["esri/webscene/Lighting"], function(Lighting) { /* code goes here */ });
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.
NameTypeSummaryClass
Date

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

more details
more detailsLighting
String

The name of the class.

more details
more detailsAccessor
Boolean

The type of direct shadows.

more details
more detailsLighting
Number

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

more details
more detailsLighting

Property Details

dateDate

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

Default Value: null

declaredClassStringreadonly inherited

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

directShadowsEnabledBoolean

The type of direct shadows.

Default Value: false

displayUTCOffsetNumber

The UTC timezone 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

NameReturn TypeSummaryClass
Promise

An instance of this class is a Promise.

more details
more detailsLighting
Lighting

Creates a deep clone of this object.

more details
more detailsLighting
Boolean

An instance of this class is a Promise.

more details
more detailsLighting
Boolean

An instance of this class is a Promise.

more details
more detailsLighting
Boolean

An instance of this class is a Promise.

more details
more detailsLighting
Promise

An instance of this class is a Promise.

more details
more detailsLighting
Promise

An instance of this class is a Promise.

more details
more detailsLighting

Method Details

always(callbackOrErrback){Promise}

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

clone(){Lighting}

Creates a deep clone of this object.

Returns:
TypeDescription
LightingCreates a new clone of the instance calling this method.

isFulfilled(){Boolean}

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

otherwise(errback){Promise}

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

then(callback, errback, progback){Promise}

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns 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 then() in the same way
var view = new MapView();
view.then(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
});

API Reference search results

NameTypeModule

There were no match results from your search criteria.