Interface LegendProps

These are special properties for the Legend.

interface LegendProps {
    map?: MapModel;
    showBaseLayers?: boolean;
    [key: `data-${string}`]: unknown;
}

Hierarchy (View Summary)

CommonComponentProps
MapModelProps
- LegendProps

Indexable

[key: `data-${string}`]: unknown
Arbitrary data attributes.

NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

Index

Properties

map? showBaseLayers?

Properties

`Optional`map

The map model to use.

`Optional`showBaseLayers

showBaseLayers?: boolean

Specifies whether legend for active base layer is shown in the legend UI. Defaults to false.