Property Overview

Property Details

color Colorautocast inherited

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 String

The symbol type.

For LineSymbol the type is always "simple-line".

width Numberautocast

Autocasts from Number|String

The width of the symbol in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:0.75

Examples:

// width in points
symbol.width = 4;

// width in pixels
symbol.width = "2px";

// width in points
symbol.width = "4pt";

Method Overview

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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}inherited

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.