@geolibre/嵌入
驱动一个无依赖的打字客户端 地理图书馆
嵌入到一个 <iframe> 从它的一页.
URL 参数配置 GeoLibre 嵌入一次, 装入时 。 这个包是给
之后的一切:飞去唱片 刚刚有人点击你的UI,
切换图层, 应用过滤器, 将地图导出为 PNG, 并听到用户的内容
在地图内。 它说出GeoLibre的版本 postMessage 协议,以及
手动处理容易出错的两个部分:
将每个命令,与它相配
有几个可以马上飞去.
源回波 : 开源软件国际化之简体中文组编辑 软件包版本跟踪应用程序版本,因为两艘船都来自同一版本.
安装
npm install @geolibre/embed
使用量
import { connect } from "@geolibre/embed";
const iframe = document.querySelector("iframe");
const map = await connect(iframe, { origin: "https://gis.example.com" });
await map.setView({ center: [-95.7, 37.1], zoom: 5 });
await map.setLayerVisibility("roads", false);
const layers = await map.listLayers();
console.log(layers.map((layer) => layer.name));
map.on("selectionChanged", ({ featureIds }) => showRecordFor(featureIds[0]));
connect 一旦应用程序报告它准备好了就解决,所以没有
握起手来写自己。 通过 应用程序 源头,不是你自己的:两者都是
每条出入境信息的目标 以及入境信息的过滤器.
API 密码
connect(iframe, options) → Promise<GeoLibreEmbedClient>
| 选项 | 默认 | 说明 |
|---|---|---|
origin | —— 说 | 要求。 准确的源码托管应用程序 . |
timeoutMs | 15000个 | 等多长时间 ready。 。 。 . |
requestTimeoutMs | 15000个 | 每令等多时. |
| 方法 | 决定: |
|---|---|
loadProject(url) | void |
setView(target) | void |
highlightFeature({ layerId, … }) | void |
openTool(id, params?) | void |
setLayerVisibility(layerId, visible) | void |
listLayers() | LayerSummary[] |
setFilter(layerId, expression) | void |
getViewport() | Viewport |
addLayer(spec) | 新层 id |
addData(url, options?) | 新层 id编号 |
exportImage() | a 巴布亚新几内亚 data: 網址 |
getLayerFeatures(layerId) | EmbedFeature[] |
getDrawnFeatures() | EmbedFeature[] |
on(event, listener) | 未订阅函数 |
disconnect() | 没有承诺 |
命令拒绝而不是错误地解决:被拒绝的请求以
应用程序本身的错误信息, 以及一个无法解答的错误信息
暂停 。 打电话 disconnect() 当iframe离开, 所以一个等待的诺言
无法挂起页面的生命.
活动 : ready, (中文(简体) ), ack, (中文(简体) ), projectLoaded, (中文(简体) ), selectionChanged, (中文(简体) ), viewChanged, (中文(简体) ),
toolCompleted, (中文(简体) ), serverFileWritten, (中文(简体) ), featuresChanged。 。 。 .
一个希望用户绘制应用程序加载的主机 layout=viewer&draw,哪个
让几何编辑器运行在其它只读的查看器中(添加)
plugin=geo-editor ; 部署需要
project:edit 绘制和阅读下面的图画的能力也需要
在嵌入式许可列表和 export:data 能力.
getLayerFeatures(layerId) 财务报告和审定财务报表 getDrawnFeatures() 回读特性
(确切位置为所储存). 它们反映了插件 API getLayerFeatures 财务报告和审定财务报表
getDrawnFeatures 和 Python 部件 get_features 财务报告和审定财务报表
get_drawn_features。 。 。 . getDrawnFeatures 返回用户的自由绘图(全部)
Sketches 分层组合; 如果未绘制空数组 。 他们拒绝
用于未知的图层, 当部署否认时 export:data层
持有不包含内存特性( 鼠标、 瓦片、 远程矢量源) 返回
空阵列,所以空阵列表示"没有内相特性"(空出地层,
或光栅、瓦片或远程源);层 type 不告诉这些
分开 已删除的层拒绝 . featuresChanged (单位:千美元){ layerId, featureCount, removed? }(中文(简体) )
每层被解开的火 当层的内质特征收集
替换(绘制、编辑、属性编辑、刷新、后入数据;可能
火而不改变内容),同时使用 removed: true 在这样的时候
层被删除。 它不会被发送到整个项目负载( 使用 ) projectLoaded(中文(简体) )
需求 export:data数字 :
map.on("featuresChanged", async ({ layerId, removed }) => {
if (removed) {
// The layer is gone and getLayerFeatures would reject: drop your copy.
return;
}
const features = await map.getLayerFeatures(layerId);
});
API 关闭, 除非部署选择使用
GeoLibre 的部署忽略了此协议, 直到它命名其来源为止 信任,所以一个公共实例永远不能被任何页面框架所驱动. 对于一个环境变量的多克图像:
docker run --rm -p 8080:80 \
-e GEOLIBRE_EMBED_ORIGINS="https://portal.example.com" \
ghcr.io/opengeos/geolibre:latest
静态建筑,用它烤入
VITE_GEOLIBRE_EMBED_ORIGINS="https://portal.example.com" npm run build。 。 。 .
公众 web.geolibre.app 构建没有允许列表, 因此运行时间 API 用于
您自己的主机部署.
文档
见 嵌入和共享 联 合 国
允许列表、 URL 参数、 完整协议引用和原始
postMessage 以不愿依赖的主机为例.
许可证
麻省理工学院