import "@arcgis/map-components/components/arcgis-weather";The Weather component allows easy selection and configuration of weather effects in a Scene component. The available weather types are: sunny, cloudy, rainy, snowy, and foggy.
To set the weather programmatically, apply the desired weather type to the environment property of the Scene component.
// Access the Scene component.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
// Specify the weather settings.
viewElement.environment.weather = {
type: "rainy", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })
cloudCover: 0.7,
precipitation: 0.3
};To determine if the weather visualization is available, check the boolean value of viewElement.environment.weatherAvailable. The weather is only available:
- in
globalviewing mode, - when
atmosphereEnabledproperty on environment istrue, - at lower altitudes, near the ground.
Known limitations
Weather is only supported in a 3D Scene component.
See also
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
heading-level | 1 | 2 | 3 | 4 | 5 | 6 | |
hide-header | boolean | |
icon | string | |
label | string | |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
statereadonly | state | "disabled" | "error" | "ready" |
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
headingLevel
headingLevel: 1 | 2 | 3 | 4 | 5 | 6Indicates the heading level to use for the title of the component. By default, this message is rendered as a level 4
heading (e.g. <h4>Time range</h4>). Depending on the component's placement in your app, you may need to adjust
this heading for proper semantics. This is important for meeting accessibility standards.
- See also
- Attribute
- heading-level
- Default value
- 4
hideHeader
hideHeader: booleanWhether to hide the component's header.
- Attribute
- hide-header
- 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
- Attribute
- icon
- Default value
- "partly-cloudy"
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
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
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
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.
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.
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 arcgisWeather = document.querySelector("arcgis-weather");
document.body.append(arcgisWeather);
await arcgisWeather.componentOnReady();
console.log("arcgis-weather is ready to go!");- Returns
- Promise<void>