@geoblocks/print

中文文档
0.7.9发布于 2024/08/12BSD-2-ClauseTypeScriptES Module零依赖近 30 天下载 4961

This project provides low level functionalities for rendering OpenLayers layers to images of arbitrary resolution.

原始使用文档
文档目录3 节
  1. Demo
  2. Using
  3. Contributing

Geoblocks print

This project provides low level functionalities for rendering OpenLayers layers to images of arbitrary resolution.

Supported layers:

  • Mapbox Vector Tiles (MVT);

Supported styles:

  • plain OpenLayers style functions;
  • MapBox style processed by the ol-mapbox-style library.

Supported rendering methods:

  • OpenLayers render API (feature complete, default);
  • OpenLayers immediate API (basic, enable with MVTEncoder.useImmediateAPI = true).

Demo

https://geoblocks.github.io/print

image

Using

npm i @geoblocks/print
import MVTEncoder from '@geoblocks/print';
const r = await new MVTEncoder().encodeMVTLayer({
  layer, // a plain OpenLayers MVT layer
  tileResolution, // the resolution to use for fetching features
  styleResolution, // the resolution to use for styling features
  printExtent, // the extent to print
  canvasSize, // the target size in dots of the rendered layer (depends of the dpi)
});

The result is tiled so that each image is reasonably big. Each tile result contains:

  • a base64 encoded image: r[i].baseURL;
  • the OL extent for this image: r[i].extent.

Contributing

contributing

版本与发布记录

@geoblocks/print 共发布 11 个版本,首次发布于 2021/10/14;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.7.9latest2024/08/122 年前
0.7.82024/03/192 年前
0.7.72024/03/192 年前
0.7.52024/03/152 年前
0.7.42023/09/053 年前
0.7.32022/09/124 年前

关于 @geoblocks/print 的常见问题

@geoblocks/print 是什么?

This project provides low level functionalities for rendering OpenLayers layers to images of arbitrary resolution.

如何安装 @geoblocks/print?

在项目目录运行 npm install @geoblocks/print,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:ol(7 || 8 || 9 || 10)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@geoblocks/print 支持 TypeScript 吗?

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

@geoblocks/print 支持 ESM 还是 CommonJS?

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

@geoblocks/print 可以商用吗?

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

@geoblocks/print 的下载量有多少?

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

@geoblocks/print 还在维护吗?

最新版本 0.7.9 发布于 2024/08/12(2 年前);至今共发布 11 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/10/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。