LegendLayer

AMD: require(["esri/rest/support/LegendLayer"], (LegendLayer) => { /* code goes here */ });
ESM: import LegendLayer from "@arcgis/core/rest/support/LegendLayer";
Class: esri/rest/support/LegendLayer
Inheritance: LegendLayer Accessor
Since: ArcGIS API for JavaScript 4.20

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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

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

more detailsLegendLayer
String[]more details

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

more detailsLegendLayer
Stringmore details

The title of the feature layer.

more detailsLegendLayer

Property Details

declaredClass Stringreadonly inherited

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

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.

title String

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor

Method Details

own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.