Skip To Content

Legend widget

The Legend widget displays labels and symbols for layers in the scene. It supports FeatureLayer, SceneLayer, MapImageLayer, and TileLayer. The legend automatically updates when the visibility of a layer or sublayer changes.


Currently 3D symbols with more than one symbol layer are not supported, and the size in volumetric 3D symbols, such as polygon extrusion, is not depicted by the Legend widget. See JSAPI Legend for more information.

Configuring the Legend widget

The Legend widget can be set to open automatically when an app starts. To do so, click the dot on the widget to turn it dark green.

There is no configuration for the Legend widget.

Using the Legend widget

The following steps explain how to use the Legend widget:

  1. When the app starts, click the Legend widget to display the legend panel.
  2. Click the X button in the upper right corner of the panel to close it.