var symbol = {
  type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
  style: "square",
  color: "blue",
  size: "8px",  // pixels
  outline: {  // autocasts as new SimpleLineSymbol()
    color: [ 255, 255, 0 ],
    width: 3  // points
  }
};

Property Overview

Property Details

angleNumber inherited

The angle of the marker in degrees.

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:0

colorColorautocast

Autocasts from Object|Number[]|String

The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with r, g, b, and a properties; or a Color object.

The color property does not apply to marker symbols defined with the cross or x style. Since these styles are wholly comprised of outlines, you must modify the outline.color property to set the color of symbols with those styles.

Default Value:[255, 255, 255, 0.25] - white, semitransparent

Examples:

// CSS color string
symbol.color = "dodgerblue";

// HEX string
symbol.color = "#33cc33";

// array of RGBA values
symbol.color = [51, 204, 51, 0.3];

// object with rgba properties
symbol.color = {
  r: 51,
  g: 51,
  b: 204,
  a: 0.7
};

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

outlineSimpleLineSymbolautocast

The outline of the marker symbol. The color property of this object directly modifies the overall color of marker symbols defined with the cross or x style.

Example:

var sym = {
  type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
  color: "red",
  outline: {  // autocasts as new SimpleLineSymbol()
    color: [ 128, 128, 128, 0.5 ],
    width: "0.5px"
  }
};

pathString

The SVG path of the icon.

Known Limitations

This property is currently not supported in 3D SceneViews.

sizeNumberautocast

Autocasts from String|Number

The size of the marker in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:12

Examples:

// size in points
symbol.size = 14;

// size in pixels
symbol.size = "20px";

// size in points
symbol.size = "14pt";

styleString

The marker style. Possible values are in the table below.

Value	Description
circle
cross
diamond
square
x

Default Value:circle

typeStringreadonly

For SimpleMarkerSymbol the type is always simple-marker.

xoffsetNumberautocast inherited

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

Known Limitations

This property is currently 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";

yoffsetNumberautocast inherited

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

Known Limitations

This property is currently 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

Method Details

clone(){SimpleMarkerSymbol}

Creates a deep clone of the symbol.

Returns:

Type	Description
SimpleMarkerSymbol	A deep clone of the object that invoked this method.

Example:

// Creates a deep clone of the graphic's symbol
var symLyr = graphic.symbol.clone();

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:

Type	Description
*	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:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.