import "@arcgis/map-components/components/arcgis-daylight";The Daylight component can be used to manipulate the lighting conditions of a Scene.
Known limitations
Daylight is only supported in a 3D Scene component.
See also
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
current-season | "fall" | "spring" | "summer" | "winter" | |
date-or-season | "date" | "season" | |
day-playing | boolean | |
heading-level | number | |
hide-date-picker | boolean | |
hide-header | boolean | |
hide-play-buttons | boolean | |
hide-shadows-toggle | boolean | |
hide-sun-lighting-toggle | boolean | |
hide-timezone | boolean | |
icon | string | |
label | string | |
play-speed-multiplier | number | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
time-slider-steps | Array<number> | number | |
year-playing | boolean |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
currentSeason: "fall" | "spring" | "summer" | "winter"A season can be set instead of a date.
- Attribute
- current-season
dateOrSeason
dateOrSeason: "date" | "season"Controls whether the component displays a date or a season picker.
- Attribute
- date-or-season
- Default value
- "date"
dayPlaying
dayPlaying: booleanStarts or pauses the daytime animation cycling through the minutes of the day.
- Attribute
- day-playing
- Default value
- false
headingLevel
headingLevel: numberIndicates the heading level to use for the component title.
- Attribute
- heading-level
- Default value
- 3
hideSunLightingToggle
hideSunLightingToggle: boolean- Attribute
- hide-sun-lighting-toggle
- Default value
- false
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
See also: Calcite Icons
- Attribute
- icon
- Default value
- "brightness"
playSpeedMultiplier
playSpeedMultiplier: numberControls the speed of the daytime and date animation.
- Attribute
- play-speed-multiplier
- Default value
- 1.0
position
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
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
- Attribute
- reference-element
timeSliderSteps
timeSliderSteps: Array<number> | numberSets 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
yearPlaying: booleanStarts or pauses the date animation cycling through the months of the year.
- Attribute
- year-playing
- Default value
- false
Slots
Events
| Event | Type |
|---|---|
CustomEvent<void> | |
CustomEvent<void> |
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisUserDateTimeChange
arcgisUserDateTimeChange: CustomEvent<void>Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the season selector or the play buttons.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisDaylight = document.querySelector("arcgis-daylight");
document.body.append(arcgisDaylight);
await arcgisDaylight.componentOnReady();
console.log("arcgis-daylight is ready to go!");- Returns
- Promise<void>