SnowyWeather | References | ArcGIS Maps SDK for JavaScript

import SnowyWeather from "@arcgis/core/views/3d/environment/SnowyWeather.js";

Inheritance:: SnowyWeather→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.24

The SnowyWeather class allows you to change the weather conditions in the scene to snowy weather.

scene-atmosphere

Example:

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" })
    }
  }
});

The weather visualization updates as soon as the property changes:

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

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SnowyWeatherProperties`

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

Properties

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

Property	Type	Class
`cloudCover`	`number`
`declaredClass` readonly inherited	`string`	Accessor
`precipitation`	`number`
`snowCover`	`"enabled" \| "disabled"`
`type` readonly	`"snowy"`

cloudCover

Property

Type: number

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

Default value: 0.5

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

precipitation

Property

Type: number

Specifies the amount of falling snow.

Default value: 0.5

snowCover

Property

Type: "enabled" | "disabled"

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

Default value: "disabled"

type

readonly Property

Type: "snowy"

The type of Weather

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): SnowyWeather`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

Method

Signature: clone (): SnowyWeather

Creates a deep clone of this object.

Returns: SnowyWeather
Creates a new clone of the instance calling this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.