New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

mapbox-gl

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

mapbox-gl

A WebGL interactive maps library

0.24.0
Source
npm

Version published: 8 years ago

Weekly downloads: 0; decreased by-100%

Maintainers: 43

Weekly downloads

Created: 10 years ago

What is mapbox-gl?

The mapbox-gl npm package is a powerful library for interactive, customizable maps and geospatial data visualization. It leverages WebGL to render maps from vector tiles and allows for dynamic styling and interactivity.

What are mapbox-gl's main functionalities?

Display a Map

This code initializes a basic map using Mapbox GL JS. It sets the map container, style, center coordinates, and zoom level.

const mapboxgl = require('mapbox-gl');
mapboxgl.accessToken = 'your-access-token';
const map = new mapboxgl.Map({
  container: 'map',
  style: 'mapbox://styles/mapbox/streets-v11',
  center: [-74.5, 40],
  zoom: 9
});

Add a Marker

This code adds a marker to the map at the specified longitude and latitude coordinates.

const marker = new mapboxgl.Marker()
  .setLngLat([-74.5, 40])
  .addTo(map);

Add a Popup

This code creates a popup with a text message and attaches it to a specific location on the map.

const popup = new mapboxgl.Popup({ offset: 25 })
  .setText('Hello, World!')
  .setLngLat([-74.5, 40])
  .addTo(map);

Draw a Polygon

This code draws a polygon on the map by defining its coordinates and adding it as a layer when the map loads.

const polygon = {
  'type': 'Feature',
  'geometry': {
    'type': 'Polygon',
    'coordinates': [
      [
        [-74.5, 40],
        [-74.5, 41],
        [-73.5, 41],
        [-73.5, 40],
        [-74.5, 40]
      ]
    ]
  }
};
map.on('load', function () {
  map.addLayer({
    'id': 'polygon',
    'type': 'fill',
    'source': {
      'type': 'geojson',
      'data': polygon
    },
    'layout': {},
    'paint': {
      'fill-color': '#088',
      'fill-opacity': 0.8
    }
  });
});

Other packages similar to mapbox-gl

Mapbox GL JS

Mapbox GL JS is a Javascript & WebGL library that renders interactive maps from vector tiles and Mapbox styles.

It is part of the Mapbox GL ecosystem which includes Mapbox GL Native, a suite of compatible SDKs for native desktop and mobile applications.

Using Mapbox GL JS with a `<script>` tag

To use the vector tiles and styles hosted on http://mapbox.com, you must create an account and then obtain an access token. You may learn more about access tokens here.

<!DOCTYPE html>
<html>
<head>
    <script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.24.0/mapbox-gl.js'></script>
    <link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.24.0/mapbox-gl.css' rel='stylesheet' />
</head>

<body>
    <div id='map' style='width: 400px; height: 300px;' />

    <script>
        mapboxgl.accessToken = '<your access token here>';
        var map = new mapboxgl.Map({
            container: 'map',
            style: 'mapbox://styles/mapbox/streets-v9'
        });
    </script>
</body>
</html>

Using Mapbox GL JS with Browserify

To use the vector tiles and styles hosted on http://mapbox.com, you must create an account and then obtain an access token. You may learn more about access tokens here.

Install the mapbox-gl npm package

npm install --save mapbox-gl

Instantiate mapboxgl.Map

var mapboxgl = require('mapbox-gl');
mapboxgl.accessToken = '<your access token here>';
var map = new mapboxgl.Map({
    container: '<your HTML element id>',
    style: 'mapbox://styles/mapbox/streets-v9'
});

Using Mapbox GL JS with Webpack

To use the vector tiles and styles hosted on http://mapbox.com, you must create an account and then obtain an access token. You may learn more about access tokens here.

Install the mapbox-gl npm package and the required loaders.

npm install --save mapbox-gl
npm install --save transform-loader
npm install --save json-loader
npm install --save webworkify-webpack

Add the required additional options from webpack.config.example.js to your webpack configuration.

Instantiate mapboxgl.Map

var mapboxgl = require('mapbox-gl');
mapboxgl.accessToken = '<your access token here>';
var map = new mapboxgl.Map({
    container: '<your HTML element id>',
    style: 'mapbox://styles/mapbox/streets-v9'
});

Using import

If you're using the ES6 module system, you can import mapboxgl like so:

import mapboxgl from 'mapbox-gl';

Third Party Projects

These projects are written and maintained by the GL JS community. Feel free to open a PR add your own projects to this list. We :heart: third party projects!

Using Mapbox GL JS with CSP

You may use a Content Security Policy to restrict the resources your page has access to, as a way of guarding against Cross-Site Scripting and other types of attacks. If you do, Mapbox GL JS requires the following directives:

child-src blob: ;
img-src data: blob: ;
script-src 'unsafe-eval' ;

Requesting styles from Mapbox or other services will require additional directives. For Mapbox, you can use this connect-src setting:

connect-src https://*.tiles.mapbox.com https://api.mapbox.com

Contributing to Mapbox GL JS

See CONTRIBUTING.md.

0.24.0 (September 19 2016)

New Features & Improvements

Allow querystrings in mapbox:// URLs #3113
Allow "drag rotate" interaction to control pitch #3105
Improve performance by decreasing Worker script Blob size #3158
Improve vector tile performance #3067
Decrease size of distributed library by removing package.json #3174
Add support for new lines in text-field #3179
Make keyboard navigation smoother #3190
Make mouse wheel zooming smoother #3189
Add better error message when calling Map#queryRenderedFeatures on nonexistent layer #3196
Add support for imperial units on Scale control #3160
Add map's pitch to URL hash #3218

Bugfixes

Fix exception thrown when using box zoom handler #3078
Ensure style filters cannot be mutated by reference #3093
Fix exceptions thrown when opening marker-bound popup by click #3104
Fix bug causing fills with transparent colors and patterns to not render #3107
Fix order of latitudes in Map#getBounds #3081
Fix incorrect evaluation of zoom-and-property functions #2827 #3155
Fix incorrect evaluation of property functions #2828 #3155
Fix bug causing garbled text rendering when multiple maps are rendered on the page #3086
Fix rendering defects caused by Map#setFilter and map rotation on iOS 10 #3207
Fix bug causing image and video sources to disappear when zooming in #3010

FAQs

What is mapbox-gl?

Is mapbox-gl popular?

Is mapbox-gl well maintained?

Package last updated on 20 Sep 2016

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.

Install

mapbox-gl

What is mapbox-gl?

What are mapbox-gl's main functionalities?

Other packages similar to mapbox-gl

leaflet

openlayers

cesium

Mapbox GL JS

Using Mapbox GL JS with a <script> tag

Using Mapbox GL JS with Browserify

Using Mapbox GL JS with Webpack

Using import

Third Party Projects

Using Mapbox GL JS with CSP

Contributing to Mapbox GL JS

0.24.0 (September 19 2016)

New Features & Improvements

Bugfixes

Related posts

PyPI Now Supports iOS and Android Wheels for Mobile Python Development

Create React App Officially Deprecated Amid React 19 Compatibility Issues

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Using Mapbox GL JS with a `<script>` tag