Symbol
esri/symbols/SymbolSymbol 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 FeatureLayer or a SceneLayer.
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 |
| SceneView (3D) | Symbol3D |
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 |
| Polyline | SimpleLineSymbol, TextSymbol |
| Polygon | SimpleFillSymbol, PictureFillSymbol, SimpleMarkerSymbol, TextSymbol |
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 |
| 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 | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The symbol type. more details | more details | Symbol |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- typeStringreadonly
The symbol type.
Possible values: simple-marker | picture-marker | simple-line | cartographic-line-symbol | simple-fill | picture-fill | text | shield-label-symbol | point-3d | line-3d | polygon-3d | mesh-3d | label-3d
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | Symbol | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Symbol |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.Parameter:json 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.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.