require(["esri/symbols/Symbol"], (Symbol) => { /* code goes here */ });
import Symbol from "@arcgis/core/symbols/Symbol.js";
esri/symbols/Symbol
Symbol is the base class for all symbols. Symbols represent point, line, polygon, and mesh geometries as vector graphics within a View. Symbols can only be set directly on individual graphics in a GraphicsLayer or in View.graphics. Otherwise they are assigned to a Renderer that is applied to a Layer.
Numerous symbols are available for depicting features. Choosing a symbol type depends on the following:
- The type of View in which the symbols will be rendered - either MapView (for 2D) or SceneView (for 3D)
- The geometry type of the feature(s)
- The purpose and context of the visualization
The following table indicates which symbol subclasses you should work with depending on the view type.
| View type | Symbol subclasses |
|---|---|
| MapView (2D) | FillSymbol, LineSymbol, MarkerSymbol, TextSymbol, WebStyleSymbol, CIMSymbol |
| SceneView (3D) | Symbol3D, WebStyleSymbol, CIMSymbol |
If working with data in a MapView, use the following table as a guide for choosing a symbol type.
| Geometry type | Valid symbol types |
|---|---|
| Point | SimpleMarkerSymbol, PictureMarkerSymbol, TextSymbol, WebStyleSymbol, CIMSymbol |
| Polyline | SimpleLineSymbol, TextSymbol, CIMSymbol |
| Polygon | SimpleFillSymbol, PictureFillSymbol, SimpleMarkerSymbol, TextSymbol, CIMSymbol |
If working with data in a SceneView, use the following table as a guide when selecting a symbol type.
| Geometry type | Valid symbol types |
|---|---|
| Point | PointSymbol3D, LabelSymbol3D, WebStyleSymbol, CIMSymbol |
| Polyline | LineSymbol3D, LabelSymbol3D |
| Polygon | PolygonSymbol3D, LabelSymbol3D |
| Mesh | MeshSymbol3D, LabelSymbol3D |
While not expressly indicated in the tables above, 2D symbols are supported in 3D SceneViews while 3D symbols are not supported in 2D MapViews. However, it is recommended to favor 3D symbol types over 2D symbols when working in a SceneView.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Color | The color of the symbol. | Symbol | |
| String | The name of the class. | Accessor | |
| String | The symbol type. | Symbol |
Property Details
-
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, andaproperties, or a Color object.- Default Value:black
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 };
-
type
Propertytype Stringreadonly -
The symbol type.
Possible Values:"simple-marker"|"picture-marker"|"simple-line"|"simple-fill"|"picture-fill"|"text"|"shield-label-symbol"|"point-3d"|"line-3d"|"polygon-3d"|"web-style"|"mesh-3d"|"label-3d"|"cim"
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Symbol | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | Symbol |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]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 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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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 from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.