MapGL JS API Overview

MapGL JS API is a JavaScript library that allows you to add a 2GIS map to your website or web application.

The features include:

• Add a 3D WebGL map with geodata to your website or to your web application.
• Rotate, pitch, and zoom the map using a mouse or finger gestures.
• Display floor plans for shopping centers and airports.
• Customize the appearance of the map using Map Styles.
• Display single markers and marker clusters.
• Display text labels and draw custom shapes like circles and polygons.
• Calculate and display car and pedestrian routes.
• Add tooltips and popups for map objects.
• Customize the set of map control buttons and add your own.

This article covers adding the library using the <script> mechanism. If you plan to use npm, take a look at @2gis/mapgl.

Geodata complies with OGC standards.

Getting an access key

Usage of this API requires an API key to connect to 2GIS servers and retrieve the geographical data. To obtain the key, fill out the form at dev.2gis.com.

Usage

To add MapGL JS API to your project, use the following line:

<script src="https://mapgl.2gis.com/api/js/v1"></script>

The script will add a global variable called mapgl. See the API Reference for the full list of available methods of that variable.

⚠ Use only MapGL JS API methods and fields described in the documentation. We don`t guarantee stable operation of undocumented functionality.

Creating a map

To display a map, you need to add an HTML element that will act as a container for the map:

<div id="container"></div>

Since the map will be placed inside the container, you also need to specify the size of that container:

<style>
    #container {
        width: 500px;
        height: 300px;
    }
</style>

All is left to do is to initialize the map. To do that, call the Map() method passing the id of the container and your API key. You can also pass the initial coordinates and the required zoom level. See the API Reference for the full list of map options.

const map = new mapgl.Map('container', {
    key: 'Your API access key',
    center: [55.31878, 25.23584],
    zoom: 13,
});

Adding a marker

To add a Marker to the map, call the Marker() method and pass the name of the map instance and coordinates of the marker:

const marker = new mapgl.Marker(map, {
    coordinates: [55.31878, 25.23584],
});

See the API Reference for more information on marker initialization options.

Full code example