require(["esri/tasks/support/LegendLayer"], function(LegendLayer) { /* code goes here */ });
Class: esri/tasks/support/LegendLayer
Inheritance: LegendLayer Accessor
Since: ArcGIS API for JavaScript 4.1

Define layer properties for the legend layers associated with a PrintTemplate.

Constructors

new LegendLayer(properties)

Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The id of the operational layer to include in the printout's legend.

more details
more detailsLegendLayer
String[]

The ids of the sublayers to include in the printout's legend.

more details
more detailsLegendLayer
String

The title of the feature layer.

more details
more detailsLegendLayer

Property Details

declaredClassStringreadonly inherited

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

layerIdString

The id of the operational layer to include in the printout's legend.

subLayerIdsString[]

The ids of the sublayers to include in the printout's legend.

titleString

The title of the feature layer. Use this property to modify feature layer name in the legend for the printout.

API Reference search results

NameTypeModule

There were no match results from your search criteria.