DynamicWorkspaceLayer | References | ArcGIS Maps SDK for JavaScript

import DynamicWorkspaceLayer from "@arcgis/core/rest/layerSources/DynamicWorkspaceLayer.js";

const DynamicWorkspaceLayer = await $arcgis.import("@arcgis/core/rest/layerSources/DynamicWorkspaceLayer.js");

Inheritance: DynamicWorkspaceLayer→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

A dynamic workspace layer references a pre-authored ArcGIS Pro layer file (.lyrx) stored in a registered folder. It allows a map service to use the layer's advanced renderer and cartographically enriched symbols, including symbols that are not supported by the map service's REST API specifications.

Use it as the source of a sublayer in a MapImageLayer, or as the dynamic data source of a FeatureLayer.

Known Limitations

Sublayers and FeatureLayers with a DynamicWorkspaceLayer source cannot be persisted to web maps, web scenes, link charts, or portal items.

See also

Example

const sublayer = new Sublayer({
  source: new DynamicWorkspaceLayer({
    workspaceId: "lyrx_folder",
    layerId: "WorldCities.lyrx"
  })
});

const layer = new MapImageLayer({
  url: "<your-map-service-url>",
  sublayers: [sublayer]
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	DynamicWorkspaceLayerProperties

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
definitionExpression	string \| null \| undefined
layerId	string
type readonly	"workspace-layer"
workspaceId	string

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.

definitionExpression

Property

Type: string | null | undefined

A SQL where clause used to filter the features in the layer. Only features that satisfy the expression will be displayed.

layerId

Property

Type: string

The lyrx file name with extension.

type

readonly Property

Type: "workspace-layer"

This value is always workspace-layer.

workspaceId

Property

Type: string

The registered workspace id.

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.