Class LegendHelper

Index

Constructors

Methods

getWMSLegendURL getWMTSLegendURL

Constructors

constructor

new LegendHelper(): LegendHelper
Returns LegendHelper

Methods

`Static` `Readonly`getWMSLegendURL

getWMSLegendURL(
    url: undefined | string,
    layerName: string,
    options?: WMSLegendURLOptions,
): undefined | string
Get the WMS legend URL.
Parameters
- url: undefined | string
  The base url of the wms service.
- layerName: string
  The name of a wms layer.
- Optionaloptions: WMSLegendURLOptions
  to create the legend url.
Returns undefined | string
The legend URL or undefined.
- Defined in src/tools/legendhelper.ts:13

`Static` `Readonly`getWMTSLegendURL

getWMTSLegendURL(olayer: TileLayer<WMTS>): undefined | string
Retrieves the legend URL for a given WMTS tile layer.
Parameters
- olayer: TileLayer<WMTS>
  The OpenLayers tile layer object.
Returns undefined | string
The legend URL or undefined if not found.
- Defined in src/tools/legendhelper.ts:73