# @allmaps/leaflet 中文文档

规范地址：https://npmcn.com/package/%40allmaps/leaflet/

版本：1\.0\.0-beta\.55
npm 元数据更新时间：2026-10-01T09:24:35.843Z
中文译文更新时间：2026-11-06T05:20:02.146Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40allmaps/leaflet
原文对照：https://npmcn.com/package/%40allmaps/leaflet/?lang=original
项目主页：https://allmaps.org/
源码仓库：https://github.com/allmaps/allmaps

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

- 包体积（解压后）：155 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2022-11-30T09:39:46.897Z
- 最新版本发布：2026-09-22T07:06:57.649Z
- 近 30 天下载量：4858（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 6 个）

## 中文简介

Allmaps 叶片插件

## 安装

```sh
npm install @allmaps/leaflet
```

也可以使用：`pnpm add @allmaps/leaflet`、`yarn add @allmaps/leaflet`、`bun add @allmaps/leaflet`

## README

# @allmaps/叶片

所有地图插件 [传单](https://leafletjs.com/)。此插件允许显示地理参考 [IIIF 图像](https://iiif.io/) 在叶片地图上。 插件通过加载工作 [地理参考说明](https://iiif.io/api/georef/extension/georef/) 并使用WebGL从一个 IIIF 图像服务器上转换图像,以覆盖其正确的地理位置.

见 [页面存档备份,存于互联网档案馆 allmaps.org](https://allmaps.org/) 更多信息.

_Leaflet 的 Allmaps 插件开发由 [克拉里亚-伏尔](https://clariahvl.hypotheses.org/)。 。 。 ._ _Leaflet 的 Allmaps 插件开发由 [克拉里亚-伏尔](https://clariahvl.hypotheses.org/)。 。 。 ._

[![Example of the Allmaps plugin for Leaflet](https://raw.githubusercontent.com/allmaps/allmaps/main/packages/leaflet/example.jpg)](https://observablehq.com/@allmaps/leaflet-plugin)

实例:

-   [可观察笔记本](https://observablehq.com/@allmaps/leaflet-plugin)
-   [可观察笔记本](https://observablehq.com/@allmaps/leaflet-plugin)

## 如何运作

此插件导出类 `WarpedMapLayer` 延伸 [`L.Layer`](https://leafletjs.com/reference.html#layer)。您可以在 WardedMapLayer 中添加一个或多个地理参考说明(或包含多个地理参考说明的注释页),并在您的叶片图中添加WardedMapLayer 。 这将使《地理参考说明》所定义的所有地理参照地图都成为可能.

为了了解每个地理参考地图的引擎盖下会发生什么,请参看 [@ allmaps/ 放弃](https://npmcn.com/package/%40allmaps/render/) 软件包.

此插件执行了很多方法 [@ allmaps/ warpedmapplayer (帮助)](https://npmcn.com/package/%40allmaps/warpedmaplayer/),核心软件包集成连接 Allmaps 插件到 [@ allmaps/ 放弃](https://npmcn.com/package/%40allmaps/render/) 软件包.

## 安装

这个软件包在浏览器和Node.js中作为无害环境管理或UMD模块发挥作用.

用 pnpm 安装 :

```sh
npm install @allmaps/leaflet
```

您可以通过运行在本地建立此软件包 :

```sh
pnpm run build
```

在本地开发期间测试此软件包的最简单方法是通过 [@ allmaps/ test- plugins](https://npmcn.com/package/test/plugins/)中还包括一个最小的例子 `./index.html` 并可通过 `pnpm run dev`。 。 。 .

## 使用量

为Leaflet 1.9所建,但也应与更早的版本相配合.

### 将一个被扭曲的MapLayer添加到地图里

创建一个 `WarpedMapLayer` 并把它添加到地图上 看起来像这样:

```js
import L from 'leaflet'

import { WarpedMapLayer } from '@allmaps/leaflet'

const map = L.map('map', {
  center: [51.0518, 3.7278],
  zoom: 14,
  // Zoom animations for more than one zoom level are
  // currently not supported by the Allmaps plugin for Leaflet
  zoomAnimationThreshold: 1
})
L.tileLayer('https://tile.openstreetmap.org/{z}/{x}/{y}.png', {
  attribution:
    '&copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors'
}).addTo(map)

const annotationUrl =
  'https://annotations.allmaps.org/maps/2d49b3ecd1ba6346'
const warpedMapLayer = new WarpedMapLayer(annotationUrl).addTo(map)
```

在将这个WardedMapLayer添加到Leaflet地图时,"GeoReference Annotation"中指定的地理参考地图将在Leaflet地图上提供.

### 装入地理参考说明的方法

一旦该地层被添加到地图中,就可以在图中添加地理参考注释 `WarpedMapLayer` 使用 `addGeoreferenceAnnotation` 财务报告和审定财务报表 `addGeoreferenceAnnotationByUrl` 函数:

```js
fetch(annotationUrl)
  .then((response) => response.json())
  .then((annotation) => warpedMapLayer.addGeoreferenceAnnotation(annotation))
```

或者说:

```js
await warpedMapLayer.addGeoreferenceAnnotationByUrl(annotationUrl)
```

也可以先创建出WarpedMapList并传递到创作的地层. 这有其优点,可以先计算出一个WardedMapList的属性,例如获得界限并传递到"Leaflet地图".

```js
import L from 'leaflet'

import { WarpedMapLayer } from '@allmaps/leaflet'
import { WarpedMapList } from '@allmaps/render'
import { WebGL2WarpedMap } from '@allmaps/render/webgl2'

const annotationUrl =
  'https://annotations.allmaps.org/manifests/8f9faeba73d67031'
const annotation = await fetch(annotationUrl).then((response) =>
    response.json()
  )
const warpedMapList = new WarpedMapList<WebGL2WarpedMap>()
await warpedMapList.addGeoreferenceAnnotation(annotation)
const bbox = warpedMapList.getMapsBbox()

const map = L.map('map', {
  // Zoom animations for more than one zoom level are
  // currently not supported by the Allmaps plugin for Leaflet
  zoomAnimationThreshold: 1
})
L.tileLayer('https://tile.openstreetmap.org/{z}/{x}/{y}.png', {
  attribution:
    '&copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors'
}).addTo(map)
const warpedMapLayer = new WarpedMapLayer(undefined, { warpedMapList }).addTo(map)
if (bbox) {
  map.fitBounds([ [ bbox[0], bbox[1] ], [ bbox[2], bbox[3] ] ])
}
```

注意 `...ByUrl()` 函数不可用在 WardedMapList 上.

### 扭曲的MapLayer API, 选项和事件

见 [@ allmaps/ warpedmapplayer (帮助)](https://npmcn.com/package/%40allmaps/warpedmaplayer/) 用于来自 WardedMapLayer 类的方法的 API 文档的软件包(由所有 Allmaps 插件共享)。 它描述的方法像 `addGeoreferenceAnnotation()` ,并包含一个列表,列出可以设置在类实例上的所有选项,以及所有传递给托管层实例的本地地图实例的事件.

你可以设置 **选项** 在整个层上,或在层上的特定地图上(覆盖层选项):

```js
warpedMapLayer.setLayerOptions({ visible: true })
warpedMapLayer.setMapOptions(mapId, { visible: true })
```

你可以听从 **事件** 以典型方式:

```js
map.on('warpedmapadded', (event) => {
  console.log(event.mapIds)
})
```

## 许可证

麻省理工学院

## API 密码

### `LeafletWarpedMapLayerOptions`

###### 类型

```ts
SpecificLeafletWarpedMapLayerOptions & Partial<WebGL2RenderOptions>
```

### `new WarpedMapLayer(annotationOrAnnotationUrl, options)`

创建被扭曲的映射符

###### 参数

-   `annotationOrAnnotationUrl` (单位:千美元)`unknown`(中文(简体) )
    -   地理参考注释或地理参考注释的 URL
-   `options?` (单位:千美元)`Partial<LeafletWarpedMapLayerOptions> | undefined`(中文(简体) )
    -   层的选项

###### 回返

`WarpedMapLayer`。 。 。 .

###### 扩展

-   `BaseWarpedMapLayer`

### `WarpedMapLayer#_animateZoom(event)`

###### 参数

-   `event` (单位:千美元)`L.ZoomAnimEvent`(中文(简体) )

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#_annotationOrAnnotationUrl`

###### 类型

```ts
unknown
```

### `WarpedMapLayer#_initGl()`

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#_resized(entries)`

###### 参数

-   `entries` (单位:千美元)`Array<ResizeObserverEntry>`(中文(简体) )

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#_unload()`

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#_update()`

###### 参数

没有参数.

###### 回返

`HTMLDivElement | undefined`。 。 。 .

### `WarpedMapLayer#_updateZIndex()`

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#addEventListeners()`

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#addGeoreferenceAnnotation(annotation, mapOptions, batchOptions)`

添加地理参考注释

###### 参数

-   `annotation` (单位:千美元)`unknown`(中文(简体) )
    -   地理参考注释
-   `mapOptions?` (单位:千美元)`Partial<WebGL2WarpedMapOptions> | undefined`(中文(简体) )
    -   映射选项
-   `batchOptions?` (单位:千美元)`Partial<BatchOptions> | undefined`(中文(简体) )

###### 回返

所添加的地图的地图标识,或每个地图的错误(`Array<BatchMapResult>`) (中文(简体) ).

### `WarpedMapLayer#addGeoreferenceAnnotationByUrl(annotationUrl, mapOptions, batchOptions)`

通过 URL 添加地理参考注释

###### 参数

-   `annotationUrl` (单位:千美元)`string`(中文(简体) )
    -   地理参考注释的 URL
-   `mapOptions?` (单位:千美元)`Partial<WebGL2WarpedMapOptions> | undefined`(中文(简体) )
    -   映射选项
-   `batchOptions?` (单位:千美元)`Partial<BatchOptions> | undefined`(中文(简体) )

###### 回返

所添加的地图的地图标识,或每个地图的错误(`Promise<Array<BatchMapResult>>`) (中文(简体) ).

### `WarpedMapLayer#addGeoreferencedMap(georeferencedMap, mapOptions)`

添加地理参考地图

###### 参数

-   `georeferencedMap` (单位:千美元)`unknown`(中文(简体) )
    -   地理参考地图
-   `mapOptions?` (单位:千美元)`Partial<WebGL2WarpedMapOptions> | undefined`(中文(简体) )
    -   映射选项

###### 回返

所添加的地图的映射标识( E)`string`) (中文(简体) ).

### `WarpedMapLayer#addImageInfos(imageInfos)`

将图像信息添加到 WardedMapList 的图像信息缓存

###### 参数

-   `imageInfos` (单位:千美元)`Array<unknown>`(中文(简体) )
    -   图像信息

###### 回返

所添加的图像信息的图像标识( E)`Array<string>`) (中文(简体) ).

### `WarpedMapLayer#addSprites(sprites, imageUrl, imageSize)`

将图示添加到渲染器的图示砖缓存

这在 WardedMapList 中将图示中的平板块添加到被扭曲的地图上. 运行此函数前加载地图 . 这使用了相關地圖的图像信息. 当使用添加图像Infos () 时, 在调用此函数前拨取它 .

###### 参数

-   `sprites` (单位:千美元)`Array<Sprite>`(中文(简体) )
    -   种子
-   `imageUrl` (单位:千美元)`string`(中文(简体) )
    -   图像 URL
-   `imageSize` (单位:千美元)`[number, number]`(中文(简体) )
    -   图像大小

###### 回返

`Promise<void>`。 。 。 .

### `WarpedMapLayer#bringMapsForward(mapIds)`

把地图带往前

###### 参数

-   `mapIds` (单位:千美元)`Iterable<string>`(中文(简体) )
    -   地图的标识

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#bringMapsToFront(mapIds)`

把地图带到前面

###### 参数

-   `mapIds` (单位:千美元)`Iterable<string>`(中文(简体) )
    -   地图的标识

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#bringToBack()`

将图层带入其他覆盖的后部(在同一映射面板中).

###### 参数

没有参数.

###### 回返

`this`。 。 。 .

### `WarpedMapLayer#bringToFront()`

将地层带入到其它覆盖面前(在同一映射面板上).

###### 参数

没有参数.

###### 回返

`this`。 。 。 .

### `WarpedMapLayer#canvas?`

###### 类型

```ts
HTMLCanvasElement
```

### `WarpedMapLayer#clear()`

从图层中删除所有被扭曲的地图

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#container?`

###### 类型

```ts
HTMLDivElement
```

### `WarpedMapLayer#contextLost(event)`

###### 参数

-   `event` (单位:千美元)`Event`(中文(简体) )

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#contextRestored(event)`

###### 参数

-   `event` (单位:千美元)`Event`(中文(简体) )

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#defaultSpecificWarpedMapLayerOptions`

###### 类型

```ts
{
  interactive: boolean
  className: string
  pane: string
  zIndex?: number
}
```

### `WarpedMapLayer#getBbox(options)`

获取图层中所有地图的边框

以 Lon- lat 返回结果 `EPSG:4326` 默认.

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `options?` (单位:千美元)`Partial<ProjectionOptions & MaskOptions> | undefined`(中文(简体) )
    -   遮盖和投影选项、默认应用遮盖和当前投影

###### 回返

所选投影中所有地图的bbox, 如果没有地图则未定义(`Bbox | undefined`) (中文(简体) ).

### `WarpedMapLayer#getBounds()`

返回在纬度/经度坐标下所有可见地图的边界(在 Viewport 内或外).

###### 参数

没有参数.

###### 回返

`[Point, Point] | undefined`。 。 。 .

-   L.LatLng Bounds 以所有可见地图的阵列形式

### `WarpedMapLayer#getCenter(options)`

获取图层中所有地图的边框中心

以 Lon- lat 返回结果 `EPSG:4326` 默认.

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `options?` (单位:千美元)`Partial<ProjectionOptions & MaskOptions> | undefined`(中文(简体) )
    -   遮盖和投影选项、默认应用遮盖和当前投影

###### 回返

所有地图的bbox中心,在所选投影中,或者在没有地图的情况下未定义(`Point | undefined`) (中文(简体) ).

### `WarpedMapLayer#getConvexHull(options)`

获取图层中所有图的对流船体

以 Lon- lat 返回结果 `EPSG:4326` 默认.

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `options?` (单位:千美元)`Partial<ProjectionOptions & MaskOptions> | undefined`(中文(简体) )
    -   遮盖和投影选项、默认应用遮盖和当前投影

###### 回返

所有地图的对流船体,在所选投影中,或在没有地图的情况下未定义(`Ring | undefined`) (中文(简体) ).

### `WarpedMapLayer#getDefaultOptions()`

获取图层的默认选项

###### 参数

没有参数.

###### 回返

`SpecificLeafletWarpedMapLayerOptions & Partial<WebGL2RenderOptions> & SpecificBaseRenderOptions<WebGL2WarpedMap> & Partial<...> & SpecificWebGL2WarpedMapOptions & SpecificTriangulatedWarpedMapOptions & WarpedMapOptions`。 。 。 .

### `WarpedMapLayer#getLayerOptions()`

获取层选项

###### 参数

没有参数.

###### 回返

`{ fetchFn?: FetchFn | undefined; gcps?: Array<Gcp> | undefined; resourceMask?: Ring | undefined; transformationType?: TransformationType | undefined; ... 79 more ...; zIndex?: number | undefined; }`。 。 。 .

### `WarpedMapLayer#getMapDefaultOptions(mapId)`

获取地图的默认选项

这些来自WebGL2 WardpedMaps和地图的地理参考地图的默认选项设置

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   应用选项的映射ID

###### 回返

`WebGL2WarpedMapOptions | undefined`。 。 。 .

### `WarpedMapLayer#getMapIds()`

获取图层中所有地图的映射符

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

没有参数.

###### 回返

所有地图的映射图( E)`Array<string>`) (中文(简体) ).

### `WarpedMapLayer#getMapMapOptions(mapId)`

获取地图的特定选项

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   应用选项的映射ID

###### 回返

`Partial<WebGL2WarpedMapOptions> | undefined`。 。 。 .

### `WarpedMapLayer#getMapOptions(mapId)`

获取地图的选项

这些选项是合并默认,地理参照地图的结果, 该地图的分层和特定地图选项.

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   应用选项的映射ID

###### 回返

`WebGL2WarpedMapOptions | undefined`。 。 。 .

### `WarpedMapLayer#getMapZIndex(mapId)`

获取地图的 Z 索引

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   获取 Z 索引的地图标识

###### 回返

地图的z-索引(`number | undefined`) (中文(简体) ).

### `WarpedMapLayer#getMapsBbox(mapIds, options)`

获取所有选中地图的边框

以 Lon- lat 返回结果 `EPSG:4326` 默认.

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   地图标识
-   `options?` (单位:千美元)`Partial<ProjectionOptions & MaskOptions> | undefined`(中文(简体) )
    -   遮盖和投影选项、默认应用遮盖和当前投影

###### 回返

所有选中的地图的bbox, 在选中的投影中, 或者在没有匹配选中的地图时未定义(`Bbox | undefined`) (中文(简体) ).

### `WarpedMapLayer#getMapsCenter(mapIds, options)`

获取所有选中地图的边框中心

以 Lon- lat 返回结果 `EPSG:4326` 默认.

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   地图标识
-   `options?` (单位:千美元)`Partial<ProjectionOptions & MaskOptions> | undefined`(中文(简体) )
    -   遮盖和投影选项、默认应用遮盖和当前投影

###### 回返

所有所选地图的bbox中心,在所选投影中,或者没有匹配所选地图的未定义(`Point | undefined`) (中文(简体) ).

### `WarpedMapLayer#getMapsConvexHull(mapIds, options)`

获取所有选中地图的对流船体

以 Lon- lat 返回结果 `EPSG:4326` 默认.

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   地图标识
-   `options?` (单位:千美元)`Partial<ProjectionOptions & MaskOptions> | undefined`(中文(简体) )
    -   遮盖和投影选项、默认应用遮盖和当前投影

###### 回返

所有所选地图的对流船体,在所选投影中,或者没有匹配所选地图的未定义(`Ring | undefined`) (中文(简体) ).

### `WarpedMapLayer#getOpacity()`

获取层层不透明

返回 0 到 1 之间的数字( 默认)

###### 参数

没有参数.

###### 回返

`number`。 。 。 .

### `WarpedMapLayer#getWarpedMap(mapId)`

获取一个映射图的被扭曲地图

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   请求的被扭曲映射实例的映射ID

###### 回返

`WebGL2WarpedMap | undefined`。 。 。 .

### `WarpedMapLayer#getWarpedMapList()`

获取包含所有已装入的地图被扭曲地图列表的被扭曲地图对象

###### 参数

没有参数.

###### 回返

`WarpedMapList<WebGL2WarpedMap>`。 。 。 .

### `WarpedMapLayer#getWarpedMaps(mapIds)`

获取所有地图或所有所选地图的扭曲映射实例

如果没有通过参数,则通过图层中所有地图的 WardedMap 实例

注意: 对 WardedMapList 的此函数, 有更多的选择选项可用

###### 参数

-   `mapIds?` (单位:千美元)`Array<string> | undefined`(中文(简体) )
    -   地图标识

###### 回返

所有( 选中的) 映射的 WardedMap 实例`Array<WebGL2WarpedMap>`) (中文(简体) ).

### `WarpedMapLayer#getZIndex()`

获得地层的z指数.

###### 参数

没有参数.

###### 回返

`number | undefined`。 。 。 .

### `WarpedMapLayer#gl?`

###### 类型

```ts
WebGL2RenderingContext
```

### `WarpedMapLayer#initialize(annotationOrAnnotationUrl, options)`

###### 参数

-   `annotationOrAnnotationUrl` (单位:千美元)`unknown`(中文(简体) )
-   `options?` (单位:千美元)`Partial<LeafletWarpedMapLayerOptions> | undefined`(中文(简体) )

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#nativePassWarpedMapEvent(event)`

###### 参数

-   `event` (单位:千美元)`Event`(中文(简体) )

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#nativeUpdate()`

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#onAdd(map)`

包含所有为地层创建 DOM 元素的代码并添加到其所属的映射面板上.

###### 参数

-   `map` (单位:千美元)`L.Map`(中文(简体) )

###### 回返

`this`。 。 。 .

### `WarpedMapLayer#onRemove(map)`

包含从 DOM 中去除层元素的所有清理代码.

###### 参数

-   `map` (单位:千美元)`L.Map`(中文(简体) )

###### 回返

`this`。 。 。 .

### `WarpedMapLayer#options`

###### 类型

```ts
SpecificLeafletWarpedMapLayerOptions & Partial<WebGL2RenderOptions>
```

### `WarpedMapLayer#removeEventListeners()`

###### 参数

没有参数.

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#removeGeoreferenceAnnotation(annotation, batchOptions)`

删除地理参考注释

###### 参数

-   `annotation` (单位:千美元)`unknown`(中文(简体) )
    -   地理参考注释
-   `batchOptions?` (单位:千美元)`Partial<BatchOptions> | undefined`(中文(简体) )

###### 回返

被删除的地图的地图标识,或每个地图的错误(`Array<BatchMapResult>`) (中文(简体) ).

### `WarpedMapLayer#removeGeoreferenceAnnotationByUrl(annotationUrl, batchOptions)`

通过 URL 删除地理参考注释

###### 参数

-   `annotationUrl` (单位:千美元)`string`(中文(简体) )
    -   地理参考注释的 URL
-   `batchOptions?` (单位:千美元)`Partial<BatchOptions> | undefined`(中文(简体) )

###### 回返

被删除的地图的地图标识,或每个地图的错误(`Promise<Array<BatchMapResult>>`) (中文(简体) ).

### `WarpedMapLayer#removeGeoreferencedMap(georeferencedMap)`

删除地理参考地图

###### 参数

-   `georeferencedMap` (单位:千美元)`unknown`(中文(简体) )
    -   地理参考地图

###### 回返

已删除的地图的映射 ID (`string`) (中文(简体) ).

### `WarpedMapLayer#removeGeoreferencedMapById(mapId)`

以 ID 删除地理参考地图

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   要删除的地理参考地图的地图ID

###### 回返

已删除的地图的映射 ID (`string`) (中文(简体) ).

### `WarpedMapLayer#renderer?`

###### 类型

```ts
WebGL2Renderer
```

### `WarpedMapLayer#resetLayerOptions(layerOptionKeys, animationOptions)`

重置层选项

未定义的选项密钥重置所有选项

不重置选项或特定的被扭曲的地图层选项 。 使用设置选项( ) .

###### 参数

-   `layerOptionKeys?` (单位:千美元)`Array<string> | undefined`(中文(简体) )
    -   重设层选项的密钥
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#resetMapsAndListOptions(mapIds, mapsOptionKeys, layerOptionKeys, animationOptions)`

重置指定地图的地图特定选项和图层选项

选择 `mapsOptionKeys` 或者说 `layerOptionKeys` 重新设置该范围的所有选项; 通过一个空阵列重置无.

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   重新设置选项的地图的标识
-   `mapsOptionKeys?` (单位:千美元) `| Array< | keyof SpecificTriangulatedWarpedMapOptions | keyof SpecificWebGL2WarpedMapOptions | keyof WarpedMapOptions > | undefined`(中文(简体) )
    -   重新设置的地图特定选项的密钥
-   `layerOptionKeys?` (单位:千美元) `| Array< | keyof SpecificTriangulatedWarpedMapOptions | keyof SpecificWebGL2WarpedMapOptions | keyof WarpedMapOptions > | undefined`(中文(简体) )
    -   重设层选项的密钥
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#resetMapsOptions(mapIds, mapsOptionKeys, animationOptions)`

重置指定地图的地图选项

选择 `mapsOptionKeys` 重新设置所有选项; 通过空的数组重新设置 .

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   重新设置选项的地图的标识
-   `mapsOptionKeys?` (单位:千美元) `| Array< | keyof SpecificTriangulatedWarpedMapOptions | keyof SpecificWebGL2WarpedMapOptions | keyof WarpedMapOptions > | undefined`(中文(简体) )
    -   重设选项的密钥
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#resizeObserver`

###### 类型

```ts
ResizeObserver | undefined
```

### `WarpedMapLayer#sendMapsBackward(mapIds)`

向后发送地图

###### 参数

-   `mapIds` (单位:千美元)`Iterable<string>`(中文(简体) )
    -   地图的标识

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#sendMapsToBack(mapIds)`

向后发送地图

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   地图的标识

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setLayerOptions(layerOptions, animationOptions)`

设置层选项

没有设置渲染选项或特定的扭曲图层选项 。 使用设置选项( ) .

###### 参数

-   `layerOptions?` (单位:千美元)`Partial<WarpedMapListOptions<WebGL2WarpedMap>> | undefined`(中文(简体) )
    -   要设置的层选项
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    
    -   动画选项
    
    ```js
    warpedMapLayer.setLayerOptions({ transformationType: 'thinPlateSpline' })
    ```
    

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setLayerTransformationType(transformationType, animationOptions)`

设置层的转换类型

###### 参数

-   `transformationType?` (单位:千美元)`TransformationType | undefined`(中文(简体) )
    -   要设置的转换类型
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setMapGcps(mapId, gcps, animationOptions)`

设置地图的 GCP

仅设定地图 `gcps` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从地理参考注释中推断出的原始GCP.

原GCP可以通过重置地图特定GCP选项来重置,, 在被扭曲的地图上可以访问 `map` 属性.

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   设置选项的映射ID
-   `gcps` (单位:千美元)`Array<Gcp>`(中文(简体) )
    -   要设定的 GCP
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setMapOptions(mapId, mapOptions, animationOptions)`

设定地图的特定选项

一般设置地图专用选项 还设置了地图的相应选项, 由于这些是合并默认,地理参照地图的结果, 该地图的分层和特定地图选项.

一个特殊的情况是设置一个特定的地图选项 `undefined`数字 : 然后从默认、地理参考地图或层选项中得出相应的选项. 这相当于对地图特定选项使用重置函数.

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   设置选项的映射ID
-   `mapOptions` (单位:千美元)`{ fetchFn?: FetchFn | undefined; gcps?: Array<Gcp> | undefined; resourceMask?: Ring | undefined; transformationType?: TransformationType | undefined; ... 59 more ...; debugTiles?: boolean | undefined; }`(中文(简体) )
    -   要设置的地图选项
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

###### 实例

```ts
warpedMapLayer.setMapOptions(myMapId, { transformationType: 'thinPlateSpline' })
```

### `WarpedMapLayer#setMapResourceMask(mapId, resourceMask, animationOptions)`

设置地图的资源掩码

仅设定地图 `resourceMask` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从地理参考注释推断出来的原始资源掩码 .

原始资源掩码可以通过重置地图特定资源掩码选项来重置, , 并保留在被扭曲的地图中 `map` 属性.

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   设置选项的映射ID
-   `resourceMask` (单位:千美元)`Array<Point>`(中文(简体) )
    -   要设置的资源掩码
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setMapTransformationType(mapId, transformationType, animationOptions)`

设定地图的转换类型

仅设定地图 `transformationType` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从"地理参考注释"推断出来的原始变换类型.

原变换类型可以通过重置地图特定变换类型选项来重置,, 并保留在被扭曲的地图中 `map` 属性.

###### 参数

-   `mapId` (单位:千美元)`string`(中文(简体) )
    -   设置选项的映射ID
-   `transformationType?` (单位:千美元)`TransformationType | undefined`(中文(简体) )
    -   要设置的转换类型
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setMapsAndLayerOptions(mapIds, mapsOptions, layerOptions, animationOptions)`

设置指定地图的地图特定选项和图层选项

当地图特定选项一并更改多个地图时有用, 与图层选项一起,但只应发射一款动画.

没有设置渲染选项或特定的扭曲图层选项 。 使用设置选项( ) .

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   选择设置的地图的标识
-   `mapsOptions?` (单位:千美元)`Partial<WebGL2WarpedMapOptions> | undefined`(中文(简体) )
    -   适用于每个地图的地图特定选项
-   `layerOptions?` (单位:千美元)`Partial<WarpedMapListOptions<WebGL2WarpedMap>> | undefined`(中文(简体) )
    -   要应用的层选项
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

###### 实例

```ts
warpedMapLayer.setMapsAndLayerOptions([myMapId], { transformationType: 'thinPlateSpline' }, { visible: true })
```

### `WarpedMapLayer#setMapsOptions(mapIds, mapsOptions, animationOptions)`

设置特定地图的地图选项

一般设置地图专用选项 还设置了地图的相应选项, 由于这些是合并默认,地理参照地图的结果, 该地图的分层和特定地图选项.

一个特殊的情况是设置一个特定的地图选项 `undefined`数字 : 然后从默认、地理参考地图或层选项中得出相应的选项. 这相当于对地图特定选项使用重置函数.

当地图特定选项一并更改多个地图时有用, 但应该只开一出动画片.

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   选择设置的地图的地图标识
-   `mapsOptions?` (单位:千美元)`Partial<WebGL2WarpedMapOptions> | undefined`(中文(简体) )
    -   适用于每个地图的地图特定选项
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

###### 实例

```ts
warpedMapLayer.setMapsOptions([myMapId], { transformationType: 'thinPlateSpline' })
```

### `WarpedMapLayer#setMapsTransformationType(mapIds, transformationType, animationOptions)`

设定地图的转换类型

仅设定地图 `transformationType` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从"地理参考注释"推断出来的原始变换类型.

原变换类型可以通过重置地图特定变换类型选项来重置,, 并保留在被扭曲的地图中 `map` 属性.

###### 参数

-   `mapIds` (单位:千美元)`Array<string>`(中文(简体) )
    -   设置选项的映射ID
-   `transformationType?` (单位:千美元)`TransformationType | undefined`(中文(简体) )
    -   要设置的转换类型
-   `animationOptions?` (单位:千美元)`Partial<AnimationOptions> | undefined`(中文(简体) )
    -   动画选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setOpacity(opacity)`

设置层不透明

###### 参数

-   `opacity` (单位:千美元)`number`(中文(简体) )
    -   要设置的层不透明

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setOptions(options)`

设置选项

###### 参数

-   `options?` (单位:千美元) `| Partial<LeafletWarpedMapLayerOptions> | Partial<WebGL2RenderOptions> | undefined`(中文(简体) )
    -   要设置的选项

###### 回返

`void`。 。 。 .

### `WarpedMapLayer#setZIndex(value)`

更改层的z-索引 .

###### 参数

-   `value` (单位:千美元)`number`(中文(简体) )
    -   z 指数

###### 回返

`this`。 。 。 .

## 常见问题

### @allmaps/leaflet 是什么？

Allmaps 叶片插件

### 如何安装 @allmaps/leaflet？

在项目目录运行 npm install @allmaps/leaflet，或使用 pnpm add / yarn add / bun add。

### @allmaps/leaflet 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/allmaps\_\_leaflet 是否存在。

### @allmaps/leaflet 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @allmaps/leaflet 可以商用吗？

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

### @allmaps/leaflet 的下载量有多少？

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

### @allmaps/leaflet 还在维护吗？

最新版本 1\.0\.0-beta\.55 发布于 2026/09/22（1 个月前）；至今共发布 46 个版本，其中过去 12 个月发布了 6 个；首次发布于 2022/11/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。