Skip to main content

Interface: GeoVisLegendProps

Defined in: react/GeoVisLegend.tsx:124

Properties

breaks?

optional breaks?: number[]

Defined in: react/GeoVisLegend.tsx:135

Quantitative legend breaks provided by the caller (already computed externally). When omitted, the component falls back to colorBy.thresholds from the spec so the legend stays in sync with the painted map without duplicating the threshold list at the call site. Pass an explicit empty array ([]) to force the single-bin "All values" rendering regardless of any thresholds declared in the spec.


className?

optional className?: string

Defined in: react/GeoVisLegend.tsx:139

Optional CSS class for the legend container.


formatValue?

optional formatValue?: (value) => string

Defined in: react/GeoVisLegend.tsx:137

Optional formatter for quantitative break labels.

Parameters

ParameterType
valuenumber

Returns

string


legendId

legendId: string

Defined in: react/GeoVisLegend.tsx:126

Id of the legend entry to render (resolved from spec.legends or layer.legends).