require(["esri/symbols/support/StyleOrigin"], (StyleOrigin) => { /* code goes here */ });
import StyleOrigin from "@arcgis/core/symbols/support/StyleOrigin.js";
esri/symbols/support/StyleOrigin
The style origin.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | Name of the symbol in the style referenced by styleName or styleUrl. | StyleOrigin | |
| Portal | The portal of the style origin. | StyleOrigin | |
| String | The well-known esri-provided style, such as | StyleOrigin | |
| String | A url to a style definition. | StyleOrigin |
Property Details
-
name
Propertyname String -
Name of the symbol in the style referenced by styleName or styleUrl.
-
portal
Propertyportal Portal -
The portal of the style origin.
-
styleName
PropertystyleName String -
The well-known esri-provided style, such as
EsriThematicShapesStyle.
-
styleUrl
PropertystyleUrl String -
A url to a style definition.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| StyleOrigin | Creates a deep clone of the style origin. | StyleOrigin | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
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();ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
clone
Methodclone(){StyleOrigin} -
Creates a deep clone of the style origin.
ReturnsType Description StyleOrigin A deep clone of the object that invoked this method.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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 from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");