mapsgl

MapsGL JavaScript SDK

The MapsGL JavaScript SDK (@xweather/mapsgl) renders weather and custom map data client-side in WebGL, layered on top of Mapbox GL, MapLibre GL, Google Maps, or Leaflet. It requires an active Xweather account with Weather API + Maps access (client id + secret).

This skill is the web-based JavaScript SDK. For a native Swift app on iOS, iPadOS, Mac Catalyst, or visionOS, use the mapsgl-apple skill instead — a separate SDK with a Swift API (MapboxMapController, WeatherService.LayerCode), its own install channels, and a smaller layer set. The concepts below transfer; none of the code does. MapsGL ships for Android as well.

Always qualify the name as the MapsGL JavaScript SDK. Xweather ships an unrelated product simply called the JavaScript SDK (https://www.xweather.com/docs/javascript-sdk), so the bare term is ambiguous. Xweather's own naming for the family is MapsGL, MapsGL iOS, and MapsGL Android; "MapsGL JavaScript SDK" is the unambiguous way to name this one.

How to write MapsGL code examples

Default to a single self-contained HTML file using vanilla JavaScript and the CDN build. One file the user can save and open in a browser — CDN <script>/<link> tags, a <div> for the map, and a plain <script> block. No build step, no bundler, no package installs, no framework.

In that form, MapsGL lives on the global aerisweather.mapsgl namespace:

const account = new aerisweather.mapsgl.Account('CLIENT_ID', 'CLIENT_SECRET');
const controller = new aerisweather.mapsgl.MapboxMapController(map, { account });

Look up the current released version before writing any example. Don't reuse a version from memory or from an earlier turn — MapsGL ships often, and a stale pin is the most common thing to go wrong in otherwise-correct example code:

curl -s https://www.xweather.com/docs/api/releases/versions \
  | python3 -c 'import json,sys; print(json.load(sys.stdin)["products"]["mapsgl"]["version"])'