@2gis/mapgl
    TypeScript icon, indicating that this package has built-in type declarations

    1.28.0 • Public • Published

    @2gis/mapgl

    Async loader for 2gis MapGL API with typings.

    Browser usage only!

    Installation

    $ npm install @2gis/mapgl
    

    Usage

    import { load } from '@2gis/mapgl';
    // or const { load } = require('@2gis/mapgl');
    
    async function start() {
        const mapglAPI = await load();
    
        // container — id of the div element in your html
        const map = new mapglAPI.Map('container', {
            center: [55.31878, 25.23584],
            zoom: 13,
            key: 'Your API access key',
        });
    
        const marker = new mapglAPI.Marker(map, {
            coordinates: [55.31878, 25.23584],
        });
    }
    
    start();

    Without await/async:

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

    By default, latest version of MapGL API will be loaded (https://mapgl.2gis.com/api/js). But you can specify certain version of MapGL API to load:

    load('https://mapgl.2gis.com/api/js/v1.4.2').then((mapglAPI) => {});

    Checkout our release notes for MapGL API. Important to note, mapgl loader version is not equal to MapGL API version, cause it has its own features.

    mapgl namespace

    @2gis/mapgl exports load function and global.d.ts file which you can reference to have access to mapgl typings.

    To use types from mapgl namespace you need:

    1. Add reference to node_modules/@2gis/mapgl/global.d.ts in your project.d.ts
    2. Or reference in a module, where load function is imported
    /// <reference path="node_modules/@2gis/mapgl/global.d.ts" />

    You can use typings for MapGL from mapgl namespace like this:

    let marker: mapgl.Marker

    Checkout example for more information.

    Keywords

    none

    Install

    npm i @2gis/mapgl

    DownloadsWeekly Downloads

    1,941

    Version

    1.28.0

    License

    BSD-2-Clause

    Unpacked Size

    71.1 kB

    Total Files

    43

    Last publish

    Collaborators

    • kuznetcoff
    • trufi
    • artem.malko
    • itanka9
    • alxart
    • vitaliy.gis