Interface LegendSink

What the kernel calls on the legend.

interface LegendSink {
    isAvailable(): boolean;
    loadLayerLegend(
        layerId: string | undefined,
        styleId: string | undefined,
        layerConfig: LegendLayerConfig,
    ): void;
    setLayerVisibility(layerId: string, visible: boolean | undefined): void;
}

Index

Methods

isAvailable loadLayerLegend setLayerVisibility

Methods

isAvailable

isAvailable(): boolean
true once the legend is initialised — a call before would land nowhere.

Returns boolean
- Defined in packages/core/src/kernel/shared/legend-slot.ts:31

loadLayerLegend

loadLayerLegend(
    layerId: string | undefined,
    styleId: string | undefined,
    layerConfig: LegendLayerConfig,
): void
Loads and shows the legend of a layer, for one of its styles.
Parameters
- layerId: string | undefined
- styleId: string | undefined
- layerConfig: LegendLayerConfig
Returns void
- Defined in packages/core/src/kernel/shared/legend-slot.ts:33

setLayerVisibility

setLayerVisibility(layerId: string, visible: boolean | undefined): void
Shows or hides a layer's entry.
Parameters
- layerId: string
- visible: boolean | undefined
Returns void
- Defined in packages/core/src/kernel/shared/legend-slot.ts:39

Interface LegendSink

Index

Methods

Methods

isAvailable

Returns boolean

loadLayerLegend

Parameters

Returns void

setLayerVisibility

Parameters

Returns void

Settings

On This Page