import "@arcgis/map-components/components/arcgis-legend";
The Legend component describes the symbols used to represent layers in a map.
Demo
Properties
Property | Attribute | Type |
---|---|---|
| ||
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
activeLayerInfos: Collection<ActiveLayerInfo>
Collection of ActiveLayerInfo objects used by the legend view to display data in the legend.
autoDestroyDisabled
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
basemapLegendVisible: boolean
Indicates whether to show the Basemap layers in the Legend.
- Attribute
- basemap-legend-visible
- Default value
- false
headingLevel
headingLevel: number
Indicates the heading level to use for the legend title.
- Attribute
- heading-level
- Default value
- 3
hideLayersNotInCurrentView
hideLayersNotInCurrentView: boolean
When true
, layers will only be shown in the legend if
they are visible in the view's extent.
- Attribute
- hide-layers-not-in-current-view
- Default value
- false
icon
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"
layerInfos
layerInfos: Array<LegendLayerInfos>
Specifies a subset of the layers to display in the legend.
legendStyle
legendStyle: LegendStyle | string
Indicates the style of the legend.
- Attribute
- legend-style
- Default value
- "classic"
position
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
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
respectLayerDefinitionExpression
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.
- Attribute
- respect-layer-definition-expression
- Default value
- false
respectLayerVisibilityDisabled
respectLayerVisibilityDisabled: boolean
Determines whether to respect the properties of the layers in the map that
control the legend's visibility (minScale
, maxScale
, legendEnabled
).
- Attribute
- respect-layer-visibility-disabled
- Default value
- false
state
state: "disabled" | "ready"
The view model's state.
- Attribute
- state
- Default value
- "disabled"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state"; } | |
undefined |