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 |
|---|---|---|
autoDestroyDisabled | auto-destroy-disabled | boolean |
headingLevel | heading-level | 1 | 2 | 3 | 4 | 5 | 6 |
hideHeader | hide-header | boolean |
icon | icon | string |
label | label | string |
messageOverrides | | Record<string, unknown> |
positiondeprecated | position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" |
referenceElement | reference-element | HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string |
statereadonlyreflected | state | "disabled" | "error" | "ready" |
view | | SceneView |
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"slot instead.- Attribute
- position
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
state
state: "disabled" | "error" | "ready"The current state of the component.
- Attribute
- state
view
view: SceneViewThe view associated with the component.
Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this
viewproperty which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Weather component will be associated with a map or scene component rather than using theviewproperty.
Methods
| Method | Signature |
|---|---|
componentOnReady | componentOnReady(): Promise<void> |
destroy | 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>
Events
| Event | Type |
|---|---|
arcgisPropertyChange | CustomEvent<{ name: "state"; }> |
arcgisReady | CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is ready to be interacted with.