require(["esri/views/3d/environment/RainyWeather"], (RainyWeather) => { /* code goes here */ });
import RainyWeather from "@arcgis/core/views/3d/environment/RainyWeather.js";
esri/views/3d/environment/RainyWeather
The RainyWeather class allows you to change the weather conditions in the scene to rainy weather.
Example:
let view = new SceneView({
container: "viewDiv",
map: new Map({
basemap: "satellite",
ground: "world-elevation"
}),
environment: {
weather: {
type: "rainy",
cloudCover: 0.8,
precipitation: 0.3 // autocasts as new RainyWeather({ cloudCover: 0.8, precipitation: 0.3 })
}
}
});
The weather visualization updates as soon as the property changes:
view.environment.weather = {
type: "rainy",
cloudCover: 0.4,
precipitation: 0.3 // autocasts as new RainyWeather({ cloudCover: 0.4, precipitation: 0.3 })
}
- See also
Constructors
-
new RainyWeather(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Number | Specifies the amount of cloud cover in the sky for a certain weather type. more details | RainyWeather | |
String | The name of the class. more details | Accessor | |
Number | Specifies the amount of falling rain. more details | RainyWeather | |
String | The type of Weather more details | RainyWeather |
Property Details
-
cloudCover Number
-
Specifies the amount of cloud cover in the sky for a certain weather type.
- Default Value:0.5
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
precipitation NumberSince: ArcGIS Maps SDK for JavaScript 4.24
-
Specifies the amount of falling rain.
- Default Value:0.5
-
type Stringreadonly
-
The type of Weather
For RainyWeather the type is always "rainy".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
RainyWeather | Creates a deep clone of this object. more details | RainyWeather | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
clone(){RainyWeather}
-
Creates a deep clone of this object.
ReturnsType Description RainyWeather Creates a new clone of the instance calling this method.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");