ESM: import SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol.js";
CDN: const SimpleMarkerSymbol = await $arcgis.import("@arcgis/core/symbols/SimpleMarkerSymbol.js");
Class: @arcgis/core/symbols/SimpleMarkerSymbol
Since: ArcGIS Maps SDK for JavaScript 4.0
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsInherited
Property angle Number
The angle of the marker relative to the screen in degrees.
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
};
Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 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"
}
};
The SVG path of the icon.
Known Limitations
This property works only in 2D.
The size of the marker in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px
).
Examples
// size in points
symbol.size = 14;
// size in pixels
symbol.size = "20px";
// size in points
symbol.size = "14pt";
The marker style. Possible values are in the table below.
Possible Values:"circle" |"square" |"cross" |"x" |"diamond" |"triangle" |"path"
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
).
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
).
Examples
// yoffset in points
symbol.yoffset = 4;
// yoffset in pixels
symbol.yoffset = "2px";
// yoffset in points
symbol.yoffset = "4pt";
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles
const handle = reactiveUtils.when(
() => !view.updating,
() => {
wkidSelect.disabled = false;
},
{ once: true }
);
this.addHandles(handle);
// Destroy the object
this.destroy();
Parameters
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
Creates a deep clone of the symbol.
Returns
Example
// Creates a deep clone of the graphic's symbol
let symLyr = graphic.symbol.clone();
Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
obj.removeHandles("watch-view-updates");
}
Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4