Show raster image on the map

This tutorial provides step-by-step instructions on how to incorporate a raster image overlay onto the map.

NPM module setup

Install the npm package.
```
 npm install --save @maptiler/sdk
```

Include the CSS file.

If you have a bundler that can handle CSS, you can import the CSS


 import "@maptiler/sdk/dist/maptiler-sdk.css";

or include it with a <link /> in the head of the document via the CDN


 <link href='https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css' rel='stylesheet' />

Include the following code in your JavaScript file (Example: app.js).


 import * as maptilersdk from '@maptiler/sdk';

 maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
 const map = new maptilersdk.Map({
   container: 'map', // container's id or the HTML element to render the map
   style: maptilersdk.MapStyle.STREETS,
      
   center: [4.64086758, 50.9001362], // starting position [lng, lat]
   zoom: 17, // starting zoom
      
 });

Replace YOUR_MAPTILER_API_KEY_HERE with your own API key. Make sure to secure the key before you publish it.
The next is up to you. You can center your map wherever you desire (modifying the starting position) and set an appropriate zoom level (modifying the starting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating the source URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application.
Add event handler for map load event. You will add code to create an image source and image layer in this handler.
```
 map.on('load', function() {
    
 });
```

Create image source. Here you can get the example image aerial_wgs84.png


 map.on('load', function() {
     map.addSource("aerial-source", {
         "type": "image",
         "url": "img/aerial_wgs84.webp",
         "coordinates": [
             [4.639663696289062, 50.900867668253724],
             [4.642066955566406, 50.900867668253724],
             [4.642066955566406, 50.89935199434383],
             [4.639663696289062, 50.89935199434383]
         ]
     });
 });

Add the image layer


 map.addLayer({
     "id": "overlay",
     "source": "aerial-source",
     "type": "raster",
     "paint": {
         "raster-opacity": 0.85
     }
 });

Basic JavaScript setup

Copy the following code, paste it into your favorite text editor, and save it as a .html file.


 <!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <title>Display a raster image</title>
   <script src="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.umd.min.js"></script>
   <link href="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css" rel="stylesheet" />
   <style>
     body { margin: 0; padding: 0; }
     #map { position: absolute; top: 0; bottom: 0; width: 100%; }
   </style>
 </head>
 <body>
   <div id="map"></div>
   <script>
       maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';      
       const map = new maptilersdk.Map({
         container: 'map', // container's id or the HTML element to render the map
         style: maptilersdk.MapStyle.STREETS,
            
         center: [4.64086758, 50.9001362], // starting position [lng, lat]
         zoom: 17, // starting zoom
            
       });
   </script>
 </body>
 </html>

Replace YOUR_MAPTILER_API_KEY_HERE with your own API key. Make sure to secure the key before you publish it.
The next is up to you. You can center your map wherever you desire (modifying the starting position) and set an appropriate zoom level (modifying the starting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating the source URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application.
Add event handler for map load event. You will add code to create an image source and image layer in this handler.
```
 map.on('load', function() {
    
 });
```

Create image source. Here you can get the example image aerial_wgs84.png


 map.on('load', function() {
     map.addSource("aerial-source", {
         "type": "image",
         "url": "img/aerial_wgs84.webp",
         "coordinates": [
             [4.639663696289062, 50.900867668253724],
             [4.642066955566406, 50.900867668253724],
             [4.642066955566406, 50.89935199434383],
             [4.639663696289062, 50.89935199434383]
         ]
     });
 });

Add the image layer


 map.addLayer({
     "id": "overlay",
     "source": "aerial-source",
     "type": "raster",
     "paint": {
         "raster-opacity": 0.85
     }
 });

Complete source code

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title>Display a raster image</title>
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.umd.min.js"></script>
    <link href="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css" rel="stylesheet" />
    <style>
        body {
            margin: 0;
            padding: 0;
        }

        #map {
            position: absolute;
            top: 0;
            bottom: 0;
            width: 100%;
        }
    </style>
</head>
<body>
    <div id="map"></div>
    <script>
        maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
        const map = new maptilersdk.Map({
            container: 'map', // container's id or the HTML element to render the map
            style: maptilersdk.MapStyle.STREETS,
            center: [4.64086758, 50.9001362], // starting position [lng, lat]
            zoom: 17, // starting zoom
        });
        map.on('load', function() {
            map.addSource("aerial-source", {
                "type": "image",
                "url": "./aerial_wgs84.png",
                "coordinates": [
                    [4.639663696289062, 50.900867668253724],
                    [4.642066955566406, 50.900867668253724],
                    [4.642066955566406, 50.89935199434383],
                    [4.639663696289062, 50.89935199434383]
                ]
            });
            map.addLayer({
                "id": "overlay",
                "source": "aerial-source",
                "type": "raster",
                "paint": {
                    "raster-opacity": 0.85
                }
            });
        });
    </script>
</body>
</html>