Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-daylight";
No specific import is needed for this component.
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 autoDestroyDisabledProperty
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.
Property
currentSeason: "fall" | "spring" | "summer" | "winter"
A season can be set instead of a date.
Property
dateOrSeason: "date" | "season"
Controls whether the component displays a date or a season picker.
Property
dayPlaying: boolean
Starts or pauses the daytime animation cycling through the minutes of the day.
Property
headingLevel: number
Indicates the heading level to use for the component title.
Property
hideDatePicker: boolean
Property
hideHeader: boolean
Property
hidePlayButtons: boolean
Property
hideShadowsToggle: boolean
Property
hideSunLightingToggle: boolean
Property
hideTimezone: boolean
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
See also: Calcite Icons
Property
label: string
The component's default label.
Property
playSpeedMultiplier: number
Controls the speed of the daytime and date animation.
Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
By 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.
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.
Property
yearPlaying: boolean
Starts or pauses the date animation cycling through the months of the year.
No slots to display.
Events arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisUserDateTimeChangeEvent
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.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods componentOnReadyMethod
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisDaylight = document.querySelector("arcgis-daylight");
document.body.append(arcgisDaylight);
await arcgisDaylight.componentOnReady();
console.log("arcgis-daylight is ready to go!");
Method
destroy(): Promise<void>
Permanently destroy the component.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4