ActiveLayerInfo

A collection of child activeLayerInfos. This only applies to renderers of Sublayers or the children of GroupLayers.

The CSS filter string representing the effects applied to the active layer.

Since

ArcGIS Maps SDK for JavaScript 4.7

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

When true, layers will only be shown in the legend if they are visible in the view's extent. When data from a layer is not visible in the view, the layer's legend information will be hidden.

To hide layers completely from the legend, you should set the legendEnabled property of the layer to false.

See also

• respectLayerVisibility

Indicates if the legend's display of the layer's renderer is driven by the scale of the view. This is true of Sublayer renderers, any renderer that uses a valueExpression (Arcade expression), DotDensityRenderer, and layers that have FeatureReductionLayer.featureReduction enabled.

Indicates whether cached legend responses should be preserved when the active layer info is destroyed. Preserving the cache can avoid repeating legend requests when creating another active layer info for the same layer.

The layer represented by the ActiveLayerInfo object.

The layerView represented by the ActiveLayerInfo object's layer.

The legendElements is constructed using the layer Renderer. It reflects the actual structure of the legend.

Indicates whether legend elements are currently being generated for this layer or its children.

The opacity of the layer or parent element.

The ActiveLayerInfo of the parent Sublayer or GroupLayer.

Indicates if the activeLayerInfo is ready. It is set to true when all its legendElements are computed. It is set to false when the layer renderer changes so that the legendElements can recomputed.

Indicates whether the layer's definition expression should be applied when generating legend information.

Determines whether to respect the properties of the layers in the map that control the legend's visibility (minScale, maxScale, legendEnabled). By default, a layer's legend elements will not render in the legend given the following conditions:

• The FeatureLayer.legendEnabled property is set to false.
• If the view's scale is outside the visibility range defined by the ScaleRangeLayer.minScale and ScaleRangeLayer.maxScale properties.

When the respectLayerVisibility property of the legend is set to false, the legend elements for each layer in the map will always display, thus disregarding the minScale, maxScale, and legendEnabled properties for each layer in the map.

See also

• hideLayersNotInCurrentView

The scale of the view instance in which the Legend is rendered.

Only applies if the layer is a MapImageLayer. An array of MapImageLayer Sublayer IDs for which to display legend information. For example, if a MapImageLayer contains 100 sublayers, but you want to display the legend for two sublayers, then specifying the IDs of both sublayers will allow the Legend to only display legend information for those sublayers.

The text string that represents the legend's title. This value is read from the layerInfo of the corresponding layer in the legend. If not provided, this value comes from the Layer.title.

The version of the ActiveLayerInfo. It increases by 1 whenever ready property of ActiveLayerInfo changes. This property should watched in the view for ActiveLayerInfo changes and update the DOM accordingly.

The view in which the Legend is rendered.