SimpleMarkerSymbol | References | ArcGIS Maps SDK for JavaScript

import SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol.js";

Inheritance:: SimpleMarkerSymbol→MarkerSymbol→Symbol→Accessor

Since: ArcGIS Maps SDK 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.

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SimpleMarkerSymbolProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`angle` inherited	`number`	MarkerSymbol
`color`	`Color`
`declaredClass` readonly inherited	`string`	Accessor
`outline`	`SimpleLineSymbol`
`path`	`string`
`size`	`number`
`style`	`"circle" \| "square" \| "cross" \| "x" \| "diamond" \| "triangle" \| "path"`
`type` readonly	`"simple-marker"`
`xoffset` inherited	`number`	MarkerSymbol
`yoffset` inherited	`number`	MarkerSymbol

angle

inherited Property

Type: number

Inherited from: MarkerSymbol

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

Default value: 0

color

autocast Property

Type: Color

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

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

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

outline

autocast Property

Type: SimpleLineSymbol

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.

Known Limitations

[SimpleLineSymbol style](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/) property is not honored in a simple marker symbol's outlinein a 3D [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). Support for outlinestyle` was added in a 2D MapView at version 4.28.

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

Property

Type: string

The SVG path of the icon.

Known Limitations

This property works only in 2D.

size

autocast Property

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

Property

Type: "circle" | "square" | "cross" | "x" | "diamond" | "triangle" | "path"

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

Value	Description
circle
cross
diamond
square
triangle
x

Default value: "circle"

type

readonly Property

Type: "simple-marker"

The symbol type.

xoffset

autocast inherited Property

Type: number

Inherited from: MarkerSymbol

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

autocast inherited Property

Type: number

Inherited from: MarkerSymbol

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

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): SimpleMarkerSymbol`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): SimpleMarkerSymbol

Creates a deep clone of the symbol.

Returns: 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();

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.