Skip to main content

Function: GeoVisLegend()

GeoVisLegend(__namedParameters): Element | null

Defined in: ui/GeoVisLegend.tsx:288

Renders a static, non-interactive legend from the current GeoVis spec.

Resolves the active LegendSpec by legendId (top-level spec.legends first, then per-layer layer.legends) and emits one swatch per categorical mapping entry or quantitative threshold bin.

When LegendSpec.position is set the component applies CSS absolute positioning so the legend can be overlaid on the map container without coupling to the map engine. The parent element must have position: relative (or equivalent).

Designed for read-only display alongside GeoVisCanvas; it does not subscribe to pointer or hover events and therefore never re-renders on cursor activity.

Parameters

ParameterType
__namedParametersGeoVisLegendProps

Returns

Element | null