LegendProperties | @types/arcgis-js-api

Hierarchy

WidgetProperties
- LegendProperties

Index

Properties

Optional activeLayerInfos

activeLayerInfos: CollectionProperties<ActiveLayerInfoProperties>

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

Optional basemapLegendVisible

basemapLegendVisible: boolean

Indicates whether to show the Basemap layers in the Legend.

Optional container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Optional headingLevel

headingLevel: number

Indicates the heading level to use for the legend title.

Optional iconClass

iconClass: string

The widget's default CSS icon class.

Optional id

id: string

The unique ID assigned to the widget when the widget is created.

Optional label

label: string

The widget's label.

Optional layerInfos

layerInfos: LegendLayerInfos[]

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

Optional respectLayerVisibility

respectLayerVisibility: boolean

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

Optional style

style: string | LegendStyle

Indicates the style of the legend.

Optional view

view: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" })

A reference to the MapView or SceneView.

Optional viewModel

viewModel: LegendViewModelProperties

The view model for this widget.

Optional visible

visible: boolean

Indicates whether the widget is visible.