# @2gis/mapgl 中文文档

规范地址：https://npmcn.com/package/%402gis/mapgl/

版本：1\.80\.0
npm 元数据更新时间：2026-10-28T14:35:21.682Z
中文译文更新时间：2026-11-05T20:23:02.712Z
软件包许可：BSD-2-Clause

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%402gis/mapgl
原文对照：https://npmcn.com/package/%402gis/mapgl/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：136 kB，48 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：1 个
- 首次发布：2020-05-08T11:16:35.995Z
- 最新版本发布：2026-10-28T14:35:21.190Z
- 近 30 天下载量：29240（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：119（近 12 个月 18 个）

## 中文简介

带有打字功能的 MapGL API 脚本加载器

## 安装

```sh
npm install @2gis/mapgl
```

也可以使用：`pnpm add @2gis/mapgl`、`yarn add @2gis/mapgl`、`bun add @2gis/mapgl`

## README

# @ 2gis/ 地图gl

自动加载器 [2gis 地图GL API](https://docs.2gis.com/en/mapgl/overview) 与打字.

**只浏览器使用 !**

## 安装

```
$ npm install @2gis/mapgl
```

## 使用量

```typescript
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();
```

**不等待/同步:**

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

默认, `latest` mapGL API 版本将加载(`https://mapgl.2gis.com/api/js`) (中文(简体) ). 但是,您可以指定MapGL API的某些版本来加载:

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

检查我们 [为 MapGL API 发布注释](https://docs.2gis.com/en/mapgl/overview/releases). 需要注意的是,mapgl加载器版本不等于MapGL API版本,因为它有自己的特性.

## 地图gl 命名空间

@ 2gis/ mapgl 导出 `load` 函数和 `global.d.ts` 可引用可访问映射格打字的文件.

要使用地图gl命名空间所需的类型 :

1.  在您的工程中添加节点 模块/@2gis/mapgl/global.d.ts
2.  或者在模块中引用,其中 `load` 函数被导入

```typescript
/// <reference path="node_modules/@2gis/mapgl/global.d.ts" />
```

您可以使用此地图gl 命名空间的 MapGL 输入 :

```typescript
let marker: mapgl.Marker
```

查看更多信息的示例 .

## 常见问题

### @2gis/mapgl 是什么？

带有打字功能的 MapGL API 脚本加载器

### 如何安装 @2gis/mapgl？

在项目目录运行 npm install @2gis/mapgl，或使用 pnpm add / yarn add / bun add。

### @2gis/mapgl 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @2gis/mapgl 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @2gis/mapgl 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @2gis/mapgl 可以商用吗？

@2gis/mapgl 使用 BSD-2-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @2gis/mapgl 的下载量有多少？

根据 npm 官方下载统计，@2gis/mapgl 在 2026/10/05 – 2026/11/03 这 30 天内被下载 29,240 次，日均约 975 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @2gis/mapgl 还在维护吗？

最新版本 1\.80\.0 发布于 2026/10/28（10 天前）；至今共发布 119 个版本，其中过去 12 个月发布了 18 个；首次发布于 2020/05/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。