# @reearth/visualizer-plugin-api 中文文档

规范地址：https://npmcn.com/package/%40reearth/visualizer-plugin-api/

版本：2\.1\.0
npm 元数据更新时间：2026-11-02T06:07:16.036Z
中文译文更新时间：2026-11-02T07:45:20.376Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40reearth/visualizer-plugin-api
原文对照：https://npmcn.com/package/%40reearth/visualizer-plugin-api/?lang=original

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

- 包体积（解压后）：29.9 kB，17 个文件
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@reearth/core 0\.0\.7-alpha\.81
- 首次发布：2026-11-02T06:06:19.806Z
- 最新版本发布：2026-11-02T06:07:15.846Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

reearth Visualizer插件API的TypeScript类型定义

## 安装

```sh
npm install @reearth/visualizer-plugin-api
```

也可以使用：`pnpm add @reearth/visualizer-plugin-api`、`yarn add @reearth/visualizer-plugin-api`、`bun add @reearth/visualizer-plugin-api`

## README

# @reearth / visualizer-plugin-api

的TypeScript类型定义 [再保险:地球可视化工具](https://github.com/reearth/reearth-visualizer) 插件API。

## 安装

```bash
npm install --save-dev @reearth/visualizer-plugin-api @reearth/core@0.0.7-alpha.81
# or
yarn add -D @reearth/visualizer-plugin-api @reearth/core@0.0.7-alpha.81
```

`@reearth/core` 是一个对等依赖，固定在Visualizer运行的版本上(`0.0.7-alpha.81`)。安装准确的版本，而不是 `latest`，因此类型与Visualizer匹配。把它和这个包一起安装，这样TypeScript就可以解析声明中使用的层和特性类型。

注意： `@reearth/core` 它带来了React和Cesium（大约350个包），仅用于类型导入。

## 使用

创建一个 `reearth.d.ts` 插件项目中的文件：

```typescript
import type { Reearth } from "@reearth/visualizer-plugin-api";

declare global {
  const reearth: Reearth;
}
```

然后使用 `reearth` 使用完整的TypeScript智能感知：

```typescript
reearth.camera.flyTo({ lat: 35.68, lng: 139.76, height: 1000 });
reearth.layers.show("layer-id");
reearth.ui.show("<h1>Hello from plugin</h1>");
reearth.camera.on("move", (pos) => console.log(pos.lat, pos.lng));
```

## API概述

| 名称空间 | 描述 |
| --- | --- |
| `reearth.camera` | 相机控制：飞向，看向，缩放，旋转，事件 |
| `reearth.layers` | 图层管理：添加，删除，查找，选择，覆盖 |
| `reearth.viewer` | 视窗，工具，坐标转换，交互模式 |
| `reearth.timeline` | 播放控制：播放，暂停，setTime, setSpeed |
| `reearth.sketch` | 绘图工具：记号笔、折线、多边形、矩形 |
| `reearth.ui` | 插件面板：显示HTML， postMessage，调整大小 |
| `reearth.modal` | 模态对话框：显示、更新、关闭 |
| `reearth.popup` | 弹出窗口：显示、更新、定位、关闭 |
| `reearth.extension` | 插件间消息传递，小部件/块上下文 |
| `reearth.data` | 客户端持久存储 |
| `reearth.spatialId` | 高原空间ID采集 |
| `reearth.engine` | 渲染引擎元数据 |

## 打印稿配置

添加 `"skipLibCheck": true` 到你的 `tsconfig.json`． 这个包取决于 `@reearth/core`， 它在内部引用React和铯类型。没有 `skipLibCheck`传递的 声明会在没有直接安装React或铯类型的项目中导致错误。

## 版本控制

此包版本直接跟踪Re:Earth插件API版本。 `@reearth/visualizer-plugin-api@2.1.0` 对应于插件API版本2.1.0。 当插件API版本出现问题时，将发布具有相同版本号的此包的新版本。

看到 [CHANGELOG.md](https://npmcn.com/package/%40reearth/visualizer-plugin-api/CHANGELOG.md) 完整的历史。

## 真相的来源

这个包是插件API类型的唯一真实来源。Visualizer网页应用程序(`web/`)从这里导入它们，所以没有第二个副本来保持同步。要更改API类型：

1.  编辑 `visualizer-plugin-api/src`，把版本塞进去 `package.json`，并更新 `CHANGELOG.md`.
2.  发布软件包（见下文）。
3.  更新 `@reearth/visualizer-plugin-api` 版本 `web/package.json` 和运行 `yarn install`.

试着改变 `web/` 在发布之前，构建包(`npm run build`)和点 `web` 用… `yarn add @reearth/visualizer-plugin-api@portal:../visualizer-plugin-api`． 不要犯那样的罪；web Dockerfile只能从 `web/`.

当 `@reearth/core` 是在 `web/`，在这里升级固定的对等版本并发布。

## 释放

发布使用 [npm OIDC可信发布](https://docs.npmjs.com/generating-provenance-statements) ——不 `NPM_TOKEN` 需要的。

### 一次性SRE设置

1.  创建 `npm-publish` 环境在这个GitHub repo与所需的审稿人（设置→环境→新环境）。限制部署参考标签匹配 `visualizer-plugin-api-v*`.
2.  在npmjs.com上配置OIDC可信发布 `@reearth/visualizer-plugin-api`：
    -   存储库: `reearth/reearth-visualizer`
    -   工作流文件名: `plugin_api_release.yml`
    -   环境: `npm-publish`

### 首次发布（手动-仅一次）

在可信发布接管之前，必须在注册表上声明包名称：

```bash
cd visualizer-plugin-api
npm publish --access public
```

### 后续版本

1.  插入版本 `visualizer-plugin-api/package.json` 和更新 `CHANGELOG.md`.
2.  转到GitHub Actions→ **发布@reearth / visualizer-plugin-api** → **运行工作流**.
3.  输入版本号（必须匹配） `package.json`)并确认。
4.  审批手动闸门 `npm-publish` 环境。

## 许可证

apache - 2.0

## 常见问题

### @reearth/visualizer-plugin-api 是什么？

reearth Visualizer插件API的TypeScript类型定义

### 如何安装 @reearth/visualizer-plugin-api？

在项目目录运行 npm install @reearth/visualizer-plugin-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@reearth/core（0\.0\.7-alpha\.81）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @reearth/visualizer-plugin-api 支持 TypeScript 吗？

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

### @reearth/visualizer-plugin-api 可以商用吗？

@reearth/visualizer-plugin-api 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @reearth/visualizer-plugin-api 还在维护吗？

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