WebStyleSymbol

WebStyleSymbol is a class used to conveniently create vector 2D symbols and realistic and thematic 3D symbols. It is a wrapper for creating CIMSymbol and PointSymbol3D objects that point to a web style resource available in the API.

Web styles are collections of symbols stored in an ArcGIS Enterprise portal or ArcGIS Online item. As of the current release, only Esri Web Style Symbols (2D) and Esri Web Style Symbols (3D) can be used in conjunction with this class. 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.

A WebStyleSymbol does not contain any symbology definition itself; it only contains a reference to a web style symbol. For visualization purposes, it is internally replaced with the CIMSymbol or the PointSymbol3D instance it refers to. You can use fetchSymbol() to retrieve the actual symbol object from the web style to alter its color or size.

A web style can be referenced either directly with a URL (styleUrl) or registered style's unique name (styleName).

Known Limitation

Currently, fetchSymbol() method will only work for 3d web style symbols

See also

Examples

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

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

Constructors

WebStyleSymbol Constructor new WebStyleSymbol(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

Type	Summary	Class
String	The name of the class.	Accessor
String	The name of the symbol within the web style.	WebStyleSymbol
Portal	The portal that contains the web style this symbol refers to.	WebStyleSymbol
String	A registered web style name.	WebStyleSymbol
String	URL that points to the web style definition.	WebStyleSymbol
String	For WebStyleSymbol the type is always "web-style".	WebStyleSymbol

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

name Property 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 Property 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 Property 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 Property 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 Property type Stringreadonly

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

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
WebStyleSymbol	Creates a deep clone of the symbol.	WebStyleSymbol
Promise<CIMSymbol>	Returns the CIMSymbol instance the WebStyleSymbol refers to.	WebStyleSymbol
Promise<PointSymbol3D>	Downloads and returns the PointSymbol3D instance the WebStyleSymbol refers to.	WebStyleSymbol
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Symbol
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.	Symbol

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(){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
let symLyr = graphic.symbol.clone();

fetchCIMSymbol Method fetchCIMSymbol(options){Promise<CIMSymbol>} Since: ArcGIS Maps SDK for JavaScript 4.16 WebStyleSymbol since 4.1, fetchCIMSymbol added at 4.16.

Returns the CIMSymbol 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<CIMSymbol>	When resolved, returns a CIMSymbol instance.

Example

// Given a SimpleRenderer with a WebStyleSymbol,
// fetch the corresponding CIMSymbol,
// then replace the renderer symbol with the returned CIMSymbol
renderer.symbol.fetchCIMSymbol().then(function (cimSymbol) {
  renderer.symbol = cimSymbol;
});

fetchSymbol Method 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

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 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 Symbol

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.

ArcGIS Maps SDK for JavaScriptAPI Reference

Constructors

WebStyleSymbol

Property Overview

Property Details

declaredClass

name

portal

styleName

styleUrl

type

Method Overview

Method Details

addHandles

clone

fetchCIMSymbol

fetchSymbol

fromJSON

hasHandles

removeHandles

toJSON

Was this page helpful?