Symbol

AMD: require(["esri/symbols/Symbol"], (Symbol) => { /* code goes here */ });
ESM: import Symbol from "@arcgis/core/symbols/Symbol";
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. 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.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Colormore details

The color of the symbol.

more detailsSymbol
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The symbol type.

more detailsSymbol

Property Details

Autocasts from Object|Number[]|String

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.

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
};
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

type 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
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsSymbol
Objectmore details

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

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

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:
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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.