MarkerSymbol | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Marker symbols are used to draw Point graphics in a FeatureLayer or individual graphics in a 2D MapView. To create new marker symbols, use either SimpleMarkerSymbol or PictureMarkerSymbol.

Marker symbols may also be used to symbolize 2D polygon features. The image below depicts a FeatureLayer whose polygon features are styled with SimpleMarkerSymbols.

Marker symbols can be used in a 3D SceneView. However, it is recommended you use PointSymbol3D instead.

See also

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
Number	The angle of the marker relative to the screen in degrees.	MarkerSymbol
String	The name of the class.	Accessor
String	The symbol type.	MarkerSymbol
Number	The offset on the x-axis in points.	MarkerSymbol
Number	The offset on the y-axis in points.	MarkerSymbol

Property Details

angle Property angle Number

The angle of the marker relative to the screen in degrees.

Default Value:0

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.

type Property type String

The symbol type.

Possible Values:"simple-marker" |"picture-marker"

xoffset Property xoffset Numberautocast Autocasts from Number|String

The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:0

Examples

// xoffset in points
symbol.xoffset = 4;

// xoffset in pixels
symbol.xoffset = "2px";

// xoffset in points
symbol.xoffset = "4pt";

yoffset Property yoffset Numberautocast Autocasts from Number|String

The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:0

Examples

// yoffset in points
symbol.yoffset = 4;

// yoffset in pixels
symbol.yoffset = "2px";

// yoffset in points
symbol.yoffset = "4pt";

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
*	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.

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.