ESM: import WebStyleSymbol from "@arcgis/core/symbols/WebStyleSymbol.js";
CDN: const WebStyleSymbol = await $arcgis.import("@arcgis/core/symbols/WebStyleSymbol.js");
Class: @arcgis/core/symbols/WebStyleSymbol
Since: ArcGIS Maps SDK for JavaScript 4.1
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
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.
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.
URL that points to the web style definition. Cannot be used in conjunction with styleName and portal.
See class description for example.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
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(options){Promise<CIMSymbol>}
Since: ArcGIS Maps SDK for JavaScript 4.16 WebStyleSymbol since 4.1, fetchCIMSymbol added at 4.16.
Deprecated since version 4.33. UsefetchSymbol instead. Pass { acceptedFormats: ["cim"] } as options to fetchSymbol to retrieve only CIM symbols.
Returns the CIMSymbol instance the WebStyleSymbol refers to.
Parameters
optionalAn object with the following properties.
Specification
optionalSignal 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
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;
});
// note: the above is deprecated functionality. Use the following instead:
renderer.symbol.fetchSymbol({ acceptedFormats: ["cim"] }).then(function (cimSymbol) {
renderer.symbol = cimSymbol;
});Resolves and returns the symbol instance the WebStyleSymbol refers to.
Parameters
Specification
optionalAn object with the following properties.
Specification
optionalDefault Value: ["web", "cim"]
A list of accepted formats. The symbol will resolve to the first accepted format in the list.
optionalSignal 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<Symbol2D3DUnion> When resolved, returns a symbol instance.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;
});Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4