# @allmaps/warpedmaplayer 中文文档 规范地址：https://npmcn.com/package/%40allmaps/warpedmaplayer/ 版本：1\.0\.0-beta\.44 npm 元数据更新时间：2026-10-01T09:24:40.180Z 中文译文更新时间：2026-11-06T00:07:41.513Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40allmaps/warpedmaplayer 原文对照：https://npmcn.com/package/%40allmaps/warpedmaplayer/?lang=original 项目主页：https://allmaps.org/ 源码仓库：https://github.com/allmaps/allmaps ## 关键信息（来自 npm 元数据） - 包体积（解压后）：101 kB，7 个文件 - 模块格式：ES Module - TypeScript 类型：未声明 - 运行依赖：3 个 - 首次发布：2025-11-10T22:00:29.614Z - 最新版本发布：2026-09-22T07:06:51.727Z - 近 30 天下载量：8431（2026-10-06 至 2026-11-04，npm 官方下载统计） - 已发布版本数：6（近 12 个月 6 个） ## 中文简介 Allmaps 的基础插件类 ## 安装 ```sh npm install @allmaps/warpedmaplayer ``` 也可以使用：`pnpm add @allmaps/warpedmaplayer`、`yarn add @allmaps/warpedmaplayer`、`bun add @allmaps/warpedmaplayer` ## README # @ allmaps/ warpedmapplayer (帮助) Allmaps 插件的基础类 。 此类包含由 Leaflet 、 OpenLayers 和 MapLibre 插件输出的 WardedMapLayer 类的主要逻辑, 它允许显示地理参考 [IIIF 图像](https://iiif.io/) 在网络地图上。 这些插件通过加载工作 [地理参考说明](https://iiif.io/api/georef/extension/georef/) 并使用WebGL从一个 IIIF 图像服务器上转换图像,以覆盖其正确的地理位置. ## 如何运作 此插件创建了新类 `WarpedMapLayer` 延伸或由 `Layer` 分类。 当它延伸(MapLibre)时,本包中定义的方法会被自动继承. 在执行时(Leaflet和OpenLayers),对这些方法的任何修改都应被复制到执行类(见代码中的评论). 为了了解每个地理参考地图的引擎盖下会发生什么,请参看 [@ allmaps/ 放弃](https://npmcn.com/package/%40allmaps/render/) 软件包. ## 安装 这个软件包在浏览器和Node.js中作为无害环境管理或UMD模块发挥作用. 用 pnpm 安装 : ```sh pnpm install @allmaps/warpedmaplayer ``` 您可以通过运行在本地建立此软件包 : ```sh pnpm run build ``` ## 使用量 这个软件包包含了由Allmaps插件导出用于Leaflet,OpenLayers和MapLibre的WardedMapLayer类的主要逻辑. 不应直接使用。 更多使用信息请参见插件的读取. 使用此读取来理解插件之间共享的 WardedMapLayer 方法的 API, 包括 **事件类型** 由 WardedMapLayer 实例和可用的列表所释放 **选项**。 。 。 . ### 活动 以下事件由本地地图对象发布以告知您 `WarpedMapLayer`。 。 。 . | 类型 | 说明 | | --- | --- | | `imageinfosadded` | 图像信息已直接添加到被扭曲的地图列表 | | `georeferenceannotationadded` | 在被扭曲的地图列表中添加了地理参考注释 | | `georeferenceannotationremoved` | 从被扭曲的地图列表中删除了地理参考注释 | | `warpedmapadded` | 在被扭曲的地图列表中添加了被扭曲的地图 | | `warpedmapremoved` | 从被扭曲的地图列表中删除了被扭曲的地图 | | `warpedmapentered` | 一条被扭曲的地图已输入视图端口 | | `warpedmapleft` | 一张被扭曲的地图离开了视图 | | `imageloaded` | 从缓存或取取出图像信息后, 图像已被装入地图 | | `maptilesloadedfromsprites` | 已从已获取的图示图像地图中装入平板缓存 | | `maptileloaded` | 一个平板已装入到平板缓存以获取地图 | | `maptiledeleted` | 磁盘缓存中已删除一个图片 | | `firstmaptileloaded` | 缓存中装入了地图的第一个平板 | | `requestedtilesloading` | 当前视图端口需要的新瓷砖开始装入 | | `allrequestedtilesloaded` | 当前视图端口所需的所有牌已经装入 | | `cleared` | 被扭曲的地图列表已清除 | | `preparechange` | 已经为特定映射准备了即将到来的选项更改( 如果动画还在进行中, 则将上个属性和新属性混合) | | `immediatechange` | 选项更改已立即处理 | | `animatedchange` | 已用动画处理一个选项更改 | 事件数据遵循 `Partial` 类型 : ```ts export type WarpedMapEventData = { mapIds: string[] tileUrl: string optionKeys: string[] spritesInfo: SpritesInfo } ``` ### 选项 选项可以设置在 `WarpedMapLayer` 均为 _层选项_,适用于所有地图,或作为个人 _映射选项_。对于每张地图,对它应用的最后选项是合并 _默认选项_,在 _地理参考注释_ (比如说) `resourceMask`, (中文(简体) ), `transformationType`, (中文(简体) ), `internalProjection` 财务报告和审定财务报表 `gcps`, (中文(简体) ), _层选项_ 财务报告和审定财务报表 _映射选项_当合并选项时, `undefined` 选项被忽略,因此设置一个图层或映射选项以有效重排. 有以下备选方案: | 密钥 | 说明 | 默认 | | --- | --- | --- | | `applyMask` | 应用资源遮罩( 如果错误, 则使用完整的遮罩) | `true` | | `colorize` | 将地图颜色化 | `false` | | `colorizeColor` | 要将地图颜色化的颜色 | `"#ff56ba"` | | `debugTiles` | 调试: 显示平板边框 | `false` | | `debugTriangles` | 调试: 显示三角形 | `false` | | `distortionColor00` | 第一个颜色 `'log2sigma'` 扭曲 | `"#fe5e60"` | | `distortionColor01` | 第二个颜色在 `'log2sigma'` 扭曲 | `"#3b44ad"` | | `distortionColor1` | 颜色在 `'twoOmega'` 扭曲 | `"#64c18f"` | | `distortionColor2` | 颜色在 `'airyKavr'` 扭曲 | `"#ffc742"` | | `distortionColor3` | 颜色在 `'signDetJ'` 扭曲 | `"#fe5e60"` | | `distortionMeasures` | 拟计算的扭曲计量 | `['log2sigma', 'twoOmega']` | | `gcps` | 地面控制点 | `[]` (由GCPs在地理参考注释中进行重写) | | `internalProjection` | 内部预测(见 [@allmaps/ 项目](https://npmcn.com/package/%40allmaps/project/)(中文(简体) ) | `WebMercatorProjection` (可能被地理参考注释中的内部投影所覆盖) | | `opacity` | 不透明度 | `1` | | `projection` | 预测(见 [@allmaps/ 项目](https://npmcn.com/package/%40allmaps/project/)(中文(简体) ) | `WebMercatorProjection` | | `removeColor` | 删除颜色 | `false` | | `removeColorColor` | 要删除的颜色 | `"#222222"` | | `removeColorHardness` | 删除颜色时的硬度 | `0.7` | | `removeColorThreshold` | 删除颜色时的阈值 | `0` | | `renderAppliableMask` | 打开 _实用口罩_,这是地理参考注释(或选项)中指定的资源掩码,即使该掩码没有被应用(参见 `applyMask` 选项),并使用完整的口罩 | `false` | | `renderAppliableMaskColor` | 渲染实用口罩时的颜色 | `"#ff56ba"` | | `renderAppliableMaskSize` | 渲染可应用口罩时的视图像素大小 | `8` | | `renderFullMask` | 戴上满口口罩 | `false` | | `renderFullMaskColor` | 制取完整遮罩时的颜色 | `"#64c18f"` | | `renderFullMaskSize` | 渲染完整遮罩时, 视点像素大小 | `8` | | `renderGcps` | 提出全球协商进程 | `false` | | `renderGcpsColor` | 渲染 GCP 时的颜色 | `"#63d8e6"` | | `renderGcpsSize` | 渲染 GCP 时的视图像素大小 | `16` | | `renderGrid` | 调整网格 | `false` | | `renderGridColor` | 渲染网格时的颜色 | `"#222222"` | | `renderMask` | 戴上口罩 | `false` | | `renderMaskColor` | 渲染口罩时的颜色 | `"#ff56ba"` | | `renderMaskSize` | 渲染口罩时的视图像素大小 | `8` | | `renderTransformedGcps` | 改造后的GCP | `false` | | `renderTransformedGcpsColor` | 渲染已转换的 GCP 时的颜色 | `"#ff56ba"` | | `renderTransformedGcpsSize` | 渲染已变换的 GCP 时的视图像素大小 | `16` | | `renderVectors` | 将每个GCP与各自的变换GCP连接起来的向量渲染 | `false` | | `renderVectorsColor` | 向量渲染时的颜色 | `"#222222"` | | `renderVectorsSize` | 渲染向量时的视图像素大小 | `6` | | `resourceMask` | 资源掩码 | `[]` (由地理参考注释中的资源掩码所覆盖) | | `saturation` | 饱和度 | `1` | | `transformationType` | 转换类型 | `"polynomial"` (可能由地理参考注释中的转换类型所覆盖) | | `visible` | 可见 | `true` | ### 什么是一个 _地图_? 吗? Leaflet, OpenLayer 和 MapLibre 各自都有"地图"作为中心类的 API 的概念(参见 Leaflet) [`Map`](https://leafletjs.com/reference.html#map)打开标签 [`Map`](https://openlayers.org/en/latest/apidoc/module-ol_Map-Map.html) 和地图Libre [`Map`](https://maplibre.org/maplibre-gl-js/docs/API/classes/maplibregl.Map/)) (中文(简体) ). 它一般是指a `
` 一个使用平板或WebGL逻辑绘制世界投影的页面. 在Allmaps中,“地图”的概念与地理参考注释相当相干。 地图通过Allmaps 渲染管道的每个阶段都有一个: - 当绘制地理参考注释时 `GeoreferencedMap` 类由它创建. - 当此地图被装入用于渲染的应用程序时, 例如 `WarpedMap` 类由它创建. - 在WebGL2渲染器内 `WebGL2WarpedMap` 类用于渲染地图. 所有这些来自同一地理参考注释的地图相具有相同的独特性 `mapId` 属性。 此字符串值被使用 though-out Allmaps( 并在下面的 API) 来识别地图 。 它在向被扭曲的MapLayer添加了地理参考注释后被返回,因此您可以稍后使用它在特定地图上调用函数. 注意, 由于一个 WardedMapLayer 可以装入多个 GeoReference 说明, 我们可以有多个 Allmaps “ maps ” , 例如一个 Leaflet “ map ” . ## 许可证 麻省理工学院 ## API 密码 ### `new BaseWarpedMapLayer(defaultSpecificWarpedMapLayerOptions, options)` 创建扭曲的MapLayer实例 ###### 参数 - `defaultSpecificWarpedMapLayerOptions` (单位:千美元)`SpecificWarpedMapLayerOptions`(中文(简体) ) - `options?` (单位:千美元) `| Partial> | undefined`(中文(简体) ) - 选项 ###### 回返 `BaseWarpedMapLayer`。 。 。 . ### `BaseWarpedMapLayer#addEventListeners()` ###### 参数 没有参数. ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#addGeoreferenceAnnotation(annotation, mapOptions, batchOptions)` 添加地理参考注释 ###### 参数 - `annotation` (单位:千美元)`unknown`(中文(简体) ) - 地理参考注释 - `mapOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 映射选项 - `batchOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) ###### 回返 所添加的地图的地图标识,或每个地图的错误(`Array`) (中文(简体) ). ### `BaseWarpedMapLayer#addGeoreferenceAnnotationByUrl(annotationUrl, mapOptions, batchOptions)` 通过 URL 添加地理参考注释 ###### 参数 - `annotationUrl` (单位:千美元)`string`(中文(简体) ) - 地理参考注释的 URL - `mapOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 映射选项 - `batchOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) ###### 回返 所添加的地图的地图标识,或每个地图的错误(`Promise>`) (中文(简体) ). ### `BaseWarpedMapLayer#addGeoreferencedMap(georeferencedMap, mapOptions)` 添加地理参考地图 ###### 参数 - `georeferencedMap` (单位:千美元)`unknown`(中文(简体) ) - 地理参考地图 - `mapOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 映射选项 ###### 回返 所添加的地图的映射标识( E)`string`) (中文(简体) ). ### `BaseWarpedMapLayer#addImageInfos(imageInfos)` 将图像信息添加到 WardedMapList 的图像信息缓存 ###### 参数 - `imageInfos` (单位:千美元)`Array`(中文(简体) ) - 图像信息 ###### 回返 所添加的图像信息的图像标识( E)`Array`) (中文(简体) ). ### `BaseWarpedMapLayer#addSprites(sprites, imageUrl, imageSize)` 将图示添加到渲染器的图示砖缓存 这在 WardedMapList 中将图示中的平板块添加到被扭曲的地图上. 运行此函数前加载地图 . 这使用了相關地圖的图像信息. 当使用添加图像Infos () 时, 在调用此函数前拨取它 . ###### 参数 - `sprites` (单位:千美元)`Array`(中文(简体) ) - 种子 - `imageUrl` (单位:千美元)`string`(中文(简体) ) - 图像 URL - `imageSize` (单位:千美元)`[number, number]`(中文(简体) ) - 图像大小 ###### 回返 `Promise`。 。 。 . ### `BaseWarpedMapLayer#bringMapsForward(mapIds)` 把地图带往前 ###### 参数 - `mapIds` (单位:千美元)`Iterable`(中文(简体) ) - 地图的标识 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#bringMapsToFront(mapIds)` 把地图带到前面 ###### 参数 - `mapIds` (单位:千美元)`Iterable`(中文(简体) ) - 地图的标识 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#canvas?` ###### 类型 ```ts HTMLCanvasElement ``` ### `BaseWarpedMapLayer#clear()` 从图层中删除所有被扭曲的地图 ###### 参数 没有参数. ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#container?` ###### 类型 ```ts HTMLDivElement ``` ### `BaseWarpedMapLayer#contextLost(event)` ###### 参数 - `event` (单位:千美元)`Event`(中文(简体) ) ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#contextRestored(event)` ###### 参数 - `event` (单位:千美元)`Event`(中文(简体) ) ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#defaultSpecificWarpedMapLayerOptions` ###### 类型 ```ts SpecificWarpedMapLayerOptions ``` ### `BaseWarpedMapLayer#getBbox(options)` 获取图层中所有地图的边框 以 Lon- lat 返回结果 `EPSG:4326` 默认. 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `options?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 遮盖和投影选项、默认应用遮盖和当前投影 ###### 回返 所选投影中所有地图的bbox, 如果没有地图则未定义(`Bbox | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getCenter(options)` 获取图层中所有地图的边框中心 以 Lon- lat 返回结果 `EPSG:4326` 默认. 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `options?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 遮盖和投影选项、默认应用遮盖和当前投影 ###### 回返 所有地图的bbox中心,在所选投影中,或者在没有地图的情况下未定义(`Point | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getConvexHull(options)` 获取图层中所有图的对流船体 以 Lon- lat 返回结果 `EPSG:4326` 默认. 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `options?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 遮盖和投影选项、默认应用遮盖和当前投影 ###### 回返 所有地图的对流船体,在所选投影中,或在没有地图的情况下未定义(`Ring | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getDefaultOptions()` 获取图层的默认选项 ###### 参数 没有参数. ###### 回返 `SpecificWarpedMapLayerOptions & SpecificBaseRenderOptions & Partial> & SpecificWebGL2WarpedMapOptions & SpecificTriangulatedWarpedMapOptions & WarpedMapOptions`。 。 。 . ### `BaseWarpedMapLayer#getLayerOptions()` 获取层选项 ###### 参数 没有参数. ###### 回返 `{ [P in keyof (SpecificWarpedMapLayerOptions & Partial)]?: (SpecificWarpedMapLayerOptions & Partial<...>)[P] | undefined; }`。 。 。 . ### `BaseWarpedMapLayer#getMapDefaultOptions(mapId)` 获取地图的默认选项 这些来自WebGL2 WardpedMaps和地图的地理参考地图的默认选项设置 ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 应用选项的映射ID ###### 回返 `WebGL2WarpedMapOptions | undefined`。 。 。 . ### `BaseWarpedMapLayer#getMapIds()` 获取图层中所有地图的映射符 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 没有参数. ###### 回返 所有地图的映射图( E)`Array`) (中文(简体) ). ### `BaseWarpedMapLayer#getMapMapOptions(mapId)` 获取地图的特定选项 ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 应用选项的映射ID ###### 回返 `Partial | undefined`。 。 。 . ### `BaseWarpedMapLayer#getMapOptions(mapId)` 获取地图的选项 这些选项是合并默认,地理参照地图的结果, 该地图的分层和特定地图选项. ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 应用选项的映射ID ###### 回返 `WebGL2WarpedMapOptions | undefined`。 。 。 . ### `BaseWarpedMapLayer#getMapZIndex(mapId)` 获取地图的 Z 索引 ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 获取 Z 索引的地图标识 ###### 回返 地图的z-索引(`number | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getMapsBbox(mapIds, options)` 获取所有选中地图的边框 以 Lon- lat 返回结果 `EPSG:4326` 默认. 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 地图标识 - `options?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 遮盖和投影选项、默认应用遮盖和当前投影 ###### 回返 所有选中的地图的bbox, 在选中的投影中, 或者在没有匹配选中的地图时未定义(`Bbox | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getMapsCenter(mapIds, options)` 获取所有选中地图的边框中心 以 Lon- lat 返回结果 `EPSG:4326` 默认. 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 地图标识 - `options?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 遮盖和投影选项、默认应用遮盖和当前投影 ###### 回返 所有所选地图的bbox中心,在所选投影中,或者没有匹配所选地图的未定义(`Point | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getMapsConvexHull(mapIds, options)` 获取所有选中地图的对流船体 以 Lon- lat 返回结果 `EPSG:4326` 默认. 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 地图标识 - `options?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 遮盖和投影选项、默认应用遮盖和当前投影 ###### 回返 所有所选地图的对流船体,在所选投影中,或者没有匹配所选地图的未定义(`Ring | undefined`) (中文(简体) ). ### `BaseWarpedMapLayer#getOpacity()` 获取层层不透明 返回 0 到 1 之间的数字( 默认) ###### 参数 没有参数. ###### 回返 `number`。 。 。 . ### `BaseWarpedMapLayer#getWarpedMap(mapId)` 获取一个映射图的被扭曲地图 ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 请求的被扭曲映射实例的映射ID ###### 回返 `WebGL2WarpedMap | undefined`。 。 。 . ### `BaseWarpedMapLayer#getWarpedMapList()` 获取包含所有已装入的地图被扭曲地图列表的被扭曲地图对象 ###### 参数 没有参数. ###### 回返 `WarpedMapList`。 。 。 . ### `BaseWarpedMapLayer#getWarpedMaps(mapIds)` 获取所有地图或所有所选地图的扭曲映射实例 如果没有通过参数,则通过图层中所有地图的 WardedMap 实例 注意: 对 WardedMapList 的此函数, 有更多的选择选项可用 ###### 参数 - `mapIds?` (单位:千美元)`Array | undefined`(中文(简体) ) - 地图标识 ###### 回返 所有( 选中的) 映射的 WardedMap 实例`Array`) (中文(简体) ). ### `BaseWarpedMapLayer#gl?` ###### 类型 ```ts WebGL2RenderingContext ``` ### `BaseWarpedMapLayer#nativePassWarpedMapEvent(event)` ###### 参数 - `event` (单位:千美元)`Event`(中文(简体) ) ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#nativeUpdate()` ###### 参数 没有参数. ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#options` ###### 类型 ```ts SpecificWarpedMapLayerOptions & Partial ``` ### `BaseWarpedMapLayer#removeEventListeners()` ###### 参数 没有参数. ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#removeGeoreferenceAnnotation(annotation, batchOptions)` 删除地理参考注释 ###### 参数 - `annotation` (单位:千美元)`unknown`(中文(简体) ) - 地理参考注释 - `batchOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) ###### 回返 被删除的地图的地图标识,或每个地图的错误(`Array`) (中文(简体) ). ### `BaseWarpedMapLayer#removeGeoreferenceAnnotationByUrl(annotationUrl, batchOptions)` 通过 URL 删除地理参考注释 ###### 参数 - `annotationUrl` (单位:千美元)`string`(中文(简体) ) - 地理参考注释的 URL - `batchOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) ###### 回返 被删除的地图的地图标识,或每个地图的错误(`Promise>`) (中文(简体) ). ### `BaseWarpedMapLayer#removeGeoreferencedMap(georeferencedMap)` 删除地理参考地图 ###### 参数 - `georeferencedMap` (单位:千美元)`unknown`(中文(简体) ) - 地理参考地图 ###### 回返 已删除的地图的映射 ID (`string`) (中文(简体) ). ### `BaseWarpedMapLayer#removeGeoreferencedMapById(mapId)` 以 ID 删除地理参考地图 ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 要删除的地理参考地图的地图ID ###### 回返 已删除的地图的映射 ID (`string`) (中文(简体) ). ### `BaseWarpedMapLayer#renderer?` ###### 类型 ```ts WebGL2Renderer ``` ### `BaseWarpedMapLayer#resetLayerOptions(layerOptionKeys, animationOptions)` 重置层选项 未定义的选项密钥重置所有选项 不重置选项或特定的被扭曲的地图层选项 。 使用设置选项( ) . ###### 参数 - `layerOptionKeys?` (单位:千美元)`Array | undefined`(中文(简体) ) - 重设层选项的密钥 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#resetMapsAndListOptions(mapIds, mapsOptionKeys, layerOptionKeys, animationOptions)` 重置指定地图的地图特定选项和图层选项 选择 `mapsOptionKeys` 或者说 `layerOptionKeys` 重新设置该范围的所有选项; 通过一个空阵列重置无. ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 重新设置选项的地图的标识 - `mapsOptionKeys?` (单位:千美元) `| Array< | keyof SpecificTriangulatedWarpedMapOptions | keyof SpecificWebGL2WarpedMapOptions | keyof WarpedMapOptions > | undefined`(中文(简体) ) - 重新设置的地图特定选项的密钥 - `layerOptionKeys?` (单位:千美元) `| Array< | keyof SpecificTriangulatedWarpedMapOptions | keyof SpecificWebGL2WarpedMapOptions | keyof WarpedMapOptions > | undefined`(中文(简体) ) - 重设层选项的密钥 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#resetMapsOptions(mapIds, mapsOptionKeys, animationOptions)` 重置指定地图的地图选项 选择 `mapsOptionKeys` 重新设置所有选项; 通过空的数组重新设置 . ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 重新设置选项的地图的标识 - `mapsOptionKeys?` (单位:千美元) `| Array< | keyof SpecificTriangulatedWarpedMapOptions | keyof SpecificWebGL2WarpedMapOptions | keyof WarpedMapOptions > | undefined`(中文(简体) ) - 重设选项的密钥 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#sendMapsBackward(mapIds)` 向后发送地图 ###### 参数 - `mapIds` (单位:千美元)`Iterable`(中文(简体) ) - 地图的标识 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#sendMapsToBack(mapIds)` 向后发送地图 ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 地图的标识 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setLayerOptions(layerOptions, animationOptions)` 设置层选项 没有设置渲染选项或特定的扭曲图层选项 。 使用设置选项( ) . ###### 参数 - `layerOptions?` (单位:千美元)`Partial> | undefined`(中文(简体) ) - 要设置的层选项 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ```js warpedMapLayer.setLayerOptions({ transformationType: 'thinPlateSpline' }) ``` ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setLayerTransformationType(transformationType, animationOptions)` 设置层的转换类型 ###### 参数 - `transformationType?` (单位:千美元)`TransformationType | undefined`(中文(简体) ) - 要设置的转换类型 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setMapGcps(mapId, gcps, animationOptions)` 设置地图的 GCP 仅设定地图 `gcps` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从地理参考注释中推断出的原始GCP. 原GCP可以通过重置地图特定GCP选项来重置,, 在被扭曲的地图上可以访问 `map` 属性. ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 设置选项的映射ID - `gcps` (单位:千美元)`Array`(中文(简体) ) - 要设定的 GCP - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setMapOptions(mapId, mapOptions, animationOptions)` 设定地图的特定选项 一般设置地图专用选项 还设置了地图的相应选项, 由于这些是合并默认,地理参照地图的结果, 该地图的分层和特定地图选项. 一个特殊的情况是设置一个特定的地图选项 `undefined`数字 : 然后从默认、地理参考地图或层选项中得出相应的选项. 这相当于对地图特定选项使用重置函数. ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 设置选项的映射ID - `mapOptions` (单位:千美元)`{ fetchFn?: FetchFn | undefined; gcps?: Array | undefined; resourceMask?: Ring | undefined; transformationType?: TransformationType | undefined; ... 59 more ...; debugTiles?: boolean | undefined; }`(中文(简体) ) - 要设置的地图选项 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ###### 实例 ```ts warpedMapLayer.setMapOptions(myMapId, { transformationType: 'thinPlateSpline' }) ``` ### `BaseWarpedMapLayer#setMapResourceMask(mapId, resourceMask, animationOptions)` 设置地图的资源掩码 仅设定地图 `resourceMask` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从地理参考注释推断出来的原始资源掩码 . 原始资源掩码可以通过重置地图特定资源掩码选项来重置, , 并保留在被扭曲的地图中 `map` 属性. ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 设置选项的映射ID - `resourceMask` (单位:千美元)`Array`(中文(简体) ) - 要设置的资源掩码 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setMapTransformationType(mapId, transformationType, animationOptions)` 设定地图的转换类型 仅设定地图 `transformationType` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从"地理参考注释"推断出来的原始变换类型. 原变换类型可以通过重置地图特定变换类型选项来重置,, 并保留在被扭曲的地图中 `map` 属性. ###### 参数 - `mapId` (单位:千美元)`string`(中文(简体) ) - 设置选项的映射ID - `transformationType?` (单位:千美元)`TransformationType | undefined`(中文(简体) ) - 要设置的转换类型 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setMapsAndLayerOptions(mapIds, mapsOptions, layerOptions, animationOptions)` 设置指定地图的地图特定选项和图层选项 当地图特定选项一并更改多个地图时有用, 与图层选项一起,但只应发射一款动画. 没有设置渲染选项或特定的扭曲图层选项 。 使用设置选项( ) . ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 选择设置的地图的标识 - `mapsOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 适用于每个地图的地图特定选项 - `layerOptions?` (单位:千美元)`Partial> | undefined`(中文(简体) ) - 要应用的层选项 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ###### 实例 ```ts warpedMapLayer.setMapsAndLayerOptions([myMapId], { transformationType: 'thinPlateSpline' }, { visible: true }) ``` ### `BaseWarpedMapLayer#setMapsOptions(mapIds, mapsOptions, animationOptions)` 设置特定地图的地图选项 一般设置地图专用选项 还设置了地图的相应选项, 由于这些是合并默认,地理参照地图的结果, 该地图的分层和特定地图选项. 一个特殊的情况是设置一个特定的地图选项 `undefined`数字 : 然后从默认、地理参考地图或层选项中得出相应的选项. 这相当于对地图特定选项使用重置函数. 当地图特定选项一并更改多个地图时有用, 但应该只开一出动画片. ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 选择设置的地图的地图标识 - `mapsOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 适用于每个地图的地图特定选项 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ###### 实例 ```ts warpedMapLayer.setMapsOptions([myMapId], { transformationType: 'thinPlateSpline' }) ``` ### `BaseWarpedMapLayer#setMapsTransformationType(mapIds, transformationType, animationOptions)` 设定地图的转换类型 仅设定地图 `transformationType` 选项 (或更具体地说用于渲染的被扭曲的地图), 覆盖从"地理参考注释"推断出来的原始变换类型. 原变换类型可以通过重置地图特定变换类型选项来重置,, 并保留在被扭曲的地图中 `map` 属性. ###### 参数 - `mapIds` (单位:千美元)`Array`(中文(简体) ) - 设置选项的映射ID - `transformationType?` (单位:千美元)`TransformationType | undefined`(中文(简体) ) - 要设置的转换类型 - `animationOptions?` (单位:千美元)`Partial | undefined`(中文(简体) ) - 动画选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setOpacity(opacity)` 设置层不透明 ###### 参数 - `opacity` (单位:千美元)`number`(中文(简体) ) - 要设置的层不透明 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer#setOptions(options)` 设置选项 ###### 参数 - `options?` (单位:千美元) `| Partial | Partial | undefined`(中文(简体) ) - 要设置的选项 ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer.assertCanvas(canvas)` ###### 参数 - `canvas?` (单位:千美元)`HTMLCanvasElement | undefined`(中文(简体) ) ###### 回返 `void`。 。 。 . ### `BaseWarpedMapLayer.assertRenderer(renderer)` ###### 参数 - `renderer?` (单位:千美元)`WebGL2Renderer | undefined`(中文(简体) ) ###### 回返 `void`。 。 。 . ## 常见问题 ### @allmaps/warpedmaplayer 是什么？ Allmaps 的基础插件类 ### 如何安装 @allmaps/warpedmaplayer？ 在项目目录运行 npm install @allmaps/warpedmaplayer，或使用 pnpm add / yarn add / bun add。 ### @allmaps/warpedmaplayer 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/allmaps\_\_warpedmaplayer 是否存在。 ### @allmaps/warpedmaplayer 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @allmaps/warpedmaplayer 可以商用吗？ @allmaps/warpedmaplayer 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @allmaps/warpedmaplayer 的下载量有多少？ 根据 npm 官方下载统计，@allmaps/warpedmaplayer 在 2026/10/06 – 2026/11/04 这 30 天内被下载 8,431 次，日均约 281 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @allmaps/warpedmaplayer 还在维护吗？ 最新版本 1\.0\.0-beta\.44 发布于 2026/09/22（1 个月前）；至今共发布 6 个版本，其中过去 12 个月发布了 6 个；首次发布于 2025/11/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。