@maptiler/leaflet-maptilersdk
Advanced tools
Changelog
2.0.0
Readme
This is a binding from MapTiler SDK JS/TS to the familiar Leaflet API.
MapTiler SDK JS is an extension of MapLibre GL JS, fully backward compatible, tailored for MapTiler Cloud and with plenty of extra features!
importFor the following examples, we are using the Vite vanilla JS app as a starting point.
The typical Leaflet plugin usualy adds new elements directly in the global object L and even though this API design is now a bit dated and somewhat frown uppon, we did not want to disrupt the dev experiece for those used to this. For this reason, you will need to import the plugin but not a specific object from it, as MaptilerLayer is internally added to L:
// import Leaflet and its style
import L from "leaflet";
import "leaflet/dist/leaflet.css";
// Import the Leaflet MapTiler Plugin
import "@maptiler/leaflet-maptilersdk";
// Import your custom style,
// depending on your configuration, you may have to change how this is done
import './style.css';
Then, in the Vite vanilla app, we would have to do exactely like in regular vanilla JS:
// Center the map on Manhattan, zoom level 13
const map = L.map("map").setView([40.7468, -73.98775], 13);
// Center the map on Manhattan, zoom level 13
L.marker([40.7468, -73.98775])
.bindPopup("Hello <b>Leaflet with MapTiler SDK</b>")
.addTo(map)
.openPopup();
// Create a MapTiler Layer inside Leaflet
const mtLayer = new L.MaptilerLayer({
// Get your free API key at https://cloud.maptiler.com
apiKey: "YOUR_MAPTILER_API_KEY",
}).addTo(map);
If you would rather stick to more modern API design and do not feel like using the L object, we got you covered:
import { MaptilerLayer } from "@maptiler/leaflet-maptilersdk";
// ...
const mtLayer = new MaptilerLayer( options );
Some frontend frameworks always are very opinionated regarding Server-Side-rendering and will attemp to perform it, that's the case of Next.js. But Leaflet does not play well with it because there are some direct calls to the global window object, and this would crash on a server. The fix consists in importing Leaflet dynamically, and then @maptiler/leaflet-maptilersdk can also be imported.
The React lifecycle method .componentDidMount() of a class component is only called on the frontend so this is why we have decided to dynamically import from there, but feel free to adapt your code if you are using a function component or a non-React app:
componentDidMount() {
// assuming this was init with React.createRef()
const container = this.mapContainer.current;
// A self-callable async function because importing packages dynamically is an async thing to do
(async () => {
// dynamic import of Leaflet
const L = await import('leaflet');
// dynamic import of the library
const leafletmaptilersdk = await import('@maptiler/leaflet-maptilersdk');
// Creating the Leaflet map
const map = L.map(container).setView([51.505, -0.09], 10);
// Creating the MapTiler Layer
const mtLayer = new leafletmaptilersdk.MaptilerLayer({
apiKey: "YOUR_API_KEY",
}).addTo(map);
})()
}
The UDM leaflet-maptilersdk bundle is not package with Leaflet nor with MapTiler SDK, so those will have to be imported as <script> separately as follow in the <head> HTML element:
<!-- Leaflet -->
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.3/dist/leaflet.css" />
<script src="https://unpkg.com/leaflet@1.9.3/dist/leaflet.js"></script>
<!-- MapTiler SDK -->
<script src="https://cdn.maptiler.com/maptiler-sdk-js/latest/maptiler-sdk.umd.js"></script>
<link href="https://cdn.maptiler.com/maptiler-sdk-js/latest/maptiler-sdk.css" rel="stylesheet" />
<!-- Leaflet plugin for MapTiler SDK Layers -->
<script src="../build/leaflet-maptilersdk.umd.js"></script>
Then, in the HTML <body>, decalre the container that will host the map:
<div id="map"></div>
Finally, add a <script> to initialize the Leaflet Map that contains a MapTiler SDK Layer:
// Center the map on Manhattan, zoom level 13
const map = L.map('map').setView([40.7468, -73.98775], 13);
// Add a marker with a popup
L.marker([40.7468, -73.98775])
.bindPopup("Hello <b>Leaflet with MapTiler SDK</b>!<br>Whoa, it works!")
.addTo(map)
.openPopup();
// Create a MapTiler Layer inside Leaflet
const mtLayer = L.maptilerLayer({
// Get your free API key at https://cloud.maptiler.com
apiKey: "YOUR_MAPTILER_API_KEY",
}).addTo(map);
The notation L.maptilerLayer is the typical Leaflet way to expose a factory function that creates a layer. Though, our plugin exposes other ways to do exactely the same thing but that may suit your programming style better.
The following are all yielding the same result:
const mtLayer = L.maptilerLayer( options )const mtLayer = new L.MaptilerLayer( options ) (mind the upper case M)const mtLayer = leafletmaptilersdk.maptilerLayer( options )const mtLayer = new leafletmaptilersdk.MaptilerLayer( options ) (mind the upper case M)The option object passed to the factory function maptilerLayer or to the constructor MaptilerLayer is then passed to the constructor of the Maptiler SDK Map class. Read more about the possible options on our SDK documentation.
Here are the major options:
geolocate: [boolean] if true, will locate the user and center the map accordingly. Note that Leaflet still requires the use of .setView() but this will be ignored. Default: false.language: [string] by default is using the language from the system settings, and falls back to local names. Yet the language can be enforced with one from the list below. Depending on how you are importing, you could use L.MaptilerLanguage.ENGLISH, MaptilerLanguage.ENGLISH or leafletmaptilersdk.MaptilerLanguage.ENGLISH. style: [string | style definition] MapTiler has created many professional-looking styles that may suit your particular need. Directly from the constructor, you can specify the short style ID. Alternatively, a style URL or a complete style definition object can also be used. Default: L.MaptilerStyle.STREETS. Depending on how you are importing, you could use L.MaptilerStyle.STREETS, MaptilerStyle.STREETS or leafletmaptilersdk.MaptilerStyle.STREETS.
L.MaptilerStyle.STREETS, reference style for navigation and city exploration
L.MaptilerStyle.STREETS.DARK (variant)L.MaptilerStyle.STREETS.LIGHT (variant)L.MaptilerStyle.STREETS.PASTEL (variant)L.MaptilerStyle.SATELLITE reference style satellite and airborne imagery (no variants)L.MaptilerStyle.HYBRID reference style satellite and airborne imagery with labels (no variants)L.MaptilerStyle.OUTDOOR reference style for adventure
L.MaptilerStyle.OUTDOOR.DARK (variant)L.MaptilerStyle.WINTER reference style for winter adventure
L.MaptilerStyle.WINTER.DARK (variant)L.MaptilerStyle.DATAVIZ, the perfect style for data visualization, with very little noise
L.MaptilerStyle.DATAVIZ.DARK (variant)L.MaptilerStyle.DATAVIZ.LIGHT (variant)L.MaptilerStyle.BASIC reference style for minimalist design and general purpose
L.MaptilerStyle.BASIC.DARK (variant)L.MaptilerStyle.BASIC.LIGHT (variant)L.MaptilerStyle.BRIGHT reference style for high contrast navigation
L.MaptilerStyle.BRIGHT.DARK (variant)L.MaptilerStyle.BRIGHT.LIGHT (variant)L.MaptilerStyle.BRIGHT.PASTEL (variant)L.MaptilerStyle.TOPO reference style for topographic study
L.MaptilerStyle.TOPO.SHINY (variant)L.MaptilerStyle.TOPO.PASTEL (variant)L.MaptilerStyle.TOPO.TOPOGRAPHIQUE (variant)L.MaptilerStyle.VOYAGER reference style for stylish yet minimalist maps
L.MaptilerStyle.VOYAGER.DARK (variant)L.MaptilerStyle.VOYAGER.LIGHT (variant)L.MaptilerStyle.VOYAGER.VINTAGE (variant)L.MaptilerStyle.TONER reference style for very high contrast stylish maps
L.MaptilerStyle.TONER.BACKGROUND (variant)L.MaptilerStyle.TONER.LITE (variant)L.MaptilerStyle.TONER.LINES (variant)L.MaptilerStyle.OPENSTREETMAP reference style for the classic OSM lookL.MaptilerStyle.OCEAN reference style with seabed isoline, hilshading and trenches infoYou can also create your custom styles on cloud.maptiler.com/maps
apiKey: [string] your MapTiler Cloud API key. Default: empty stringThe MaptilerLayer constructor and/or maptilerLayer factory function returns a Leaflet Maptiler layer, that we will call mtLayer.
.addTo(map)Same behavior as .addTo on any Leaflet layer: this adds the layer to a given
map or group.
.getMaptilerMap(): maptilerLayer.MapReturns mapltilersdk.Map object.
.getContainer(): HTMLDivElementReturns layer's DOM container div.
.getCanvas(): HTMLCanvasElementReturns maptilerLayer.Map canvas.
.getSize(): L.PointReturns layer size in pixels including padding.
.getBounds(): L.LatLngBoundsReturns layer bounds including padding.
.getPaneName(): stringReturns the pane name set in options if it is a valid pane, defaults to tilePane.
.setStyle(s)Update the style with a style ID, style URL or a style definition. The easiest is to use a built-in style ID such as listed above with the form L.MaptilerStyle.STREETS.
.setLanguage(l)Update the map language. For this, the best is to use a built-in language shorthand with the form L.MaptilerLanguage.JAPANESE, such as listed above.
We have added an even easier way to use the MapTiler SDK vector layer helpers, directed under the instance of the custom Leaflet layer. You can now call .addPolyline, .addPolygon, .addPoint and .addHeatmap using a path to a file or the ID of a dataset hosted on MapTiler Cloud.
Let's see an example:
// Init the map
const map = L.map('map').setView([46.3796, 6.1518], 13);
// Creating and mounting the MapTiler SDK Layer
const mtLayer = new L.MaptilerLayer({
apiKey: "YOUR_API_KEY",
style: L.MaptilerStyle.BACKDROP.DARK,
}).addTo(map);
// The custom event "ready" is triggered by the MaptilerLayer when the internal
// MapTiler Map instance is fully loaded and can be added more layers
mtLayer.on("ready", () => {
// Leverage the MapTiler SDK layer helpers to easily add polyline / point / polygon / heatmap layers
mtLayer.addPolyline({
// A Maptiler Cloud dataset ID, or URL to GeoJSON/GPX/KML
data:"74003ba7-215a-4b7e-8e26-5bbe3aa70b05",
lineColor: "#008888", // optional
outline: true, // optional
outlineWidth: 2, // optional
});
})
Here is the result, a bike ride in France and Switzerlanld, displayed on the dark Backdrop MapTiler style:
"ready"The "ready" event is triggered when the internal MapTiler SDK Map instance is fully loaded and can accept some more layers to be added. This corresponds to the MapTiler SDk and MapLibre load event.
Please use the issue tracker to report any bugs or file feature requests.
ISC © MapTiler
FAQs
Vector tiles basemap plugin for Leaflet - multi-lingual basemaps using MapTiler SDK
The npm package @maptiler/leaflet-maptilersdk receives a total of 466 weekly downloads. As such, @maptiler/leaflet-maptilersdk popularity was classified as not popular.
We found that @maptiler/leaflet-maptilersdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.