Legend

1
import "@arcgis/map-components/components/arcgis-legend";

The Legend component describes the symbols used to represent layers in a map.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
basemap-legend-visible
boolean
heading-level
number
hide-layers-not-in-current-view
boolean
icon
string
label
string
Array<LegendLayerInfos>
legend-style
LegendStyle | string
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
respect-layer-definition-expression
boolean
respect-layer-visibility-disabled
boolean
state
readonly
state
"disabled" | "ready"

activeLayerInfos

Property
activeLayerInfos: Collection<ActiveLayerInfo>

Collection of ActiveLayerInfo objects used by the legend view to display data in the legend.

Read more...

autoDestroyDisabled

Property
autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute
auto-destroy-disabled
Default value
false

basemapLegendVisible

Property
basemapLegendVisible: boolean

Indicates whether to show the Basemap layers in the Legend.

Read more...

Attribute
basemap-legend-visible
Default value
false

headingLevel

Property
headingLevel: number

Indicates the heading level to use for the legend title.

Read more...

Attribute
heading-level
Default value
3

hideLayersNotInCurrentView

Property
hideLayersNotInCurrentView: boolean

When true, layers will only be shown in the legend if they are visible in the view's extent.

Read more...

Attribute
hide-layers-not-in-current-view
Default value
false

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute
icon
Default value
"legend"

label

Property
label: string

The component's default label.

Attribute
label

layerInfos

Property
layerInfos: Array<LegendLayerInfos>

Specifies a subset of the layers to display in the legend.

Read more...

legendStyle

Property
legendStyle: LegendStyle | string

Indicates the style of the legend.

Read more...

Attribute
legend-style
Default value
"classic"

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

respectLayerDefinitionExpression

Property
respectLayerDefinitionExpression: boolean

If a layer uses a unique value render, only features that satisfy the layer's definition expression will be displayed in the legend when set to true.

Read more...

Attribute
respect-layer-definition-expression
Default value
false

respectLayerVisibilityDisabled

Property
respectLayerVisibilityDisabled: boolean

Determines whether to respect the properties of the layers in the map that control the legend's visibility (minScale, maxScale, legendEnabled).

Read more...

Attribute
respect-layer-visibility-disabled
Default value
false

state

readonly
Property
state: "disabled" | "ready"

The view model's state.

Read more...

Attribute
state
Default value
"disabled"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component

Returns
Promise<void>

Events

EventType
{ name: "state"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "state"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event
arcgisReady: undefined

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close