Interface ClusterRenderer`Experimental`

Cluster renderer object.

interface ClusterRenderer {
    kind: "cluster";
    legendItems(): readonly RendererLegendItem[];
    toJSON(): ClusterRendererDescriptor;
    toMapLibre(geometry: RendererGeometryType): readonly RendererLayerFragment[];
    toMapLibreSource(): Record<string, unknown>;
}

Hierarchy

RendererBase<ClusterRendererDescriptor>
- ClusterRenderer

Index

Properties

Methods

legendItems toJSON toMapLibre toMapLibreSource

Properties

`Readonly` `Experimental`kind

kind

Methods

legendItems

legendItems(): readonly RendererLegendItem[]
Experimental
Legend metadata derived from the descriptor (stable contract, REQ-005).

Returns readonly RendererLegendItem[]
Inherited from RendererBase.legendItems
- Defined in work/honua-sdk-js/honua-sdk-js/src/style/renderers.ts:110

toJSON

toJSON(): ClusterRendererDescriptor
Experimental
Serializable descriptor — rendererFromJSON(renderer.toJSON()) revives it.

Returns ClusterRendererDescriptor
Inherited from RendererBase.toJSON
- Defined in work/honua-sdk-js/honua-sdk-js/src/style/renderers.ts:108

toMapLibre

toMapLibre(geometry): readonly RendererLayerFragment[]
Experimental
Compile MapLibre layer fragments for one geometry kind. Pure and deterministic.
Parameters
- geometry: RendererGeometryType
Returns readonly RendererLayerFragment[]
Inherited from RendererBase.toMapLibre
- Defined in work/honua-sdk-js/honua-sdk-js/src/style/renderers.ts:112

toMapLibreSource

toMapLibreSource(): Record<string, unknown>
Experimental
GeoJSON source options enabling MapLibre-native clustering (cluster, clusterRadius, clusterMaxZoom, clusterProperties). Merge these into the GeoJSON source spec that feeds the layers.

Returns Record<string, unknown>
- Defined in work/honua-sdk-js/honua-sdk-js/src/style/renderers.ts:503