import * as symbols from "@arcgis/core/symbols.js";
const symbols = await $arcgis.import("@arcgis/core/symbols.js");
@arcgis/core/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 "@arcgis/core/symbols/SimpleFillSymbol.js";
import SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol.js";
You can use this module to import them on a single line:
import { SimpleFillSymbol, SimpleMarkerSymbol } from "@arcgis/core/symbols.js";
This module also allows you to implement type guards on geometries, making your code smarter.
import { Symbol } from "@arcgis/core/symbols.js";
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
Type DefinitionExtrudeSymbol3DLayer ExtrudeSymbol3DLayerDeprecated since version 4.32. Import ExtrudeSymbol3DLayer directly instead. -
ExtrudeSymbol3DLayer.
-
FillSymbol
Type DefinitionFillSymbol PictureFillSymbol |SimpleFillSymbolDeprecated since version 4.32. Use FillSymbol2DUnion instead. -
FillSymbol types.
-
FillSymbol3DLayer
Type DefinitionFillSymbol3DLayer FillSymbol3DLayerDeprecated since version 4.32. Import FillSymbol3DLayer directly instead. -
FillSymbol3DLayer.
-
IconSymbol3DLayer
Type DefinitionIconSymbol3DLayer IconSymbol3DLayerDeprecated since version 4.32. Import IconSymbol3DLayer directly instead. -
IconSymbol3DLayer.
-
LabelSymbol3D
Type DefinitionLabelSymbol3D LabelSymbol3DDeprecated since version 4.32. Import LabelSymbol3D directly instead. -
LabelSymbol3D.
-
LineSymbol3D
Type DefinitionLineSymbol3D LineSymbol3DDeprecated since version 4.32. Import LineSymbol3D directly instead. -
LineSymbol3D.
-
LineSymbol3DLayer
Type DefinitionLineSymbol3DLayer LineSymbol3DLayerDeprecated since version 4.32. Import LineSymbol3DLayer directly instead. -
LineSymbol3DLayer.
-
MarkerSymbol
Type DefinitionMarkerSymbol PictureMarkerSymbol |SimpleMarkerSymbolDeprecated since version 4.32. Use MarkerSymbol2DUnion instead. -
MarkerSymbol types.
-
MeshSymbol3D
Type DefinitionMeshSymbol3D MeshSymbol3DDeprecated since version 4.32. Import MeshSymbol3D directly instead. -
MeshSymbol3D.
-
ObjectSymbol3DLayer
Type DefinitionObjectSymbol3DLayer ObjectSymbol3DLayerDeprecated since version 4.32. Import ObjectSymbol3DLayer directly instead. -
ObjectSymbol3DLayer.
-
PathSymbol3DLayer
Type DefinitionPathSymbol3DLayer PathSymbol3DLayerDeprecated since version 4.32. Import PathSymbol3DLayer directly instead. -
PathSymbol3DLayer.
-
PictureFillSymbol
Type DefinitionPictureFillSymbol PictureFillSymbolDeprecated since version 4.32. Import PictureFillSymbol directly instead. -
PictureFillSymbol.
-
PictureMarkerSymbol
Type DefinitionPictureMarkerSymbol PictureMarkerSymbolDeprecated since version 4.32. Import PictureMarkerSymbol directly instead. -
PictureMarkerSymbol.
-
PointSymbol3D
Type DefinitionPointSymbol3D PointSymbol3DDeprecated since version 4.32. Import PointSymbol3D directly instead. -
PointSymbol3D.
-
PolygonSymbol3D
Type DefinitionPolygonSymbol3D PolygonSymbol3DDeprecated since version 4.32. Import PolygonSymbol3D directly instead. -
PolygonSymbol3D.
-
SimpleFillSymbol
Type DefinitionSimpleFillSymbol SimpleFillSymbolDeprecated since version 4.32. Import SimpleFillSymbol directly instead. -
SimpleFillSymbol.
-
SimpleLineSymbol
Type DefinitionSimpleLineSymbol SimpleLineSymbolDeprecated since version 4.32. Import SimpleLineSymbol directly instead. -
SimpleLineSymbol.
-
SimpleMarkerSymbol
Type DefinitionSimpleMarkerSymbol SimpleMarkerSymbolDeprecated since version 4.32. Import SimpleMarkerSymbol directly instead. -
SimpleMarkerSymbol.
-
Symbol
Type DefinitionSymbol Symbol2D3D |WebStyleSymbolDeprecated since version 4.32. Use SymbolUnion instead. -
Symbol types.
-
Symbol2D
Type DefinitionSymbol2D PictureFillSymbol |PictureMarkerSymbol |SimpleFillSymbol |SimpleLineSymbol |SimpleMarkerSymbol |TextSymbol |CIMSymbolDeprecated since version 4.32. Use Symbol2DUnion instead. -
Symbol2D types.
-
Deprecated since version 4.32. Use Symbol2D3DUnion instead.
-
Symbol2D3D types.
-
Symbol3D
Type DefinitionSymbol3D LabelSymbol3D |LineSymbol3D |MeshSymbol3D |PointSymbol3D |PolygonSymbol3DDeprecated since version 4.32. Use Symbol3DUnion instead. -
Symbol3D types.
-
Symbol3DLayer
Type DefinitionSymbol3DLayer ExtrudeSymbol3DLayer |FillSymbol3DLayer |WaterSymbol3DLayer |IconSymbol3DLayer |LineSymbol3DLayer |ObjectSymbol3DLayer |PathSymbol3DLayer |TextSymbol3DLayerDeprecated since version 4.32. Use Symbol3DLayerUnion instead. -
Symbol3DLayer types.
-
TextSymbol
Type DefinitionTextSymbol TextSymbolDeprecated since version 4.32. Import TextSymbol directly instead. -
TextSymbol.
-
TextSymbol3DLayer
Type DefinitionTextSymbol3DLayer TextSymbol3DLayerDeprecated since version 4.32. Import TextSymbol3DLayer directly instead. -
TextSymbol3DLayer.
-
WaterSymbol3DLayer
Type DefinitionWaterSymbol3DLayer WaterSymbol3DLayerDeprecated since version 4.32. Import WaterSymbol3DLayer directly instead. -
WaterSymbol3DLayer.
-
WebStyleSymbol
Type DefinitionWebStyleSymbol WebStyleSymbolDeprecated since version 4.32. Import WebStyleSymbol directly instead. -
WebStyleSymbol.