SimpleMarkerSymbol

AMD: require(["esri/symbols/SimpleMarkerSymbol"], (SimpleMarkerSymbol) => { /* code goes here */ });
ESM: import SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
Class: esri/symbols/SimpleMarkerSymbol
Inheritance: SimpleMarkerSymbol MarkerSymbol Symbol Accessor
Since: ArcGIS API for JavaScript 4.0

SimpleMarkerSymbol is used for rendering 2D Point geometries with a simple shape and color in either a MapView or a SceneView. It may be filled with a solid color and have an optional outline, which is defined with a SimpleLineSymbol.

SimpleMarkerSymbols may be applied to point or polygon features in a FeatureLayer or individual graphics. Marker symbols can be used in a 3D SceneView. However, it is recommended you use PointSymbol3D instead. The image below depicts a FeatureLayer whose point features are styled with SimpleMarkerSymbols.

sms-sample

See also:
Example:
let 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
  }
};

Constructors

new SimpleMarkerSymbol(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
Numbermore details

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

more detailsMarkerSymbol
Colormore details

The color of the symbol.

more detailsSimpleMarkerSymbol
Stringmore details

The name of the class.

more detailsAccessor
SimpleLineSymbolmore details

The outline of the marker symbol.

more detailsSimpleMarkerSymbol
Stringmore details

The SVG path of the icon.

more detailsSimpleMarkerSymbol
Numbermore details

The size of the marker in points.

more detailsSimpleMarkerSymbol
Stringmore details

The marker style.

more detailsSimpleMarkerSymbol
Stringmore details

The symbol type.

more detailsSimpleMarkerSymbol
Numbermore details

The offset on the x-axis in points.

more detailsMarkerSymbol
Numbermore details

The offset on the y-axis in points.

more detailsMarkerSymbol

Property Details

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

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:0
Autocasts from Object|number[]|string

The color of the symbol. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, 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
};
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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:
let sym = {
  type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
  color: "red",
  outline: {  // autocasts as new SimpleLineSymbol()
    color: [ 128, 128, 128, 0.5 ],
    width: "0.5px"
  }
};
path String

The SVG path of the icon.

Known Limitations

This property works only in 2D.

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";
style String

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

Value Description
circle sms_circle
cross sms_cross
diamond sms_diamond
square sms_square
triangle sms_triangle
x sms_x

Possible Values:"circle"|"square"|"cross"|"x"|"diamond"|"triangle"|"path"

Default Value:circle
type Stringreadonly

The symbol type.

For SimpleMarkerSymbol the type is always "simple-marker".

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";
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
Name Return Type Summary Class
SimpleMarkerSymbolmore details

Creates a deep clone of the symbol.

more detailsSimpleMarkerSymbol
*more details

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

more detailsSymbol
Objectmore details

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

more detailsSymbol

Method Details

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
let 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 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.
toJSON(){Object}inherited

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.

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