Daylight

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-daylight";

Daylight component can be used to manipulate the lighting conditions of a SceneView.

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`currentSeason`	`current-season`	`"fall" \| "spring" \| "summer" \| "winter"`
`dateOrSeason`	`date-or-season`	`"date" \| "season"`
`dayPlaying`	`day-playing`	`boolean`
`headingLevel`	`heading-level`	`number`
`hideDatePicker`	`hide-date-picker`	`boolean`
`hideHeader`	`hide-header`	`boolean`
`hidePlayButtons`	`hide-play-buttons`	`boolean`
`hideShadowsToggle`	`hide-shadows-toggle`	`boolean`
`hideSunLightingToggle`	`hide-sun-lighting-toggle`	`boolean`
`hideTimezone`	`hide-timezone`	`boolean`
`icon`	`icon`	`string`
`label`	`label`	`string`
`playSpeedMultiplier`	`play-speed-multiplier`	`number`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`timeSliderSteps`	`time-slider-steps`	`Array<number> \| number`
`yearPlaying`	`year-playing`	`boolean`

autoDestroyDisabled

Property

autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute: auto-destroy-disabled
Default value: false

currentSeason

Property

currentSeason: "fall" | "spring" | "summer" | "winter"

A season can be set instead of a date.

Attribute: current-season

dateOrSeason

Property

dateOrSeason: "date" | "season"

Controls whether the widget displays a date or a season picker.

Attribute: date-or-season
Default value: "date"

dayPlaying

Property

dayPlaying: boolean

Starts or pauses the daytime animation cycling through the minutes of the day.

Attribute: day-playing
Default value: false

headingLevel

Property

headingLevel: number

Indicates the heading level to use for the widget title.

Attribute: heading-level
Default value: 3

hideDatePicker

Property

hideDatePicker: boolean

Attribute: hide-date-picker
Default value: false

hideHeader

Property

hideHeader: boolean

Attribute: hide-header
Default value: false

hidePlayButtons

Property

hidePlayButtons: boolean

Attribute: hide-play-buttons
Default value: false

hideShadowsToggle

Property

hideShadowsToggle: boolean

Attribute: hide-shadows-toggle
Default value: false

hideSunLightingToggle

Property

hideSunLightingToggle: boolean

Attribute: hide-sun-lighting-toggle
Default value: false

hideTimezone

Property

hideTimezone: boolean

Attribute: hide-timezone
Default value: false

icon

Property

icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute: icon
Default value: "brightness"

label

Property

label: string

The component's default label.

Attribute: label

playSpeedMultiplier

Property

playSpeedMultiplier: number

Controls the speed of the daytime and date animation.

Attribute: play-speed-multiplier
Default value: 1.0

position

Property

position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"

Attribute: position
Default value: "bottom-left"

referenceElement

Property

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

timeSliderSteps

Property

timeSliderSteps: Array<number> | number

Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.

Attribute: time-slider-steps
Default value: 5

yearPlaying

Property

yearPlaying: boolean

Starts or pauses the date animation cycling through the months of the year.

Attribute: year-playing
Default value: false

Methods

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Event	Type
`arcgisReady`	`undefined`

arcgisReady

Event

arcgisReady: undefined

Emitted when the component associated with a map view is is ready to be interacted with.