Symbol

import Symbol from "@arcgis/core/symbols/Symbol.js";

const Symbol = await $arcgis.import("@arcgis/core/symbols/Symbol.js");

Since

ArcGIS Maps SDK 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

• Symbol Builder

• Styles and data visualization

• Renderer

• Graphic

// 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
};