SunLighting | References | ArcGIS Maps SDK for JavaScript

import SunLighting from "@arcgis/core/webscene/SunLighting.js";

Inheritance:: SunLighting→Accessor

Subclasses:: SunLighting

Since: ArcGIS Maps SDK 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 WebScene.

See also

Environment

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SunLightingProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`date`	`Date`
`declaredClass` readonly inherited	`string`	Accessor
`directShadowsEnabled`	`boolean`
`displayUTCOffset`	`number \| null \| undefined`
`glow`	`Glow \| null \| undefined`
`type` readonly	`"sun"`

date

autocast Property

Type: 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.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

directShadowsEnabled

Property

Type: 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.castShadows, FillSymbol3DLayer.castShadows, ExtrudeSymbol3DLayer.castShadows, and PathSymbol3DLayer.castShadows.

Default value: false

displayUTCOffset

Property

Type: number | null | undefined

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.

glow

autocast Property

Type: Glow | null | undefined

Adds a glow effect to the scene intended for stylistic visualizations. When set, this property creates a halo around light emitters, making them appear brighter and more prominent. Accepts a Glow instance or null to disable the effect.

Example:

scene.environment.lighting.glow = new Glow({ intensity: 1 });

type

readonly Property

Type: "sun"

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

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): SunLighting`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

Method

Signature: clone (): SunLighting

Creates a deep clone of this object.

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

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.