SymbolLayerDrawing | References | ArcGIS Maps SDK for JavaScript

import SymbolLayerDrawing from "@arcgis/core/layers/support/SymbolLayerDrawing.js";

const SymbolLayerDrawing = await $arcgis.import("@arcgis/core/layers/support/SymbolLayerDrawing.js");

Inheritance: SymbolLayerDrawing→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.1

Defines the symbol layer drawing options for FeatureLayer.symbolLayerDrawing. Use symbol layer drawing to override the default drawing order of CIMSymbols on maps. When symbols have more than one symbol layer (such as a cased road symbol), symbol layer drawing can also control how those individual symbol layers are ordered across symbol classes.

Default draw order	Symbol layer drawing enabled

Symbol layer drawing is not supported in 3D scenes.

See also

ArcGIS Pro - Symbol Layer Drawing

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	SymbolLayerDrawingProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
drawOrder	string[]
enabled	boolean

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

drawOrder

Property

Type: string[]

When symbol layer drawing is enabled, this property defines the order in which symbol layers are drawn. The values correspond to the name of each symbol layer. The values in the array are drawn in the order they are listed, with the first symbol layer drawn at the top and the last symbol layer drawn at the bottom.

See also

CIMSymbolLayer.name

enabled

Property

Type: boolean

Defines whether symbol layer drawing is enabled. When enabled, symbol layers are drawn in the order specified by the drawOrder property. When disabled, symbol layers are drawn in their default order.

Default value: false

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.