Interface: GeoVisLegendProps

Defined in: ui/GeoVisLegend.tsx:40

Properties

breaks?

optional breaks?: number[]

Defined in: ui/GeoVisLegend.tsx:44

Explicit break points; overrides the legend's own thresholds.

---

className?

optional className?: string

Defined in: ui/GeoVisLegend.tsx:52

Optional class applied to the legend container.

---

formatValue?

optional formatValue?: (value) => string

Defined in: ui/GeoVisLegend.tsx:50

Formats numeric bin/circle values for display. When omitted, the default is the locale formatter for choropleth/categorical legends and the compact formatter (e.g. 500k) for proportional-circle legends.

Parameters

Parameter	Type
value	number

Returns

string

---

legendId

legendId: string

Defined in: ui/GeoVisLegend.tsx:42

Id of the legend to resolve from the spec's legend registry.

---

noPositionWrap?

optional noPositionWrap?: boolean

Defined in: ui/GeoVisLegend.tsx:60

When true, renders without the absolute-positioning wrapper even if the legend declares a position. Used by GeoVisProvider to stack every legend sharing a position inside one grouped overlay container.

---

sourceNode?

optional sourceNode?: ReactNode

Defined in: ui/GeoVisLegend.tsx:54

Optional node rendered as the legend's reference/attribution footer.

---

stretch?

optional stretch?: boolean

Defined in: ui/GeoVisLegend.tsx:66

When true, the card drops its fixed width and fills its container. Used by the compact legend panel, which spans the map from side to side — without this the card would keep its own width inside that full-width panel.