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 |
---|---|---|
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 | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
time-slider-steps | Array<number> | number | |
year-playing | boolean |
autoDestroyDisabled
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
currentSeason: "fall" | "spring" | "summer" | "winter"
A season can be set instead of a date.
- Attribute
- current-season
dateOrSeason
dateOrSeason: "date" | "season"
Controls whether the widget displays a date or a season picker.
- Attribute
- date-or-season
- Default value
- "date"
dayPlaying
dayPlaying: boolean
Starts or pauses the daytime animation cycling through the minutes of the day.
- Attribute
- day-playing
- Default value
- false
headingLevel
headingLevel: number
Indicates the heading level to use for the widget title.
- Attribute
- heading-level
- Default value
- 3
hideSunLightingToggle
hideSunLightingToggle: boolean
- Attribute
- hide-sun-lighting-toggle
- Default value
- false
icon
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"
playSpeedMultiplier
playSpeedMultiplier: number
Controls 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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
timeSliderSteps
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
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(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
undefined |