@reearth / visualizer-plugin-api
的TypeScript类型定义 再保险:地球可视化工具 插件API。
安装
npm install --save-dev @reearth/visualizer-plugin-api @reearth/[email protected]
# or
yarn add -D @reearth/visualizer-plugin-api @reearth/[email protected]
@reearth/core 是一个对等依赖，固定在Visualizer运行的版本上(0.0.7-alpha.81)。安装准确的版本，而不是 latest，因此类型与Visualizer匹配。把它和这个包一起安装，这样TypeScript就可以解析声明中使用的层和特性类型。
注意： @reearth/core 它带来了React和Cesium（大约350个包），仅用于类型导入。
使用
创建一个 reearth.d.ts 插件项目中的文件：
import type { Reearth } from "@reearth/visualizer-plugin-api";
declare global {
const reearth: Reearth;
}
然后使用 reearth 使用完整的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/[email protected] 对应于插件API版本2.1.0。
当插件API版本出现问题时，将发布具有相同版本号的此包的新版本。
看到 CHANGELOG.md 完整的历史。
真相的来源
这个包是插件API类型的唯一真实来源。Visualizer网页应用程序(web/)从这里导入它们，所以没有第二个副本来保持同步。要更改API类型：
- 编辑
visualizer-plugin-api/src，把版本塞进去package.json，并更新CHANGELOG.md. - 发布软件包（见下文）。
- 更新
@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可信发布 ——不 NPM_TOKEN 需要的。
一次性SRE设置
- 创建
npm-publish环境在这个GitHub repo与所需的审稿人（设置→环境→新环境）。限制部署参考标签匹配visualizer-plugin-api-v*. - 在npmjs.com上配置OIDC可信发布
@reearth/visualizer-plugin-api：- 存储库:
reearth/reearth-visualizer - 工作流文件名:
plugin_api_release.yml - 环境:
npm-publish
- 存储库:
首次发布（手动-仅一次）
在可信发布接管之前，必须在注册表上声明包名称：
cd visualizer-plugin-api
npm publish --access public
后续版本
- 插入版本
visualizer-plugin-api/package.json和更新CHANGELOG.md. - 转到GitHub Actions→ 发布@reearth / visualizer-plugin-api → 运行工作流.
- 输入版本号（必须匹配）
package.json)并确认。 - 审批手动闸门
npm-publish环境。
许可证
apache - 2.0