Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: MarkerSymbol
[ AMD Module Require | Legacy Module Require ]
require(["esri/symbols/MarkerSymbol"], function(MarkerSymbol) { /* code goes here */ });
Description
(Added at v1.0)
Marker symbols are used to draw points and multipoints on the graphics layer. MarkerSymbol has no constructor. Use SimpleMarkerSymbol or PictureMarkerSymbol.
Samples
Search for samples that use this class.Class hierarchy
esri/symbols/Symbol |_esri/symbols/MarkerSymbol
Subclasses
Properties
| Name | Type | Summary |
|---|---|---|
| angle | Number | The angle of the marker. |
| color | Color | Symbol color. |
| size | Number | Size of the marker in pixels. |
| type | String | The type of symbol. |
| xoffset | Number | The offset on the x-axis in pixels. |
| yoffset | Number | The offset on the y-axis in pixels. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setAngle(angle) | MarkerSymbol | Rotates the symbol clockwise around its center by the specified angle. |
| setColor(color) | Symbol | Sets the symbol color. |
| setOffset(x, y) | MarkerSymbol | Sets the x and y offset of a marker in screen units. |
| setSize(size) | MarkerSymbol | Sets the size of a marker in pixels. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Property Details
<Color
ColorSymbol color.
<Number
NumberSize of the marker in pixels.
<String
StringThe type of symbol.
Known values:
simplemarkersymbol | picturemarkersymbol | simplelinesymbol | cartographiclinesymbol | simplefillsymbol | picturefillsymbol | textsymbolMethod Details
Rotates the symbol clockwise around its center by the specified angle.
Return type:
MarkerSymbolParameters:
< |
Required | The angle value. 0 is pointing right and values progress clockwise. |
Sets the symbol color.
Return type:
SymbolParameters:
< |
Required | Symbol color. |
Sample:
require([
"esri/Color", ...
], function(Color, ... ) {
symbol.setColor(new Color([255,255,0,0.5]));
...
});
Sets the x and y offset of a marker in screen units.
Return type:
MarkerSymbolSets the size of a marker in pixels.
Return type:
MarkerSymbolParameters:
< |
Required | The width of the symbol in pixels. |
Sample:
var markerSymbol = new SimpleMarkerSymbol();
markerSymbol.setPath(path);
markerSymbol.setColor(new Color(color));
markerSymbol.setOutline(null);
markerSymbol.setSize("32");
Converts object to its ArcGIS Server JSON representation.
Be aware that the angle in the JSON is different from MarkerSymbol.angle. The angle in the JSON follows the traditional ArcGIS specification and is rotated counter-clockwise, whereas the angle in the symbol is rotated clockwise. For example, if your MarkerSymbol has angle=30 (clockwise), this method will return a JSON object where angle=-30 (counter-clockwise):
Be aware that the angle in the JSON is different from MarkerSymbol.angle. The angle in the JSON follows the traditional ArcGIS specification and is rotated counter-clockwise, whereas the angle in the symbol is rotated clockwise. For example, if your MarkerSymbol has angle=30 (clockwise), this method will return a JSON object where angle=-30 (counter-clockwise):
{
"color": [255,255,255,64],
"size": 12,
"angle": -30,
"xoffset": 0,
"yoffset": 0,
"type": "esriSMS",
"style": "esriSMSCross",
"outline": {"color":[0,0,0,255],"width":1,"type":"esriSLS","style":"esriSLSSolid"}
}Return type:
Object