leaflet-wms-fn-header

In this version you can pass headers as a function if you need to calculate headers at runtime.

Custom Headers for Leaflet TileLayer WMS

This lightweight plugin allows you to set custom headers for the WMS interface in Leaflet.

It works seamlessly with both JavaScript and TypeScript, requiring no additional dependencies!

Fork from leaflet-wms-header

Based on https://github.com/Leaflet/Leaflet/issues/2091#issuecomment-302706529.

Javascript

1$ npm install leaflet leaflet-wms-fn-header --save

1<!-- Assuming your project root is "../" -->
2<script src="../node_modules/leaflet/dist/leaflet.js"></script> 
3<script src="../node_modules/leaflet-wms-fn-header/index.js"></script> 

1
2// YOUR LEAFLET CODE
3
4var wmsLayer = L.TileLayer.wmsHeader(
5    'https://GEOSERVER_PATH/geoserver/wms?',
6    {
7        layers: 'ne:ne',
8        format: 'image/png',
9        transparent: true,
10    },
11    [
12        { header: 'Authorization', value: 'JWT ' + MYAUTHTOKEN },
13        { header: 'content-type', value: 'text/plain'},
14    ],
15    null, // abort function
16    (err) => console.log (err) // image loading error handling function (optional)
17).addTo(map);

Headers in a function

1
2let dynamicToken = 'SOME_TOKEN_1';
3
4setTimeout(() => {
5    dynamicToken = 'SOME_TOKEN_2';
6}, 5000)
7
8var wmsLayer = L.TileLayer.wmsHeader(
9    'https://GEOSERVER_PATH/geoserver/wms?',
10    {
11        layers: 'ne:ne',
12        format: 'image/png',
13        transparent: true,
14    },
15    () => [
16        { header: 'Authorization', value: 'JWT ' + dynamicToken },
17        { header: 'content-type', value: 'text/plain'},
18    ],
19    null
20).addTo(map);

Typescript

1$ npm install leaflet @types/leaflet leaflet-wms-fn-header --save

1import * as L from 'leaflet';
2import 'leaflet-wms-fn-header';
3
4// YOUR LEAFLET CODE
5
6let wmsLayer: L.TileLayer.WMSHeader = L.TileLayer.wmsHeader(
7    'https://GEOSERVER_PATH/geoserver/wms?',
8    {
9        layers: layers,
10        format: 'image/png',
11        transparent: true,
12    }, [
13        { header: 'Authorization', value: 'JWT ' + MYAUTHTOKEN },
14        { header: 'content-type', value: 'text/plain'},
15    ],
16    null
17).addTo(map);

Abort parameter

Abort parameter allow to abort the http request through an Observable. This optimization function might be usefull to stop the http request when it is not necessary anymore, mostly if many requests are pending. An example is provided on /tests/system-tests.html .

See below an example using an Observable as "abort" parameter.

1let tileLayer: L.TileLayer.WMSHeader = L.TileLayer.wmsHeader(
2    'https://GEOSERVER_PATH/geoserver/wms?',
3    {
4        layers: layers,
5        format: 'image/png',
6        transparent: true,
7    }, [
8        { header: 'Authorization', value: 'JWT ' + MYAUTHTOKEN },
9        { header: 'content-type', value: 'text/plain'},
10    ],
11    this.abortWMSObservable$.pipe(take(1))
12);