📦 legend

This package provides utilities to automatically create map legends from layer definitions in a Map Context.

Installation

npm install @geospatial-sdk/legend

Usage

Rendering a legend

import { createLegendFromLayer } from "@geospatial-sdk/legend";

const layer = {
  type: "wms",
  url: "https://example.com/wms",
  name: "test-layer",
};

createLegendFromLayer(layer).then((legendDiv) => {
  document.body.appendChild(legendDiv);
});

Checking legend support

Use hasLegendSupport to check whether a layer can have a legend before attempting to render one.

import {
  hasLegendSupport,
  createLegendFromLayer,
} from "@geospatial-sdk/legend";

if (hasLegendSupport(layer)) {
  // layer is narrowed to MapContextLayerWms | MapContextLayerWmts
  createLegendFromLayer(layer).then((legendDiv) => {
    if (legendDiv) document.body.appendChild(legendDiv);
  });
}

Note: hasLegendSupport is a type-level check only. Legend generation might still return null for other reasons.

Functions

Function	Description
createLegendFromLayer	Creates a legend from a layer.
hasLegendSupport	Whether a layer type can carry a legend.