Add a custom halo around the globe

Use the halo option in the map constructor to create a custom halo. You can define a radial gradient with scale and stops to add a custom atmospheric glow around the globe.

This option only takes effect when used in conjunction with the projection: 'globe' parameter.


npm install --save @maptiler/sdk

main.js

import { Map, MapStyle, config } from '@maptiler/sdk';
import '@maptiler/sdk/dist/maptiler-sdk.css';

config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
const map = new Map({
  container: 'map', // container's id or the HTML element in which the SDK will render the map
  style: MapStyle.HYBRID,
  projection: "globe",
  halo: {
    scale: 1.5, // Halo size in multiples of the Earth's radius
    stops: [
      [0.0, "rgba(135,206,250,1)"],
      [0.5, "rgba(0,0,250,0.75)"],
      [0.75, "rgba(250,0,0,0.0)"],
    ],
  }
});

index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="robots" content="noindex">
  <title>Add a custom halo around the globe | NPM example</title>
  <link rel="stylesheet" href="./style.css">
</head>
<body>
  <div id="map"></div>
  <script type="module" src="./main.js"></script>
</body>
</html>

style.css

body {
  margin: 0;
  padding: 0;
}

#map {
  position: absolute;
  top: 0;
  bottom: 0;
  width: 100%;
}

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8" />
  <title>Globe with halo</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 in which the SDK will render the map
      style: maptilersdk.MapStyle.HYBRID,
      projection: "globe",
      halo: {
        scale: 1.5, // Halo size in multiples of the Earth's radius
        stops: [
          [0.0, "rgba(135,206,250,1)"],
          [0.5, "rgba(0,0,250,0.75)"],
          [0.75, "rgba(250,0,0,0.0)"],
        ],
      }
    });
  </script>
</body>

</html>