WaterSymbol3DLayer

AMD: require(["esri/symbols/WaterSymbol3DLayer"], (WaterSymbol3DLayer) => { /* code goes here */ });
ESM: import WaterSymbol3DLayer from "@arcgis/core/symbols/WaterSymbol3DLayer.js";
Class: esri/symbols/WaterSymbol3DLayer
Inheritance: WaterSymbol3DLayer Symbol3DLayer Accessor
Since: ArcGIS Maps SDK for JavaScript 4.12

WaterSymbol3DLayer is used to render Polygon geometries as realistic, animated water surfaces, therefore it can only be used inside a PolygonSymbol3D.

symbol3D-water

Various properties can be set to enhance the realistic effect of this symbol layer. The waveStrength can be set to show the magnitude of the waves and waveDirection indicates the direction in which the waves travel. The waterbodySize can be set to specify how large the waterbody is. The dominant color of the water can be used to change the appearance of the water.

This symbol layer is not supported in a MapView.

See also
Example
const waterLayer = new FeatureLayer({
  ...,
  renderer: {
    type: "simple",
    symbol: {
      type: "polygon-3d",
      symbolLayers: [{
        type: "water",
        waveDirection: 180,
        color: "#5975a3",
        waveStrength: "moderate",
        waterbodySize: "small"
      }]
    }
  }
});

Constructors

WaterSymbol3DLayer

Constructor
new WaterSymbol3DLayer(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Color

The dominant color used to shade the water.

WaterSymbol3DLayer
String

The name of the class.

Accessor
String

The symbol type.

WaterSymbol3DLayer
String

Indicates the size of the waterbody which is represented by the symbol layer.

WaterSymbol3DLayer
Number

Indicates the direction in which the waves travel.

WaterSymbol3DLayer
String

Indicates the shape and intensity of the waves.

WaterSymbol3DLayer

Property Details

color

Property
color Colorautocast
Autocasts from Object|Number[]|String

The dominant color used to shade the water. The water has different shades of the dominant color based on the reflection of the light. The image below shows how different types of water can be represented with different colors. For example for deep water the dominant color could be navy blue.

symbol3D-water

The color can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

Default Value:#0077BE
Example
// a new color by a HEX string
symbolLayer.color = "#005B66";

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

type

Property
type Stringreadonly

The symbol type.

For WaterSymbol3DLayer the type is always "water".

waterbodySize

Property
waterbodySize String

Indicates the size of the waterbody which is represented by the symbol layer. small can be set for small lakes, rivers or swimming pools, medium can be set for large lakes, whereas large is recommended for ocean and sea waterbodies.

Possible Values:"small"|"medium"|"large"

Default Value:medium
Example
// sets the waterBodySize for an ocean like waterbody.
symbolLayer.waterbodySize = "large";

waveDirection

Property
waveDirection Number

Indicates the direction in which the waves travel. This value represents the geographic rotation in degrees and it ranges from 0 to 360 degrees. A value of 0 degrees corresponds to geographic north, which means that the wave travels from south to north.

The default is set to null, which will display the waves without a distinct direction.

Default Value:null
Example
// sets the wave direction to 215 degrees
symbolLayer.waveDirection = 215;

waveStrength

Property
waveStrength String

Indicates the shape and intensity of the waves. Currently only calm to moderate waterbodies can be represented. A calm wave strength represents water without waves, acting almost like a mirror. A water with rippled wave strength has very small and short waves. slight wave strength displays the waves with a more pronounced form, but they are still quite short. Choosing moderate will display waves with a longer form and a slightly increased intensity.

Possible Values:"calm"|"rippled"|"slight"|"moderate"

Default Value:moderate
Example
// sets the wave strength to small waves
symbolLayer.waveStrength = "slight";

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
WaterSymbol3DLayer

Creates a deep clone of the symbol layer.

WaterSymbol3DLayer
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

Symbol3DLayer
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

Symbol3DLayer

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

Creates a deep clone of the symbol layer.

Returns
Type Description
WaterSymbol3DLayer A deep clone of the object that invoked this method.
Example
// Creates a deep clone of the graphic's first symbol layer
let symLyr = graphic.symbol.symbolLayers.at(0).clone();

fromJSON

Inherited
Method
fromJSON(json){*}static

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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.

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

toJSON

Inherited
Method
toJSON(){Object}
Inherited from Symbol3DLayer

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

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.