require(["esri/symbols"], (symbols) => { /* code goes here */ });
import * as symbols from "@arcgis/core/symbols.js";
esri/symbols
A convenience module for importing Symbol classes when developing with TypeScript. For example, rather than importing symbols one at a time like this:
import SimpleFillSymbol from "esri/symbols/SimpleFillSymbol";
import SimpleMarkerSymbol from "esri/symbols/SimpleMarkerSymbol";
You can use this module to import them on a single line:
import { SimpleFillSymbol, SimpleMarkerSymbol } from "esri/symbols";
This module also allows you to implement type guards on geometries, making your code smarter.
import { Symbol } from "esri/symbols";
function logSymbol(symbol: Symbol): void {
if (symbol.type === "simple-marker") {
// new at 4.8, the compiler knows the symbol is a SimpleMarkerSymbol
console.log("symbol color: ", symbol.color);
}
else {
// the compiler knows the symbol must be one of the other symbols
console.log("symbol type: ", symbol.type);
}
}
- See also
-
- CIMSymbol
- ExtrudeSymbol3DLayer
- FillSymbol3DLayer
- IconSymbol3DLayer
- LineSymbol3DLayer
- ObjectSymbol3DLayer
- PathSymbol3DLayer
- TextSymbol3DLayer
- WaterSymbol3DLayer
- LabelSymbol3D
- LineSymbol3D
- MeshSymbol3D
- PointSymbol3D
- PolygonSymbol3D
- Font
- PictureFillSymbol
- PictureMarkerSymbol
- SimpleFillSymbol
- SimpleLineSymbol
- SimpleMarkerSymbol
- TextSymbol
- WebStyleSymbol
Type Definitions
-
ExtrudeSymbol3DLayer
ExtrudeSymbol3DLayer ExtrudeSymbol3DLayer
Deprecated since version 4.32. Import ExtrudeSymbol3DLayer directly instead. -
ExtrudeSymbol3DLayer.
-
FillSymbol
FillSymbol PictureFillSymbol |SimpleFillSymbol
Deprecated since version 4.32. Use FillSymbol2DUnion instead. -
FillSymbol types.
-
FillSymbol3DLayer
FillSymbol3DLayer FillSymbol3DLayer
Deprecated since version 4.32. Import FillSymbol3DLayer directly instead. -
FillSymbol3DLayer.
-
IconSymbol3DLayer
IconSymbol3DLayer IconSymbol3DLayer
Deprecated since version 4.32. Import IconSymbol3DLayer directly instead. -
IconSymbol3DLayer.
-
LabelSymbol3D
LabelSymbol3D LabelSymbol3D
Deprecated since version 4.32. Import LabelSymbol3D directly instead. -
LabelSymbol3D.
-
LineSymbol3D
LineSymbol3D LineSymbol3D
Deprecated since version 4.32. Import LineSymbol3D directly instead. -
LineSymbol3D.
-
LineSymbol3DLayer
LineSymbol3DLayer LineSymbol3DLayer
Deprecated since version 4.32. Import LineSymbol3DLayer directly instead. -
LineSymbol3DLayer.
-
MarkerSymbol
MarkerSymbol PictureMarkerSymbol |SimpleMarkerSymbol
Deprecated since version 4.32. Use MarkerSymbol2DUnion instead. -
MarkerSymbol types.
-
MeshSymbol3D
MeshSymbol3D MeshSymbol3D
Deprecated since version 4.32. Import MeshSymbol3D directly instead. -
MeshSymbol3D.
-
ObjectSymbol3DLayer
ObjectSymbol3DLayer ObjectSymbol3DLayer
Deprecated since version 4.32. Import ObjectSymbol3DLayer directly instead. -
ObjectSymbol3DLayer.
-
PathSymbol3DLayer
PathSymbol3DLayer PathSymbol3DLayer
Deprecated since version 4.32. Import PathSymbol3DLayer directly instead. -
PathSymbol3DLayer.
-
PictureFillSymbol
PictureFillSymbol PictureFillSymbol
Deprecated since version 4.32. Import PictureFillSymbol directly instead. -
PictureFillSymbol.
-
PictureMarkerSymbol
PictureMarkerSymbol PictureMarkerSymbol
Deprecated since version 4.32. Import PictureMarkerSymbol directly instead. -
PictureMarkerSymbol.
-
PointSymbol3D
PointSymbol3D PointSymbol3D
Deprecated since version 4.32. Import PointSymbol3D directly instead. -
PointSymbol3D.
-
PolygonSymbol3D
PolygonSymbol3D PolygonSymbol3D
Deprecated since version 4.32. Import PolygonSymbol3D directly instead. -
PolygonSymbol3D.
-
SimpleFillSymbol
SimpleFillSymbol SimpleFillSymbol
Deprecated since version 4.32. Import SimpleFillSymbol directly instead. -
SimpleFillSymbol.
-
SimpleLineSymbol
SimpleLineSymbol SimpleLineSymbol
Deprecated since version 4.32. Import SimpleLineSymbol directly instead. -
SimpleLineSymbol.
-
SimpleMarkerSymbol
SimpleMarkerSymbol SimpleMarkerSymbol
Deprecated since version 4.32. Import SimpleMarkerSymbol directly instead. -
SimpleMarkerSymbol.
-
Symbol
Symbol Symbol2D3D |WebStyleSymbol
Deprecated since version 4.32. Use SymbolUnion instead. -
Symbol types.
-
Symbol2D
Symbol2D PictureFillSymbol |PictureMarkerSymbol |SimpleFillSymbol |SimpleLineSymbol |SimpleMarkerSymbol |TextSymbol |CIMSymbol
Deprecated since version 4.32. Use Symbol2DUnion instead. -
Symbol2D types.
-
Deprecated since version 4.32. Use Symbol2D3DUnion instead.
-
Symbol2D3D types.
-
Symbol3D
Symbol3D LabelSymbol3D |LineSymbol3D |MeshSymbol3D |PointSymbol3D |PolygonSymbol3D
Deprecated since version 4.32. Use Symbol3DUnion instead. -
Symbol3D types.
-
Symbol3DLayer
Symbol3DLayer ExtrudeSymbol3DLayer |FillSymbol3DLayer |WaterSymbol3DLayer |IconSymbol3DLayer |LineSymbol3DLayer |ObjectSymbol3DLayer |PathSymbol3DLayer |TextSymbol3DLayer
Deprecated since version 4.32. Use Symbol3DLayerUnion instead. -
Symbol3DLayer types.
-
TextSymbol
TextSymbol TextSymbol
Deprecated since version 4.32. Import TextSymbol directly instead. -
TextSymbol.
-
TextSymbol3DLayer
TextSymbol3DLayer TextSymbol3DLayer
Deprecated since version 4.32. Import TextSymbol3DLayer directly instead. -
TextSymbol3DLayer.
-
WaterSymbol3DLayer
WaterSymbol3DLayer WaterSymbol3DLayer
Deprecated since version 4.32. Import WaterSymbol3DLayer directly instead. -
WaterSymbol3DLayer.
-
WebStyleSymbol
WebStyleSymbol WebStyleSymbol
Deprecated since version 4.32. Import WebStyleSymbol directly instead. -
WebStyleSymbol.