// Referencing a web style via styleName
var symbol = {
  type: "web-style",  // autocasts as new WebStyleSymbol()
  styleName: "EsriThematicShapesStyle",
  name: "Standing Diamond"
};

// Referencing a web style via styleUrl
var symbol = {
  type: "web-style",  // autocasts as new WebStyleSymbol()
  styleUrl: "http://www.arcgis.com/sharing/rest/content/items/bf27400d167d4c2e8e12c8a46f87afe4/data",
  name: "Centered Sphere"
};

Property Overview

Property Details

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

name String

The name of the symbol within the web style. Each symbol in a web style is identified by a unique name. Only Esri Web Style Symbols (2D) and Esri Web Style Symbols (3D) can be referenced here.

See also:

• Guide - WebStyleSymbol reference list

portal Portalautocast

The portal that contains the web style this symbol refers to. Only required when styleName is set.

Defaults to the value in config.portalUrl (e.g. https://www.arcgis.com).

styleName String

A registered web style name. Only Esri Web Style Symbols (2D) and Esri Web Style Symbols (3D) can be referenced here. Note that the 2D web style symbols are only supported in 2D and 3D web style symbols are only supported in 3D with an exception of EsriIconsStyle which can be used in both 2D and 3D.

Requires portal property to be set. Can not be used in conjunction with styleUrl.

See class description for example.

See also:

• Guide - WebStyleSymbol reference list

styleUrl String

URL that points to the web style definition. Cannot be used in conjunction with styleName and portal.

See class description for example.

type Stringreadonly

For WebStyleSymbol the type is always "web-style".

Method Overview

Method Details

clone(){WebStyleSymbol}

Creates a deep clone of the symbol.

Returns:

Type	Description
WebStyleSymbol	A deep clone of the object that invoked this method.

Example:

// Creates a deep clone of the graphic's symbol
var symLyr = graphic.symbol.clone();

fetchSymbol(options){Promise<PointSymbol3D>}

Downloads and returns the PointSymbol3D instance the WebStyleSymbol refers to.

Parameters:

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:

Type	Description
Promise<PointSymbol3D>	When resolved, returns a PointSymbol3D instance.

See also:

• Guide - Visualizing points with 3D symbols

Example:

// Given a SimpleRenderer with a WebStyleSymbol, replaces the symbol with its non-referencing version by fetching it
renderer.symbol.fetchSymbol().then(function(actualSymbol) {
  renderer.symbol = actualSymbol;
});

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.

toJSON(){Object}inherited

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

Returns:

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