leaflet-wms-header
TypeScript icon, indicating that this package has built-in type declarations

1.0.13 • Public • Published

leaflet-wms-header

Custom headers on Leaflet TileLayer WMS. It's a simple plugin that allow to set custom header for WMS interface.

It works with javascript and typescript without any dependencies!

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

Javascript

$ npm install leaflet leaflet-wms-header --save
<!-- Assuming your project root is "../" -->
<script src="../node_modules/leaflet/dist/leaflet.js"></script> 
<script src="../node_modules/leaflet-wms-header/index.js"></script> 
 
// YOUR LEAFLET CODE
 
var wmsLayer = L.TileLayer.wmsHeader(
    'https://GEOSERVER_PATH/geoserver/wms?',
    {
        layers: 'ne:ne',
        format: 'image/png',
        transparent: true,
    },
    [
        { header: 'Authorization', value: 'JWT ' + MYAUTHTOKEN },
        { header: 'content-type', value: 'text/plain'},
    ],
    null
).addTo(map);

Typescript

$ npm install leaflet @types/leaflet leaflet-wms-header --save
import * as L from 'leaflet';
import 'leaflet-wms-header';
 
// YOUR LEAFLET CODE
 
let wmsLayer: L.TileLayer.WMSHeader = L.TileLayer.wmsHeader(
    'https://GEOSERVER_PATH/geoserver/wms?',
    {
        layers: layers,
        format: 'image/png',
        transparent: true,
    }, [
        { header: 'Authorization', value: 'JWT ' + MYAUTHTOKEN },
        { header: 'content-type', value: 'text/plain'},
    ],
    null
).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.

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

Dependencies (2)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i leaflet-wms-header

    Weekly Downloads

    402

    Version

    1.0.13

    License

    ISC

    Unpacked Size

    7.37 kB

    Total Files

    6

    Last publish

    Collaborators

    • ticinum-aerospace