symbols

require(["esri/symbols"], function(symbols) { /* code goes here */ });
Object: esri/symbols
Since: ArcGIS API for JavaScript 4.8

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 = require("esri/symbols/SimpleFillSymbol");
import SimpleMarkerSymbol = require("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);
  }
}

API Reference search results

NameTypeModule
Loading...