SnowyWeather

let view = new SceneView({
  container: "viewDiv",

  map: new Map({
    basemap: "satellite",
    ground: "world-elevation"
  }),
  environment: {
    weather: {
      type: "snowy",
      cloudCover: 0.8,
      precipitation: 0.3,
      snowCover: "enabled"   // autocasts as new SnowyWeather({ cloudCover: 0.8, precipitation: 0.3, snowCover: "enabled" })
    }
  }
});

view.environment.weather = {
   type: "snowy",
   cloudCover: 0.4,
   precipitation: 0.3   // autocasts as new SnowyWeather({ cloudCover: 0.4, precipitation: 0.3, snowCover: "disabled" })
}

Property Overview

Property Details

cloudCover Number

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

Default Value:0.5

declaredClass Stringreadonly inherited

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

precipitation Number

Specifies the amount of falling snow.

Default Value:0.5

snowCover String

Display surfaces covered with snow. The snow cover does not display on basemaps or draped layers.

Possible Values:"enabled"|"disabled"

Default Value:"disabled"

type Stringreadonly

The type of Weather

For SnowyWeather the type is always "snowy".

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

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(){SnowyWeather}

Creates a deep clone of this object.

Returns

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

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS API for JavaScript 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(groupKey)inherited

Since: ArcGIS API for JavaScript 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");