MarkerSymbol

Class: esri/symbols/MarkerSymbol
Inheritance: MarkerSymbol Symbol Accessor
Since: ArcGIS API for JavaScript 4.0

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

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.
NameTypeSummaryClass
Number

The angle of the marker in degrees.

more details
more detailsMarkerSymbol
String

The name of the class.

more details
more detailsAccessor
String

The symbol type.

more details
more detailsMarkerSymbol
Number

The offset on the x-axis in points.

more details
more detailsMarkerSymbol
Number

The offset on the y-axis in points.

more details
more detailsMarkerSymbol

Property Details

angleNumber

The angle of the marker in degrees.

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: 0

declaredClassStringreadonly inherited

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

typeString

The symbol type.

Possible values: simple-marker | picture-marker

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

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: 0
Examples:
// xoffset in points
symbol.xoffset = 4;
// xoffset in pixels
symbol.xoffset = "2px";
// xoffset in points
symbol.xoffset = "4pt";

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

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: 0
Examples:
// yoffset in points
symbol.yoffset = 4;
// yoffset in pixels
symbol.yoffset = "2px";
// yoffset in points
symbol.yoffset = "4pt";

Method Overview

NameReturn TypeSummaryClass
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsSymbol
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsSymbol

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*Returns a new instance of this class.

toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.