Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: LegendLayer
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/LegendLayer"], function(LegendLayer) { /* code goes here */ });
Description
(Added at v3.0)
Define layer properties for the legend layers associated with a PrintTemplate.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new LegendLayer() | Creates a new LegendLayer object. |
Properties
| Name | Type | Summary |
|---|---|---|
| layerId | String | The id of the operational layer to include in the printout's legend. |
| subLayerIds | String[] | The ids of the sublayers to include in the printout's legend. |
Constructor Details
Creates a new LegendLayer object.
Sample:
require([
"esri/tasks/LegendLayer", ...
], function(LegendLayer, ... ) {
var legendLayer = new LegendLayer();
...
});
Property Details
<String
StringThe id of the operational layer to include in the printout's legend.
Sample:
legendLayer.layerId = "Boundaries";
<String[]
String[]The ids of the sublayers to include in the printout's legend.
Sample:
legendLayer.subLayerIds = [0, 5];