@maptiler/sdk
Version:
The Javascript & TypeScript map SDK tailored for MapTiler Cloud
1,207 lines (951 loc) • 85 kB
Markdown
<p align="center">
<a href="https://docs.maptiler.com/sdk-js/">official page →</a><br>
<img src="images/maptiler-sdk-logo.svg" width="400px">
</p>
<p align="center" style="color: #AAA">
The Javascript & TypeScript map SDK tailored for <a href="https://www.maptiler.com/cloud/">MapTiler Cloud</a>
</p>
<p align="center">
<img src="images/JS-logo.svg" width="20px">
<img src="images/TS-logo.svg" width="20px">
<img src="https://img.shields.io/npm/v/@maptiler/sdk"></img>
<img src="https://img.shields.io/twitter/follow/maptiler?style=social"></img>
</p>
# What and why?
The **MapTiler SDK JS** extends MapLibre GL JS, exposes all its features, and adds new ones on top. The SDK is designed to work with the well-established [MapTiler Cloud service](https://www.maptiler.com/cloud/), which provides all the data required to fuel a complete web mapping experience: vector tiles, satellite raster tiles, DEM with Terrain RGB, custom styles with an editor, etc.
**Why are we creating a new SDK?** To make things simpler for developers working in the MapTiler ecosystem! With **MapTiler SDK JS**, there is no need to load external plugins for the most basic things, copy-paste complex data source URLs, or look up the syntax to enable 3D terrain every time you start a project. All this is built-in, loaded when needed, or exposed with simple functions. Under the hood, this SDK is opinionated as it's being fed by [MapTiler Cloud](https://www.maptiler.com/cloud/) data, but its MapLibre core makes it 100% compatible with other sources.
In addition, the MapTiler SDK JS provides well-documented and easy-to-use wrapper functions to the [MapTiler Cloud API services](https://docs.maptiler.com/cloud/api) such as: geocoding, static maps, geolocation, as well as a search engine for coordinate reference systems and transforming coordinates from one CRS to another.
> 📣 *__Note:__* If you need <ins>only the API Client library</ins> to use in a headless fashion and without any map display, check out [MapTiler Client JS](https://github.com/maptiler/maptiler-client-js) library for browser and NodeJS.
# Install
```shell
npm install --save @maptiler/sdk
```
⚠️ Please keep in mind that if you use any additional [MapTiler modules](https://docs.maptiler.com/sdk-js/modules/), you must update them to a version that supports MapTiler SDK JS v3.
# API documentation
In addition to the details and examples provided in this readme, check out the [complete API documentation](https://docs.maptiler.com/sdk-js/api/)
# Quick start
## With ES modules
**Recommended for:** advanced applications
```ts
import { config, Map } from '@maptiler/sdk';
// Add your MapTiler Cloud API key to the config
// (Go to https://cloud.maptiler.com/account/keys/ to get one for free!)
config.apiKey = 'YOUR_API_KEY';
// Let's say you have a DIV ready to receive a map
const mapContainer = document.getElementById('my-container-div');
// Instantiate the map
const map = new Map({
container: mapContainer,
});
```
Alternatively, the `apiKey` can be set as Map option instead of in the `config` object. Yet, this will still internally propagate to the `config` object:
```ts
import { Map } from '@maptiler/sdk';
// Let's say you have a DIV ready to receive a map
const mapContainer = document.getElementById('my-container-div');
// Instantiate the map
const map = new Map({
container: mapContainer,
apiKey: 'YOUR_API_KEY'
});
```
By default, the map will be initialized with the style [streets-v2](https://www.maptiler.com/maps/#style=streets-v2).
Depending on the framework and environment you are using for your application, you will have to also include the CSS file.
For example, with a [NextJS](https://nextjs.org/) app, this can take place at the top of the file `_app.ts/js`:
```ts
import "@maptiler/sdk/dist/maptiler-sdk.css";
```
### TypeScript
The SDK is fully typed, but it may happen that types defined in Maplibre GL JS are not visible in your project. This is a known issue that comes from Maplibre being a CommonJS bundle.
There are mainly two ways to address this issue and access to the complete type definition.
1. **With `esModuleInterop`**
Set the following in your `tsconfig.json`:
```js
{
"compilerOptions": {
// ...
"esModuleInterop": true,
}
}
```
2. **With `moduleResolution`**
Set the following in your `tsconfig.json`:
```js
{
"compilerOptions": {
// ...
"moduleResolution": "Bundler",
}
}
```
Note that this second option is not always possible as some frameworks and other dependencies won't let you use the "Bundler" mode.
## With CDN
The SDK hosted on our CDN is bundled as *[Universal Module Definition](https://github.com/umdjs/umd)* (UMD) to make it standalone and contain all its dependencies. The CDN also serves the style sheet (CSS).
**Recommended for:** simple map integration example and demos
```html
<html>
<head>
<title>MapTiler JS SDK example</title>
<style>
html, body {
margin: 0;
}
#map-container {
position: absolute;
width: 100vw;
height: 100vh;
}
</style>
<!-- Load the SDK CSS -->
<link rel="stylesheet" href="dist/maptiler-sdk.css">
</head>
<body>
<div id="map-container"></div>
<script src ="dist/maptiler-sdk.umd.min.js"></script>
<script>
// Add your MapTiler Cloud API key to the config
// (Go to https://cloud.maptiler.com/account/keys/ to get one for free!)
maptilersdk.config.apiKey = 'YOUR_API_KEY';
const mapContainer = document.getElementById('my-container-div');
const map = new maptilersdk.Map({
container: mapContainer,
style: maptilersdk.MapStyle.STREETS_DARK,
hash: true,
})
</script>
</body>
</html>
```
Check out the minimalist code samples in the [demos](demos) directory.
# Many styles to choose from
MapTiler teams maintain a few styles that we have decided to expose from the SDK. This has two advantages:
- they are easier to remember, no need to type along style URL
- if we make an update to a style, you will benefit from it without modifying your codebase
Here is how it works:
```ts
import { Map, MapStyle } from '@maptiler/sdk'
// When instanciating a map
const map = new Map({
container: document.getElementById("my-container-div"),
style: MapStyle.OUTDOOR, // <-- the shorthand for the outdoor style
});
// Or later on, updating the style
map.setStyle(MapStyle.STREETS.DARK);
```
The styles with a shorthand provided by the SDK are the following:
| ID | Screenshot | Comment |
|:-:|:-:|:-:|
|`MapStyle.STREETS`|[](https://www.maptiler.com/maps/#style=streets-v2&mode=2d&position=12.52/40.73676/-73.98418)|The classic default style, perfect for urban areas.<p>Also available in **dark** and **light** mode.</p>|
|`MapStyle.DATAVIZ.DARK`| [](https://www.maptiler.com/maps/#style=dataviz-dark&mode=2d&position=2.01/38.7/-27.0)|A minimalist style for data visualization.<p>Also available in **color** and **light** mode</p> |
|`MapStyle.SATELLITE`|[](https://www.maptiler.com/maps/#style=hybrid&mode=2d&position=7.87/24.518/-77.411)|Only high resolution satellite raster tiles without any labels|
|`MapStyle.HYBRID`|[](https://www.maptiler.com/maps/#style=hybrid&mode=2d&position=9.4/-26.175/122.6631)|Satellite tile with labels, landmarks, roads ways and political borders|
|`MapStyle.OUTDOOR`|[](https://www.maptiler.com/maps/#style=outdoor&mode=2d&position=11.96/46.02591/7.7273)|A solid hiking companion, with peaks, parks, isolines and more|
|`MapStyle.BASIC`|[](https://www.maptiler.com/maps/#style=basic-v2&mode=2d&position=13.09/37.78734/-122.42025)|A minimalist alternative to `STREETS`, with a touch of flat design.<p>Also available in **dark** and **light** and **pastel** mode.</p>|
<details>
<summary>Know more about built-in map styles</summary>
MapTiler provides some **reference styles** as well as some **variants** for each. A **reference style** sets some guidelines about what kind of information is displayed, the granularity of the information, and more generally defines a purpose for which this style is the most relevant: street navigation, outdoor adventure, minimalist dashboard, etc. Then, each **reference style** offers a range of **variants** that contain the same level of information and have the same purpose but use different color schemes.
Here is the full list:
- `MapStyle.STREETS`, reference style for navigation and city exploration
- `MapStyle.STREETS.DARK` (variant)
- `MapStyle.STREETS.LIGHT` (variant)
- `MapStyle.STREETS.PASTEL` (variant)
- `MapStyle.SATELLITE` reference style satellite and airborne imagery (no variants)
- `MapStyle.HYBRID` reference style satellite and airborne imagery with labels (no variants)
- `MapStyle.OUTDOOR` reference style for adventure
- `MapStyle.WINTER` reference style for winter adventure
- `MapStyle.DATAVIZ`, the perfect style for data visualization, with very little noise
- `MapStyle.DATAVIZ.DARK` (variant)
- `MapStyle.DATAVIZ.LIGHT` (variant)
- `MapStyle.BACKDROP`, great style for data visualization when hillshading matters!
- `MapStyle.BACKDROP.DARK` (variant)
- `MapStyle.BACKDROP.LIGHT` (variant)
- `MapStyle.BASIC` reference style for minimalist design and general purpose
- `MapStyle.BASIC.DARK` (variant)
- `MapStyle.BASIC.LIGHT` (variant)
- `MapStyle.BRIGHT` reference style for high-contrast navigation
- `MapStyle.BRIGHT.DARK` (variant)
- `MapStyle.BRIGHT.LIGHT` (variant)
- `MapStyle.BRIGHT.PASTEL` (variant)
- `MapStyle.TOPO` reference style for topographic study
- `MapStyle.TOPO.SHINY` (variant)
- `MapStyle.TOPO.PASTEL` (variant)
- `MapStyle.TOPO.TOPOGRAPHIQUE` (variant)
- `MapStyle.VOYAGER` reference style for stylish yet minimalist maps
- `MapStyle.VOYAGER.DARK` (variant)
- `MapStyle.VOYAGER.LIGHT` (variant)
- `MapStyle.VOYAGER.VINTAGE` (variant)
- `MapStyle.TONER` reference style for very high contrast stylish maps
- `MapStyle.TONER.BACKGROUND` (variant)
- `MapStyle.TONER.LITE` (variant)
- `MapStyle.TONER.LINES` (variant)
- `MapStyle.OCEAN` reference style with bathymetric highlights, does not have any variants.
- `MapStyle.LANDSCAPE` reference style terrain map for data overlays and visualisations
- `MapStyle.LANDSCAPE.DARK` (variant)
- `MapStyle.LANDSCAPE.VIVID` (variant)
- `MapStyle.AQUARELLE` reference style watercolor map for creative use
- `MapStyle.AQUARELLE.DARK` (variant)
- `MapStyle.AQUARELLE.VIVID` (variant)
- `MapStyle.OPENSTREETMAP` (reference style, this one does not have any variants)
All reference styles (instances of `ReferenceMapStyle`) and style variants (instances of `MapStyleVariant`) have methods to know the alternative styles and variants that belong to the same reference style (`.getVariants()`). This is handy to provide a default/dark/light alternative color scheme, yet preserving the same level of details as in the reference style. Read more about about [ReferenceMapStyle](https://docs.maptiler.com/sdk-js/api/map-styles/#referencemapstyle) and [MapStyleVariant](https://docs.maptiler.com/sdk-js/api/map-styles/#mapstylevariant).
</details>
___
You can also use classic styles with just a *string* if you know their MapTiler Cloud ID:
```ts
map.setStyle('outdoor-v2');
```
And finally, you can use your own custom styles designed with [our style editor](https://cloud.maptiler.com/maps/). Every custom style is given a unique ID, for instance: `c912ffc8-2360-487a-973b-59d037fb15b8`.
This ID can be provided as such:
```ts
map.setStyle("c912ffc8-2360-487a-973b-59d037fb15b8");
```
Or in its extended form:
```ts
map.setStyle("https://api.maptiler.com/maps/c912ffc8-2360-487a-973b-59d037fb15b8/style.json");
// this could be suffixed with the API token as well
```
And can even be provided in the URI form:
```ts
map.setStyle("maptiler://c912ffc8-2360-487a-973b-59d037fb15b8");
```
# Globe or Mercator projection?
The **Web Mercator projection** [*(Wikipedia)*](https://en.wikipedia.org/wiki/Web_Mercator_projection) has been the go-to standard in cartography since the early days or web mapping. Partly for technical reasons but also because it is great for navigation as well as for showing the entire world in one screen, with no hidden face. That being said, Mercator's heavy distorsion at high latitudes, as well a the discontinuity at the poles can be a limitation for data visualization and has been critisized for providing a biased view of the world.
The **globe projection**, available starting from MapTiler SDK v3, does not suffer from these biases and can feel overall more playfull than Mercator. It can be a great choice for semi-global data visualization, especially for data close to the poles, thanks to its geographic continuity.
| Mercator projection | Globe projection |
| :--------: | :-------: |
|  |  |
The choice between Mercator and Globe can be done at different levels and moments in the lifecycle of the map, yet, unless stated otherwise, **Mercator remains the default**.
- In the style, using the `projection` top-level property.
For globe:
```js
{
"version": ...,
"id": ...,
"name": ...,
"sources": ...,
"layers": ...,
// Make the style use the globe projection at load time
"projection": {
"type": "globe"
}
// ...
}
```
or for Mercator:
```js
{
"version": ...,
"id": ...,
"name": ...,
"sources": ...,
"layers": ...,
// Make the style use the mercator projection at load time
"projection": {
"type": "mercator"
}
// ...
}
```
- In the constructor of the `Map` class, using the `projection` option. For globe:
```ts
const map = new maptilersdk.Map({
container: "map",
projection: "globe", // Force a globe projection
});
```
or for Mercator:
```ts
const map = new maptilersdk.Map({
container: "map",
projection: "mercator", // Force a mercator projection
})
```
This will overwrite the `projection` property from the style (if any) and will persist it later if the map style was to change.
- Use the built-in methods:
```ts
map.enableGlobeProjection();
// or
map.enableMercatorProjection();
```
The projection setter built in Maplibre GL JS is also usable:
```ts
map.setProjection({type: "mercator"});
// or
map.setProjection({type: "globe"});
```
- Using the `MaptilerProjectionControl`. Not mounted by default, it can easily be added with a single option in the `Map` constructor:
```ts
const map = new maptilersdk.Map({
container: "map",
projectionControl: true, // or the position such as "top-left", "top-right",
}); // "bottom-right" or "bottom-left"
```
This dedicated control will show a globe icon <img src="images/screenshots/globe_icon.png" width="30px"/> to transition from Mercator to globe projection and will show a flat map icon <img src="images/screenshots/mercator_icon.png" width="30px"/> to transition from globe to Mercator projection. The chosen projection persist with future style changes.
## Field of view (FOV)
The internal camera has a default vertical field of view [*(wikipedia)*](https://en.wikipedia.org/wiki/Field_of_view) of a wide ~36.86 degrees. In globe mode, such a large *FOV* reduces the amount of the Earth that can be seen at once and exaggerates the central part, comparably to a fisheye lens. In many cases, a narrower *FOV* is preferable. Here is how to update if:
```ts
// Ajust de FOV, with values from 1 to 50
map.setVerticalFieldOfView(10);
```
> 📣 *__Note:__* with the Mercator projection, it is possible to set a FOV of `0`, which yields a true orthographic projection [*(wikipedia)*](https://en.wikipedia.org/wiki/Orthographic_projection), but the globe projection does not allow this.
Here is a table of FOV comparison:
| 01° | 10° | 20° | 30° | 40° | 50° |
| :--------: | :-------: |:-------: |:-------: |:-------: |:-------: |
|  |  |  |  |  |  |
## Globe screenshots
> 📣 *__Note:__* Terrain is not fully compatible with the globe projection yet so it's better to disable it at low zoom level (from afar) and to choose the Mercator projection at higher zoom level (from up close).
# Centering the map on visitors
It is sometimes handy to center the map on the visitor's location, and there are multiple ways of doing it but for the SDK, we have decided to make this extra simple by using the [IP geolocation](#%EF%B8%8F%EF%B8%8F-geolocation) API provided by [MapTiler Cloud](https://docs.maptiler.com/cloud/api/geolocation/), directly exposed as a single option of the `Map` constructor. There are two strategies:
1. `POINT`: centering the map on the actual visitor location, optionally using the `zoom` option (zoom level `13` if none is provided). As a more precise option, if the user has previously granted access to the browser location (more precise) then this is going to be used.
2. `COUNTRY`: fitting the map view on the bounding box of the visitor's country. In this case, the `zoom` option, if provided, will be ignored
Here is how the map gets centered on the visitor's location:
```js
new maptilersdk.Map({
// ... other options
geolocate: maptilersdk.GeolocationType.POINT
})
```
Here is how the map fits the visitor's country bounds:
```js
new maptilersdk.Map({
// ... other options
geolocate: maptilersdk.GeolocationType.COUNTRY
})
```
The `geolocation` options will not be taken into consideration in the following cases:
- if the `center` option is provided, then it prevails
- if the `hash` option is provided with the value `true` **AND** a location hash is already part of the URL. If `hash` is `true` but there is not yet a location hash in the URL, then the geolocation will work.
> 📣 *__Note:__* if none of the options `center` or `hash` is provided to the `Map` constructor, then the map will be centered using the `POINT` strategy, unless the `geolocate` has the value `false`.
> 📣 *__Note 2:__* the term *IP geolocation* refers to finding the physical location of a computer using its *IP address*. The *IP address* is a numerical identifier of a computer within a network, just like the phone number for a telephone. The *IP geolocation* is **not** using the GPS of a device and usually provides a precision in the order of a few hundred meters. This precision may vary based on many local parameters such as the density of the network grid or the terrain, this is why it is generally better not to use a zoom level higher than `14`.
# Easy to add controls
The term "control" is commonly used for all sorts of buttons and information displays that take place in one of the corners of the map area. The most well-known are probably the `[+]` and `[-]` zoom buttons as well as the attribution information. Plenty of others are possible and we have made a few easy to add and directly accessible from the `Map` constructor options:
- `navigationControl`
- Shows the `[+]`, `[-]` and tilt/bearing/compass buttons
- a boolean or a corner position. Showing on the top-right by default. Hidden if `false`.
- `geolocateControl`
- Shows an arrow-shaped locate button. When clicked, it adds a marker and centers the map. If clicked again, the marker disappears (unless the map was moved since first clicked)
- a boolean or a corner position. Showing on the top-right by default. Hidden if `false`.
- `terrainControl`
- Shows a button to enable/disable the 3D terrain (does not tilt the map)
- a boolean or a corner position. Hidden by default, showing on top-right if `true`.
- `scaleControl`
- Shows a distance scale. The unit (`"metric"`, `"imperial"` or `"nautical"`) can be set in the config object `config.unit` (default: `"metric"`)
- a boolean or a corner position. Hidden by default, showing on bottom-right if `true`.
- `fullscreenControl`
- Shows a button that toggles the map into fullscreen
- a boolean or a corner position. Hidden by default, showing on top-right if `true`.
The corner positions possible are:
- `"top-left"`
- `"top-right"`
- `"bottom-left"`
- `"bottom-right"`
**Example:**
```ts
import { Map } from "@maptiler/sdk";
const map = new Map({
container: document.getElementById("my-container-div"),
terrainControl: false,
scaleControl: true,
fullscreenControl: "top-left",
})
```
# 🧩 Custom Controls
MapTiler SDK JS supports two flexible ways to add custom controls to your map interface. Whether you're building a dynamic application or integrating with static HTML, there's a matching approach for both.
## Programmatic Controls
Use `map.addControl()` with `MaptilerExternalControl` to register custom UI elements manually. This approach is ideal for dynamic logic, event-driven behavior, or integration with frameworks like React. The control element can be provided either as a reference to the **element itself**, or as its **CSS selector**. Optionally, two callback functions can be provided:
* `onClick` function that is called when the element is clicked, and
* `onRender` function that is called every time the map renders a new state.
Both callbacks receive the active `Map` instance, the associated control element itself, and an event object associated with the original event (`PointerEvent` and `MapLibreEvent` respectively).
### Example
```ts
const panControl = new maptilersdk.MaptilerExternalControl(
".pan-control",
(map) => map.panBy([10, 10]), // Move southeast on click
(map, el) => el.classList.toggle( // Style based on hemisphere
"northern-hemisphere", map.getCenter().lat > 0
)
);
map.addControl(panControl);
const element = document.createElement("button");
element.textContent = "Pan NW";
map.addControl(
new maptilersdk.MaptilerExternalControl(
element,
(map) => map.panBy([-10, -10]) // Move northwest
),
"top-left"
);
```
### Behavior Overview
- On add, control element is moved into the map UI
- `onClick` binds user interaction
- `onRender` enables state-based styling or logic
- Control maintains its own DOM context
- On removal, element is returned to its original DOM position (if any) to not interfere with DOM handling of frameworks like React
## Declarative Controls
Add controls using HTML attributes – no JavaScript required. This is perfect for simple UI setups.
### Enabling Detection
```ts
const map = new maptilersdk.Map({
container: "map",
customControls: true, // or ".custom-ui"
});
```
You can pass `true` to enable detection globally, or a CSS selector to scope it.
### Declaring Controls
Use `data-maptiler-control` attribute:
```html
<button data-maptiler-control="zoom-in">+</button>
```
Supported values:
| Value | Description |
|---------------------|--------------------------------------------------|
| `zoom-in` | Zooms in |
| `zoom-out` | Zooms out |
| `toggle-projection` | Switches Mercator ↔ Globe |
| `toggle-terrain` | Toggles terrain layer |
| `reset-view` | Resets bearing, pitch, and roll |
| `reset-bearing` | Resets bearing only |
| `reset-pitch` | Resets pitch only |
| `reset-roll` | Resets roll only |
| *(empty)* | Registers control without built-in functionality |
> ⚠️ An error is thrown if an unrecognized value is used.
### Grouping Controls
Use `data-maptiler-control-group` to group buttons:
```html
<div data-maptiler-control-group>
<button data-maptiler-control="zoom-in">+</button>
<button data-maptiler-control="zoom-out">−</button>
</div>
```
Groups are styled and positioned together but don't add functionality themselves. Functional behavior is attached to valid descendant elements.
### Positioning Controls
Use `data-maptiler-position` to set placement:
```html
<button data-maptiler-control="reset-view" data-maptiler-position="top-left">↻</button>
<div data-maptiler-control-group data-maptiler-position="bottom-right">
<button data-maptiler-control="zoom-in">+</button>
<button data-maptiler-control="zoom-out">−</button>
</div>
```
Valid positions: `'top-left'`, `'top-right'`, `'bottom-left'`, `'bottom-right'`
## Styling with CSS Variables
When declarative controls are enabled, the map container exposes dynamic CSS variables:
| Variable | Description | Type |
|----------------------------------|--------------------------------------------------|-----------------|
| `--maptiler-center-lng` | Longitude of center | unitless number |
| `--maptiler-center-lat` | Latitude of center | unitless number |
| `--maptiler-zoom` | Zoom level | unitless number |
| `--maptiler-bearing` | Map rotation | unitless number |
| `--maptiler-pitch` | Pitch angle | unitless number |
| `--maptiler-roll` | Roll angle | unitless number |
| `--maptiler-is-globe-projection` | `true` if globe is active<br>`false` otherwise | string |
| `--maptiler-has-terrain` | `true` if terrain is active<br>`false` otherwise | string |
### Example
```css
.compass-icon {
transform: rotateX(calc(var(--maptiler-pitch) * 1deg))
rotateZ(calc(var(--maptiler-bearing) * -1deg));
}
@container style(--maptiler-is-globe-projection: true) {
.projection-icon {
content: "globe";
}
}
```
# 3D terrain in one call
<p align="center">
<img src="images/screenshots/grandcanyon.gif" width="48%"></img>
<img src="images/screenshots/alps.gif" width="48%"></img>
</p>
Do you want to enable 3D terrain? That's easy now with a single function call:
```ts
// With the default exaggeration factor of 1
map.enableTerrain();
// Or, if you want to boost some volume a little
map.enableTerrain(1.5);
```
The terrain can also be enabled directly from the `Map` constructor, with the options `terrain` (a boolean, `false` by default) and `terrainExaggeration` (a number, `1` by default):
```ts
const map = new Map({
// some options...
terrain: true,
terrainExaggeration: 1.5,
})
```
At any point, you can modify the exaggeration factor:
```ts
map.setTerrainExaggeration(2);
```
Or simply disable it:
```ts
map.disableTerrain()
```
> 📣 *__Note:__* Keep in mind that setting an exaggeration factor at `0` will result in the same result as disabling the elevation but that terrain RGB tiles will still be fetched in the background.
> 📣 *__Note 2:__* please be aware that due to the volume and elevation of the map floor in 3D space, the navigation with the terrain enabled is slightly different than without.
By default, enabling, disabling or even just updating the terrain exaggeration will result in a 1-second animation. This is possible to modify with the following `Map` method:
```ts
// Duration in milliseconds
map.setTerrainAnimationDuration(500);
```
## Terrain events
- `"terrain"` event
As an extension of Maplibre GL JS, MapTiler SDK is also exposing the terrain event `"terrain"`. This event is triggered when a terrain source is added or removed:
```ts
map.on("terrain", (e) => {
// your logic here
})
```
Since MapTiler SDK adds animation and the terrain data is necessary all along, the `"terrain"` event will be called at the very beginning of the terrain animation when enabling and at the very end when disabling.
- `"terrainAnimationStart"` and `"terrainAnimationStop"` events
With the animation of the terrain, it can sometimes be convenient to know when the animation starts and ends. These two events are made just for that, here are how they work:
```ts
map.on("terrainAnimationStart", (event) => {
console.log("Terrain animation is starting...");
});
map.on("terrainAnimationStop", (event) => {
console.log("Terrain animation is finished");
});
```
The `event` argument is an object that contains (among other things) a `terrain` attribute. In the case of `"terrainAnimationStop"`, this terrain attribute is `null` if the animation was about disabling the terrain, otherwise, this is just a propagation of `map.terrain`.
In the following example, we decide to associate the terrain animation with a change of camera, e.g. from clicking on the terrain control:
- when the terrain is enabled, it pops up with an animation and only **then** the camera is animated to take a lower point of view
- when the terrain is disabled, it is flattened with an animation and only **then** the camera is animated to a top view
```ts
map.on("terrainAnimationStop", (e) => {
map.easeTo({
pitch: e.terrain ? 60 : 0,
duration: 500,
});
});
```
# Halo and Space Options
The `halo` and `space` options allow for enhanced visual customization of the map, especially for globe projections.
## `halo` (Atmospheric Glow)
The `halo` option adds a gradient-based atmospheric glow around the globe, simulating the visual effect of Earth's atmosphere when viewed from space.
### Usage:
You can enable a simple halo by setting it to `true`:
```ts
const map = new maptilersdk.Map({
container: document.getElementById("map"),
style: maptilersdk.MapStyle.OUTDOOR,
halo: true,
});
```
For more customization, you can define a radial gradient with scale and stops:
```ts
const map = new maptilersdk.Map({
container: document.getElementById("map"),
style: maptilersdk.MapStyle.OUTDOOR,
halo: {
scale: 1.5, // Controls the halo size
stops: [
[0.2, "transparent"],
[0.2, "red"],
[0.4, "red"],
[0.4, "transparent"],
[0.6, "transparent"],
[0.6, "red"],
[0.8, "red"],
[0.8, "transparent"],
[1.0, "transparent"],
],
},
});
```
You can also set the halo dynamically after the map loads:
```ts
map.on("load", () => {
map.setHalo({
scale: 2,
stops: [
[0.0, "rgba(135,206,250,1)"],
[0.5, "rgba(0,0,250,0.75)"],
[0.75, "rgba(250,0,0,0.0)"],
],
});
});
```
To disable state transitions for halo or space:
```ts
map.disableHaloAnimations();
map.disableSpaceAnimations();
```
## `space` (Background Environment)
The space option allows customizing the background environment of the globe, simulating deep space or skybox effects.
### Usage
You can enable a simple space background with a solid color:
```ts
const map = new maptilersdk.Map({
container: document.getElementById("map"),
style: maptilersdk.MapStyle.OUTDOOR,
space: {
color: "#111122", // Dark space-like color
},
});
```
Alternatively, you can provide a cubemap for a space backround using one of the following methods:
#### Predefined Presets:
- `space`: Dark blue hsl(210, 100%, 4%) background and white stars (transparent background image). Space color changes the background color, stars always stay white.
- `stars` (default): Black background (image mask), space color changes the stars color, background always stays black.
- `milkyway`: Black half-transparent background with standard milkyway and stars. Space color changes the stars and milkyway color, background always stays black.
- `milkyway-subtle`: Black half-transparent background with subtle milkyway and less stars. Space color changes the stars and milkyway color, background always stays black.Black half-transparent background with standard milkyway and stars. Space color changes the stars and milkyway color, background always stays black.
- `milkyway-bright`: Black half-transparent background with bright milkyway and more stars. Space color changes the stars and milkyway color, background always stays black.
- `milkyway-colored`: Full background image with natural space colors. Space color doesn’t change anything (non transparent image).
```ts
const map = new maptilersdk.Map({
container: document.getElementById("map"),
style: maptilersdk.MapStyle.OUTDOOR,
space: {
preset: "space",
},
});
```
#### Cubemap Images (Custom Skybox):
```ts
const map = new maptilersdk.Map({
container: document.getElementById("map"),
style: maptilersdk.MapStyle.OUTDOOR,
space: {
faces: {
nX: '/path-to-image/nX.png',
nY: '/path-to-image/nY.png',
nZ: '/path-to-image/nZ.png',
pX: '/path-to-image/pX.png',
pY: '/path-to-image/pY.png',
pZ: '/path-to-image/pZ.png',
},
},
});
```
#### Cubemap Path with image format
This fetches all images from a path, this assumes all files are named px, nx, py, ny, pz, nz and suffixed with the appropriate extension specified in `format`.
```ts
const map = new maptilersdk.Map({
container: document.getElementById("map"),
style: maptilersdk.MapStyle.OUTDOOR,
space: {
path: {
baseUrl: "spacebox/transparent",
format: "png", // Defaults to PNG
},
},
});
```
#### Set the space background dynamically:
```ts
map.on("load", () => {
map.setSpace({
color: "red",
path: {
baseUrl: "spacebox/transparent",
},
});
});
```
Note: if `space.color` or `space.<faces | path | preset>` are not explicitly set in the call to `setSpace`, then the previous value will remain for this field.
Further code examples can be found in `~/demos/`
# `ImageViewer`
MapTiler's `ImageViewer` component allows you to display tiled, non-georeferenced images but interact with them in almost the same way you would if you were displaying map. These can be handy for zoomable non-georeferenced, geographically "inaccurate" maps such as hotel maps, golf courses, theme parks etc. Think pixels instead of lattitudes and longtidues.
```ts
export type ImageViewerConstructorOptions = {
imageUUID: string; // the unique UUID of the image object you are displaying
center?: [number, number]; // the center you want the viewer to init on, defaults to the center of the image.
container: string | HTMLElement // the container element you want to mount the viewer on
apiKey: string; // your MapTiler API Key
zoom?: number;
maxZoom?: number;
minZoom?: number;
bearing?: number;
debug?: boolean; // whether you want to debug the tiles
};
const imageViewer = new ImageViewer({
container: document.getElementById("map")!, // the container element you want to use
apiKey: "YOUR_MAPTILER_API_KEY", // your api key
imageUUID: "11111111-2222-3333-4444-555555555555", // unique UUID of the image object
// ...other options, see below
}: ImageViewerConstructorOptions);
await imageViewer.onReadyAsync()
// OR
imageViewer.on("imageviewerready", () => { console.log('Ready!') })
```
## Methods
`ImageViewer` provides a subset of methods for interaction with the map. A major caveat is that the `ImageViewer` component works in pixels and not in LngLat. Thus, when using methods such as `setCenter` or `flyTo` the pixel values provided refer to the _absolute pixel position_ on the image, not screen pixel position.
Imagine your image is 10,000px x 10,000px, if regardless if your zoom is 2 or 4, calling `.setCenter(500,500)` will always position the viewer over the same part of the image.
For full details on supported methods see the type declaration for `ImageViewer` or visit the (docs)[https://docs.maptiler.com/sdk-js/examples/image-viewer/].
## Events
In a similar manner, a subset of map events are fired by the image viewer. All UI interaction events that would normally include a `LngLat` in the event data instead receive an `imageX` and `imageY` field, representing an absolute pixel position of the image. This is same for `flyTo`, `jumpTo`, `panTo` etc.
A full list of supported events can be found in the exported type declaration `ImageViewerEventTypes`
## Markers with `ImageViewerMarker`
An `ImageViewerMarker` can also be added and used like the usual `Marker`class, the main difference being it operates in _image pixels_, not LngLat coordinates.
```ts
const marker = new ImageViewerMarker({ draggable: true });
marker
.setPosition([100, 100]) // position in image pixels.
.addTo(imageViewer)
.on("dragend", (e) => {
console.log("e.target.isWithinImageBounds()", e.target.isWithinImageBounds());
});
```
Full API documentation can be found in the typedocs: `npm run doc`
# Easy language switching
The language generally depends on the style but we made it possible to easily set and update from a built-in list of languages.
The built-in list of supported languages is accessible from the `Language` object:
```ts
import { Language } from "@maptiler/sdk";
```
In the UMD bundle, it will be directly at `maptilersdk.Language`.
There are three distinct ways to set the language of a map:
1. **Global way, using the config object:**
```ts
import { config } from "@maptiler/sdk";
config.primaryLanguage = Language.ENGLISH;
```
Then, if any further language setting is applied, all the map instances created afterward will use this language.
2. **Set the language at instantiation time:**
```ts
const map = new Map({
// some options...
language: Language.ENGLISH, // the ISO codes can also be used (eg. "en")
})
```
It will only apply `ENGLISH` as the language of this specific map instance (and will not alter the global `config`).
3. **Set the language after the map has been instantiated:**
```ts
map.setLanguage(Language.ENGLISH);
```
Again, it will only apply `ENGLISH` as the language of this specific map instance (and will not alter the global `config`).
The list of supported languages is built-in and can be found [here](src/language.ts). In addition, there are special language *flags*:
- `Language.AUTO` **[DEFAULT]** uses the language defined in the web browser
- `Language.STYLE_LOCK` to strictly use the language defined in the style. Prevents any further language update
- `Language.LOCAL` uses the language local to each country
- `Language.LATIN` uses a default with Latin characters
- `Language.NON_LATIN` uses a default with non-Latin characters
Whenever a label is not supported in the defined language, it falls back to `Language.LOCAL`.
Here is a sample of some compatible languages:
## Built-in support for right-to-left languages
Languages that are written right-to-left such as Arabic and Hebrew are fully supported by default. No need to install any plugins!
If you wish to opt of applying the rtl plugin or wish to use a different compatible rtl text plugin, you can pass the `rtlTextPlugin`
constructor option as either `false` (disable the rtl plugin) or a url to load a different plugin.
**Note: Once the rtlTextPlugin has been installed once, it cannot be unset nor updated on the current instance. Calling `setRTLTextPlugin` without setting `rtlTextPlugin` to false in the constuctor will result in an error.**
<p align="center">
<img src="images/screenshots/lang-arabic.jpeg" width="48%"></img>
<img src="images/screenshots/lang-hebrew.jpeg" width="48%"></img>
</p>
## Visitor language modes
The *visitor* language modes are special built-in modes made to display labels in two different languages, concatenated when available:
- `Language.VISITOR` concatenates labels in the language of your system and the *local* language
- `Language.VISITOR_ENGLISH` concatenates labels in English and the *local* language
```ts
const map = new Map({
// some options...
language: Language.VISITOR,
})
// or
const map = new Map({
// some options...
language: Language.VISITOR_ENGLISH,
})
```
We believe these two modes can be very handy to help the end users identify places, especially when the local labels are not using a latin charset. Here is how it looks like:
# Custom Events and Map Lifecycle
## Events
### The `ready` event
The `ready` event happens just after the `load` event but waits until all the controls managed by the `Map` constructor are dealt with, some having an asynchronous logic to set up.
Since the `ready` event waits until all the basic controls are nicely positioned, it is **safer** to use `ready` than `load` if you plan to add other custom controls with the `.addControl()` method.
This event works exactly the same way as `load` and you can safely replace those by `"ready"`. Here is a usage example:
```js
const map = new maptilersdk.Map({
container: "map-container",
});
map.on("ready", (evt) => {
const terrainControl = new maptilersdk.MaptilerTerrainControl();
map.addControl(terrainControl);
})
```
### The `loadWithTerrain` event
The `loadWithTerrain` event is triggered only *once* in a `Map` instance lifecycle, when both the `ready` event and the `terrain` event **with non-null terrain** are fired.
**Why a new event?**
When a map is instantiated with the option `terrain: true`, then MapTiler terrain is directly added to it and some animation functions such as `.flyTo()` or `.easeTo()` if started straight after the map initialization will actually need to wait a few milliseconds that the terrain is properly initialized before running.
Relying on the `ready` or `load` event to run an animation with a map with terrain may fail in some cases for this reason, and this is why waiting for `loadWithTerrain` is safer in this particular situation.
## Lifecycle Methods
The events `load`, `ready` and `loadWithTerrain` are both called *at most once* and require a callback function to add more elements such as markers, layers, popups and data sources. Even though MapTiler SDK fully supports this logic, we have also included a *promise* logic to provide a more linear and less nested way to wait for a Map instance to be usable. Let's compare the two ways:
- Classic: with a callback on the `load` event:
```ts
function init() {
const map = new Map({
container,
center: [2.34804, 48.85439], // Paris, France
zoom: 14,
});
// We wait for the event.
// Once triggered, the callback is ran in its own scope.
map.on("load", (evt) => {
// Adding a data source
map.addSource('my-gps-track-source', {
type: "geojson",
data: "https://example.com/some-gps-track.geojson",
});
})
}
```
- Modern: with a promise returned by the method `.onLoadAsync()`, used in an `async` function:
```ts
async function init() {
const map = new Map({
container,
center: [2.34804, 48.85439], // Paris, France
zoom: 14,
});
// We wait for the promise to resolve.
// Once triggered, the rest of the init function runs
await map.onLoadAsync();
// Adding a data source
map.addSource('my-gps-track-source', {
type: "geojson",
data: "https://example.com/some-gps-track.geojson",
});
}
```
We deployed exactly the same logic for the `loadWithTerrain` event. Let's see how the two ways compare.
- Classic: with a callback on the `loadWithTerrain` event:
```ts
function init() {
const map = new Map({
container,
center: [2.34804, 48.85439], // Paris, France
zoom: 14,
terrain: true,
});
// We wait for the event.
// Once triggered, the callback is ran in its own scope.
map.on("loadWithTerrain", (evt) => {
// make an animation
map.flyTo({
center: [-0.09956, 51.50509], // London, UK
zoom: 12.5,
})
})
}
```
- Modern: with a promise returned by the method `.onLoadWithTerrainAsync()`, used in an `async` function:
```ts
async function init() {
const map = new Map({
container,
center: [2.34804, 48.85439], // Paris, France
zoom: 14,
terrain: true,
});
// We wait for the promise to resolve.
// Once triggered, the rest of the init function runs
await map.onLoadWithTerrainAsync();
// make an animation
map.flyTo({
center: [-0.09956, 51.50509], // London, UK
zoom: 12.5,
})
}
```
And finally, the lifecycle method corresponding to the `ready` event:
- Classic: with a callback on the `ready` event:
```ts
function init() {
const map = new Map({
container,
center: [2.34804, 48.85439], // Paris, France
zoom: 14,
});
// We wait for the event.
// Once triggered, the callback is ran in its own scope.
map.on("ready", (evt) => {
// Adding a data source
map.addSource('my-gps-track-source', {
type: "geojson",
data: "https://example.com/some-gps-track.geojson",
});
})
}
```
- Modern: with a promise returned by the method `.onReadyAsync()`, used in an `async` function:
```ts
async function init() {
const map = new Map({
container,
center: [2.34804, 48.85439], // Paris, France
zoom: 14,
});
// We wait for the promise to resolve.
// Once triggered, the rest of the init function runs
await map.onReadyAsync();
// Adding a data source
map.addSource('my-gps-track-source', {
type: "geojson",
data: "https://example.com/some-gps-track.geojson",
});
}
```
We believe that the *promise* approach is better because it does not nest scopes and will allow for a linear non-nested stream of execution. It also corresponds to more modern development standards.
> 📣 *__Note:__* Generally speaking, *promises* are not a go to replacement for all event+callback and are suitable only for events that are called only once in the lifecycle of a Map instance. This is the reason why we have decided to provide a *promise* equivalent only for the `load`, `ready` and `loadWithTerrain` events but not for events that may be called multiple time such as interaction events.
### The `webglContextLost` event
The map is rendered with WebGL, that leverages the GPU to provide high-performance graphics. In some cases, the host machine, operating system or the graphics driver, can decide that continuing to run such high performance graphics is unsustainable, and will abort the process. This is called a "WebGL context loss". Such situation happens when the resources are running low or when multiple browser tabs are competing to access graphics memory.
The best course of action in such situation varies from an app to another. Sometimes a page refresh is the best thing to do, in other cases, instantiating a new Map dynamically at application level is more appropriate because it hides a technical failure to the end user. The event `webglContextLost` is exposed so that the most appropriate scenario can be implemented at application level.
Here is how to respond to a WebGL context loss with a simple page refresh:
```ts
// Init the map
const map = new maptilersdk.Map({
container: "map-container",
hash: true,
})
// Refresh the page if context is lost.
// Since `hash` is true, the location will be the same as before
map.on("webglContextLost", (e) => {
location.reload();
})
```
# Color Ramps
A color ramp is a color gradient defined in a specific interval, for instance in [0, 1], and for any value within this interval will retrieve a color. They are defined by at least a color at each bound and usually additional colors within the range.
Color ramps are super useful to represent numerical data in a visual way: the temperature, the population density, the average commute time, etc.
The SDK includes many built-in ready-to-use color ramps as well as extra logic to manipulate them and create new ones, here is the full list:
To use an already existing color ramp and access some of its values:
```ts
import { ColorRampCollection } from "@maptiler/sdk";
// The TURBO color ramp, just like all the built-ins, is defined in [0, 1],
// but we can rescale it to fit the range of temperature [-18, 38]°C (equivalent to [0, 100]F)
// and this actually creates a clone of the original TURBO
const temperatureTurbo = ColorRampCollection.TURBO.scale(-18, 38);
// What's the color at 0°C (or 32F) ?
const zeroColor = temperatureTurbo.getColor(0);
// The color is an array: [45, 218, 189, 255]
// Alternatively, we can ask for the hex color:
const zeroColorHex = temperatureTurbo.getColorHex(0);
// The color is a string: "#2ddabdff"
```
Creating a new one consists of defining all the colors for each *color stops*. The values can be in the range of interest and *do not* have to be in [0, 1]. For example, let's recreate a *Viridis* color ramp but with a range going from 0 to 100:
```ts
import { ColorRamp } from "@maptiler/sdk";
const myCustomRamp = new ColorRamp({
stops: [
{ value: 0, color: [68, 1, 84] },
{ value: 13, color: [71, 44, 122] },
{ value: 25, color: [59, 81, 139] },
{ value: 38, color: [44, 113, 142] },
{ value: 5, color: [33, 144, 141] },
{ value: 63, color: [39, 173, 129] },
{ value: 75, color: [92, 200, 99] },
{ value: 88, color: [170, 220, 50] },
{ value: 100, color: [253, 231, 37] },
]
});
```
When defining a new *ramp*, the colors can be an RGB array (`[number, number, number]`) or an RGBA array (`[number, number, number, number]`).
Many methods are available on color ramps, such as getting the `<canvas>` element of it, rescaling it,