var legend = new Legend({
  view: view,
  layerInfos: [{
    layer: featureLayer,
    title: "Legend"
  }]
});

view.ui.add(legend, "bottom-right");

// typical usage
var legend = new Legend({
  view: view
});

Property Overview

Property Details

containerString|HTMLElement

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClassStringreadonly

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

destroyedBoolean

When true, this property indicates whether the widget has been destroyed.

idString

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

layerInfosObject[]

Specifies a subset of the layers to display in the legend. If this property is not set, all layers in the map will display in the legend. Objects in this array are defined with the properties listed below.

Properties:

title String optional Specifies a title for the layer to display above its symbols and descriptions. If no title is specified the service name is used.

layer Layer A layer to display in the legend.

viewMapView|SceneView

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

Method Overview

Method Details

destroy()inherited

Destroys the widget instance.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles Handle[] @type - handles to remove when destroyed

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

startup()inherited

Deprecated

• since version 4.2.

Finalizes the creation of the widget.