RainyWeather | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The RainyWeather class allows you to change the weather conditions in the scene to rainy weather.

scene-atmosphere

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

Sample - Weather visualization

Constructors

RainyWeather Constructor new RainyWeather(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Number	Specifies the amount of cloud cover in the sky for a certain weather type.	RainyWeather
String	The name of the class.	Accessor
Number	Specifies the amount of falling rain.	RainyWeather
String	The type of Weather	RainyWeather

Property Details

cloudCover Property cloudCover Number

Specifies the amount of cloud cover in the sky for a certain weather type.

Default Value:0.5

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

precipitation Property precipitation Number Since: ArcGIS Maps SDK for JavaScript 4.24 RainyWeather since 4.22, precipitation added at 4.24.

Specifies the amount of falling rain.

Default Value:0.5

type Property type Stringreadonly

The type of Weather

For RainyWeather the type is always "rainy".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
RainyWeather	Creates a deep clone of this object.	RainyWeather
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Method clone(){RainyWeather}

Creates a deep clone of this object.

Returns

Type	Description
RainyWeather	Creates a new clone of the instance calling this method.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");