Class: esri/symbols/Symbol
Inheritance: Symbol Accessor
Since: ArcGIS API for JavaScript 4.0

Symbol is the base class for all symbols. Symbols represent point, line, polygon, and mesh geometries as vector graphics within a View. They can be set on individual graphics or in a Renderer that is applied to a FeatureLayer.

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 typeSymbol 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 typeValid symbol types
PointSimpleMarkerSymbol, PictureMarkerSymbol, TextSymbol
PolylineSimpleLineSymbol, TextSymbol
PolygonSimpleFillSymbol, PictureFillSymbol, SimpleMarkerSymbol, TextSymbol

If working with data in a SceneView, use the following table as a guide when selecting a symbol type.

Geometry typeValid symbol types
PointPointSymbol3D, LabelSymbol3D
PolylineLineSymbol3D, LabelSymbol3D
PolygonPolygonSymbol3D, LabelSymbol3D
MeshMeshSymbol3D, 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.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The symbol type.

more details
more detailsSymbol

Property Details

declaredClassStringreadonly inherited

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

typeString

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

NameReturn TypeSummaryClass
*

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 detailsSymbol
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsSymbol

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

Parameter:
json Object

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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.