StyleOrigin

AMD: require(["esri/symbols/support/StyleOrigin"], (StyleOrigin) => { /* code goes here */ });
ESM: import StyleOrigin from "@arcgis/core/symbols/support/StyleOrigin";
Class: esri/symbols/support/StyleOrigin
Inheritance: StyleOrigin Accessor

The style origin.

Constructors

new StyleOrigin(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
String

The name of the class.

more details
Accessor
String

Name of the symbol in the style referenced by styleName or styleUrl.

more details
StyleOrigin
Portal

The portal of the style origin.

more details
StyleOrigin
String

The well-known esri-provided style, such as EsriThematicShapesStyle.

more details
StyleOrigin
String

A url to a style definition.

more details
StyleOrigin

Property Details

declaredClass Stringreadonly inherited

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

name String

Name of the symbol in the style referenced by styleName or styleUrl.

portal Portal

The portal of the style origin.

styleName String

The well-known esri-provided style, such as EsriThematicShapesStyle.

styleUrl String

A url to a style definition.

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.

more details
Accessor
StyleOrigin

Creates a deep clone of the style origin.

more details
StyleOrigin
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(){StyleOrigin}

Creates a deep clone of the style origin.

Returns
Type Description
StyleOrigin A deep clone of the object that invoked this method.
hasHandles(groupKey){Boolean}inherited

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(groupKey)inherited

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

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