gis-view-webgl2 0.1.8 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -5
- package/dist/gis-view.css +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +214 -14
- package/dist/index.js +1 -1
- package/docs/AI/345/257/271/350/257/235/346/261/207/346/200/273.md +65 -547
- package/docs/GisView.md +1 -1
- package/docs/GisView/345/256/236/347/216/260/345/216/237/347/220/206.md +1 -1
- package/docs/ai/06-/344/274/232/350/257/235/347/264/242/345/274/225/344/270/216/345/244/215/346/237/245/346/226/271/346/263/225.md +114 -526
- package/docs/demos/BasicDemo.vue +142 -25
- package/docs/demos/BatchAddDemo.vue +127 -1
- package/docs/demos/ChannelDemo.vue +61 -0
- package/docs/demos/CopyMergeDemo.vue +125 -36
- package/docs/demos/EventDemo.vue +12 -4
- package/docs/demos/api-index.js +26 -16
- package/docs/format/02-/350/212/202/347/202/271/344/270/216/347/272/277/350/267/257.md +1 -0
- package/docs/format/04-/351/200/232/351/201/223/344/270/216/346/240/207/347/255/276.md +3 -0
- package/docs/index.html +136 -13
- package/docs/internals/15-04-/351/200/220/350/275/256/350/256/260/345/275/225-/347/203/255/345/212/233/345/233/276/344/270/216/346/200/247/350/203/275.md +10 -0
- package/docs/manual/03-/351/205/215/347/275/256/351/241/271.md +82 -14
- package/docs/manual/04-/344/272/213/344/273/266/344/270/216/345/233/236/350/260/203.md +2 -1
- package/docs/manual/05-/347/224/273/350/264/250/344/270/216/346/211/271/351/207/217/346/233/264/346/226/260.md +65 -0
- package/docs/manual/07-/346/214/207/351/222/210/344/270/216/350/246/201/347/264/240/347/274/226/350/276/221.md +48 -11
- package/docs/manual/08-/351/200/211/344/270/255/344/270/216/346/213/220/347/202/271.md +8 -4
- package/docs/manual/09-/351/200/232/351/201/223/344/270/216/345/244/232/345/233/236/347/272/277.md +57 -0
- package/docs/manual/12-/346/240/207/347/255/276/344/270/216/350/243/205/351/245/260.md +26 -3
- package/docs/manual/14-/350/247/206/345/233/276/344/270/216/347/255/233/351/200/211.md +34 -1
- package/docs/manual/15-/345/257/274/345/207/272/344/270/216/351/233/206/346/210/220.md +5 -2
- package/docs/manual/16-/345/256/236/344/276/213/346/226/271/346/263/225/346/200/273/350/241/250.md +13 -10
- package/docs/manual/17-/345/217/202/346/225/260/351/200/237/346/237/245.md +14 -8
- package/docs/manual/18-/351/200/220/346/226/271/346/263/225/347/244/272/344/276/213.md +43 -3
- package/docs/manual/20-/346/200/247/350/203/275/344/270/216/345/244/247/346/225/260/346/215/256.md +3 -1
- package/docs/manual/21-/350/257/264/346/230/216/344/270/216/345/270/270/350/247/201/351/227/256/351/242/230.md +5 -2
- package/docs/steps/README.md +200 -121
- package/docs/steps/index.html +216 -0
- package/docs/steps/selftest-demos.html +209 -31
- package/docs/steps/selftest-docs.html +17 -6
- package/docs/steps/selftest-features.html +311 -3
- package/docs/steps/selftest-labels.html +81 -0
- package/docs/steps/selftest-perf.html +31 -3
- package/docs/steps/selftest-select.html +51 -1
- package/docs//344/273/2160/345/210/260/345/256/214/346/225/264/347/232/204/345/256/236/347/216/260.md +1 -0
- package/package.json +1 -1
- package/docs/ai/01-/350/265/267/346/272/220/344/270/216/350/277/231/344/273/275/346/261/207/346/200/273/347/232/204/347/224/261/346/235/245.md +0 -29
- package/docs/ai/02-/346/214/211/345/206/205/345/256/271/345/210/206/347/261/273-/350/277/231/344/270/200/350/267/257/351/203/275/345/234/250/346/224/271/344/273/200/344/271/210.md +0 -66
- package/docs/ai/03-/351/207/215/350/246/201/351/227/256/347/255/224/351/200/211/357/274/210/344/270/200/357/274/211/357/274/232/351/200/211/345/236/213/351/200/232/351/201/223/344/270/216/346/240/267/345/274/217.md +0 -178
- package/docs/ai/04-/351/207/215/350/246/201/351/227/256/347/255/224/351/200/211/357/274/210/344/272/214/357/274/211/357/274/232/344/272/244/344/272/222/346/200/247/350/203/275/344/270/216/346/225/260/346/215/256.md +0 -140
- package/docs/ai/05-/351/207/215/350/246/201/351/227/256/347/255/224/351/200/211/357/274/210/344/270/211/357/274/211/357/274/232/345/256/277/344/270/273/346/227/201/346/224/257/344/270/216/346/224/266/345/217/243.md +0 -43
package/docs/demos/api-index.js
CHANGED
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
* 源码或文档改过之后重跑一遍;`node docs/steps/check-doc-coverage.mjs` 会对账。
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
|
-
/** { members:
|
|
11
|
-
export const API_SUMMARY = {"members":
|
|
10
|
+
/** { members: 273, methods: 268, properties: 5, options: 100, sections: 16 } */
|
|
11
|
+
export const API_SUMMARY = {"members":273,"methods":268,"properties":5,"options":100,"sections":16}
|
|
12
12
|
|
|
13
13
|
/** 实例成员,按 docs/GisView.md「参数速查」的分组排 */
|
|
14
14
|
export const API_SECTIONS = [
|
|
@@ -30,12 +30,12 @@ export const API_SECTIONS = [
|
|
|
30
30
|
{ name: "updateBackground", kind: "method", params: "background?: GisViewBackground 新的背景层(底色 / 图片 / GeoJSON);不传等于清掉", returns: "this", doc: "替换背景层", examples: [{"group":"配置与数据","code":"// updateBackground(background?):换背景层(底色 / 图片 / GeoJSON);不传等于清掉\nview.updateBackground({ color: '#0d1b2a', image: { src: '/basemap.png' } })\nview.updateBackground()\n","from":"header"}] },
|
|
31
31
|
{ name: "getResolvedBackground", kind: "method", params: "无", returns: "GisViewResolvedBackground", doc: "引擎解析后的背景层:{ color, image: { quad, texture, source, opacity }, geoJson: { regions, labels, bounds, rawBounds, fillBuckets, strokeGroups, pointGroups } },自建缩略图 / 图例 / 取真实范围都用它", examples: [{"group":"配置与数据","code":"// getResolvedBackground() / getBackgroundLabels():背景层解析后的读数 / GeoJSON 区域文字的清单\nconst background = view.getResolvedBackground()\nconst backgroundLabels = view.getBackgroundLabels()\n","from":"header"}] },
|
|
32
32
|
{ name: "getBackgroundLabels", kind: "method", params: "无", returns: "GisViewResolvedBackgroundLabel[] | null", doc: "背景 GeoJSON 的区域文字(世界坐标 + 字号 / 颜色 / 偏移),自建覆盖层用", examples: [{"group":"配置与数据","code":"// getResolvedBackground() / getBackgroundLabels():背景层解析后的读数 / GeoJSON 区域文字的清单\nconst background = view.getResolvedBackground()\nconst backgroundLabels = view.getBackgroundLabels()\n","from":"header"}] },
|
|
33
|
-
{ name: "batch", kind: "method", params: "fn: () => T
|
|
33
|
+
{ name: "batch", kind: "method", params: "fn: () => T 这一批里要做的增删改 / 分组操作(内部调 patchPoints / patchLines / updateChannel、removePoints / removeLines / removeChannel、splitChannelGroups / removeChannelGroup 等都会收成一条);options.label?: string 给这一步历史起名", returns: "fn 的返回值", doc: "批量增删改:回调里的连续改动(patchPoints / patchLines / updateChannel、removePoints / removeLines / removeChannel、分组拆分 / 删除 / 新增等)收成一条 onDataChange(type: 'batch',changes 按调用顺序列出每一步)与一步历史,options.label 给这一步起名;收尾时筛选只重算一次、标签重排 / 提示框 / 鹰眼图各补一次(onFilter 也只发一条),可以嵌套(只有最外层收尾),见「批量更新」", examples: [{"group":"配置与数据","code":"// batch(fn, options?):一批改动收成一条数据变更、历史里一步\nview.batch(() => {\n view.updatePoint('a', { x: 10 })\n view.updateLine('l1', { width: 2 })\n}, { label: '挪站并加粗' })\n","from":"header"}] },
|
|
34
34
|
{ name: "resize", kind: "method", params: "无(改过祖先 transform: scale / 容器尺寸后手动同步一次;CSS zoom 会自动感知)", returns: "this", doc: "手动同步尺寸 / 重新应用配置并重绘(refresh({ reflow: false }) 只重画一帧,不重解析数据与配置);容器尺寸或祖先的 transform: scale 变过之后要调一次 resize() 同步(CSS zoom 会自己感知)", examples: [{"group":"配置与数据","code":"// resize():容器尺寸变过(祖先 transform: scale、display 切换)之后手动同步一次\nwindow.addEventListener('resize', () => view.resize())\n","from":"header"}] },
|
|
35
35
|
{ name: "refresh", kind: "method", params: "options?: { reflow?: boolean } 传 false 只重画一帧(跳过整份重解析:数据没变、只想重画时用);不传或 true 走整份重建", returns: "this", doc: "手动同步尺寸 / 重新应用配置并重绘(refresh({ reflow: false }) 只重画一帧,不重解析数据与配置);容器尺寸或祖先的 transform: scale 变过之后要调一次 resize() 同步(CSS zoom 会自己感知)", examples: [{"group":"配置与数据","code":"// refresh(options?):整份重建;refresh({ reflow: false }) 只重画一帧\nview.refresh()\nview.refresh({ reflow: false })\n","from":"header"}] },
|
|
36
36
|
{ name: "whenRendered", kind: "method", params: "等下一帧画完(Promise):兑现那一帧的载荷(frame 是帧序号,type / changes / counts 说明这一帧带上了哪几次数据变更);引擎下一次渲染结束时兑现,视图销毁时兑现 null", returns: "Promise<GisViewDataRenderedPayload | null>", doc: "/** * 等下一帧画完(Promise)。", examples: [{"group":"配置与数据","code":"// whenRendered():等下一帧画完(载荷是这一帧的读数:frame / type / changes / counts)\nconst frame = await view.whenRendered()\n","from":"header"}] },
|
|
37
37
|
{ name: "whenDataRendered", kind: "method", params: "等「刚换的这一份数据画出来」(Promise):有挂起的数据变更时与 whenRendered 同一条路;没有挂起的变更时立刻兑现 null。view.updateData(payload); await view.whenDataRendered(); loading = false 是收 loading 的标准写法", returns: "Promise<GisViewDataRenderedPayload | null>", doc: "/** * 等「刚换的这一份数据画出来」(Promise)。", examples: [{"group":"配置与数据","code":"// whenDataRendered():等「刚换的这份数据画完」—— 收 loading 遮罩的标准写法\nview.updateData(nextPoints, nextLines)\nawait view.whenDataRendered()\n","from":"header"}] },
|
|
38
|
-
{ name: "snapshotScene", kind: "method", params: "options?: GisViewSceneSnapshotOptions 快照选项(要哪些读数 / 哪些数据)", returns: "GisViewSceneSnapshot | null", doc: "当前画面的矢量快照(屏幕坐标的线 / 点 / 标签 / 背景 / 网格):{ width, height, background, backgroundImage, grid, regions, lines, points, backgroundPoints, decorations, waypoints, raised, labels }
|
|
38
|
+
{ name: "snapshotScene", kind: "method", params: "options?: GisViewSceneSnapshotOptions 快照选项(要哪些读数 / 哪些数据)", returns: "GisViewSceneSnapshot | null", doc: "当前画面的矢量快照(屏幕坐标的线 / 点 / 标签 / 背景 / 网格):{ width, height, background, backgroundImage, grid, regions, lines, raisedLines, points, backgroundPoints, decorations, waypoints, raised, labels };raisedLines 是抬层的选中线路 / 通道,导出时排在普通节点之后、raised 端点节点之前。options.background: false 丢背景、options.backgroundColor 只换底色、options.labels 原样带进去,见「导出图片」", examples: [{"group":"配置与数据","code":"// snapshotScene(options?):一次取全画布读数 / 数据快照(矢量导出、单测都用它;raisedLines 是抬层线路)\nconst snapshot = view.snapshotScene()\nconst white = view.snapshotScene({ background: '#ffffff' })\n","from":"header"}] },
|
|
39
39
|
{ name: "destroy", kind: "method", params: "无", returns: "无", doc: "销毁引擎并移除根节点", examples: [{"group":"配置与数据","code":"// destroy():卸载(事件、观察器、WebGL 上下文一起清)\nview.destroy()","from":"header"}] },
|
|
40
40
|
]
|
|
41
41
|
},
|
|
@@ -55,10 +55,15 @@ export const API_SECTIONS = [
|
|
|
55
55
|
{ name: "flyToCamera", kind: "method", params: "camera: GisViewCameraTarget 直接给相机目标 { center?, scale? }:没写 center / scale 的那一项沿用当前相机,不经过要素解析,也不改选中与数据;options?: GisViewFlyCameraOptions 的 duration / easing 与 flyTo 同义。中心 / 比例插值、减少动态效果、用户手势取消都走同一条相机动画", returns: "this(相机变化时发 onCameraChange;目标非法时保持当前相机)", doc: "直接飞到相机目标 { center?, scale? }:不写的那一项沿用当前相机,不经过要素解析、也不改选中与数据;duration / easing 与 flyTo 同义,参数非法时保持当前相机", examples: [{"group":"相机与视图","code":"// flyToCamera(camera, options?):直接飞相机目标;没写的 center / scale 沿用当前相机\nview.flyToCamera({ center: [120, 80], scale: 3 }, { duration: 600, easing: 'ease-out' })\nview.flyToCamera({ scale: 5 }, { duration: 0 }) // 中心不动,比例立即落到 5\nview.flyToCamera({ center: [116.4, 39.9] }) // 比例沿用当前相机\n","from":"header"}] },
|
|
56
56
|
{ name: "search", kind: "method", params: "input: string | GisViewSearchOptions 关键字,或 { keyword, scope, fields, limit } 这类选项。scope 可选 'points' / 'lines' / 'channels' / 'groups',也认与 focusOn 一致的单数别名 'point' / 'line' / 'channel' / 'group' 及数组;省略或写错时四类全搜。limit 对每一类分别计数。返回的 groups / hits 带分组命中(channelIndex / groupId / groupIndex,item 是轻量快照)—— 只返回结果、不动视角,要定位就自己调 focusOn(result.hits, …)", returns: "GisViewSearchResult:keyword / scope / points / lines / channels / groups / hits / total / truncated / durationMs", doc: "按关键字搜索节点 / 线路 / 通道 / 通道分组并返回命中:scope 认复数的 points / lines / channels / groups,也认与 focusOn 一致的单数别名 point / line / channel / group;结果分 points / lines / channels / groups 四类,分组命中带 channelIndex / groupId / groupIndex,可直接交给 focusOn / selectFeatures。不动视角:要不要聚焦由调用方自己调 focusOn,见「搜索与定位」", examples: [{"group":"相机与视图","code":"// search(input) / searchAsync(input):搜索(只返回结果、不动视角)\nconst hits = view.search('甲站')\nconst scoped = view.search({ keyword: '甲', scope: ['points', 'channels', 'groups'], limit: 10 })\nconst groupHits = view.search({ keyword: 'c1::2', scope: 'group' }) // 单数别名与 focusOn 一致\nview.focusOn(groupHits.groups[0], { zoom: true, select: true }) // 按整组范围适配并选中成员回线\nview.focusOn(hits.hits, { zoom: true, maxZoom: 8 }) // 命中集直接丢给 focusOn\nconst asyncHits = await view.searchAsync('甲站') // 大表走 Worker;stale 说明这一份不作数了\n","from":"header"}] },
|
|
57
57
|
{ name: "searchAsync", kind: "method", params: "同上;分组范围的当前轻量快照会随请求交给 Worker", returns: "Promise<GisViewSearchResult>:多一个 worker(是不是在 Worker 里算的)与 stale(回来时数据已经改过、或又搜过一次,这一份不作数了)", doc: "同一份口径的异步版:数据量大时把扫描放进 Worker(10 万点 / 10 万线下同步要占主线程 40 ms 上下的那一段),返回 Promise<GisViewSearchResult>;结果带 worker 与 stale 两个字段,见「异步搜索」", examples: [{"group":"相机与视图","code":"// search(input) / searchAsync(input):搜索(只返回结果、不动视角)\nconst hits = view.search('甲站')\nconst scoped = view.search({ keyword: '甲', scope: ['points', 'channels', 'groups'], limit: 10 })\nconst groupHits = view.search({ keyword: 'c1::2', scope: 'group' }) // 单数别名与 focusOn 一致\nview.focusOn(groupHits.groups[0], { zoom: true, select: true }) // 按整组范围适配并选中成员回线\nview.focusOn(hits.hits, { zoom: true, maxZoom: 8 }) // 命中集直接丢给 focusOn\nconst asyncHits = await view.searchAsync('甲站') // 大表走 Worker;stale 说明这一份不作数了\n","from":"header"}] },
|
|
58
|
-
{ name: "setCamera", kind: "method", params: "camera: Partial<GisViewCamera> 要改的相机字段 {
|
|
59
|
-
{ name: "getCamera", kind: "method", params: "无", returns: "GisViewCamera", doc: "
|
|
58
|
+
{ name: "setCamera", kind: "method", params: "camera: Partial<GisViewCamera> 要改的相机字段 { center, scale }(只写一个也行)", returns: "this", doc: "读写相机 { center, scale };getCenter() 直接给当前中心 [x, y](独立副本),setCenter(center) 只移动中心、保留当前比例并返回实例", examples: [{"group":"相机与视图","code":"// setCamera(camera) / getCamera():读写相机(只写一个字段也行)\nview.setCamera({ scale: 10 })\nview.setCamera({ center: [200, 120] })\nconst camera = view.getCamera()\n","from":"header"}] },
|
|
59
|
+
{ name: "getCamera", kind: "method", params: "无", returns: "GisViewCamera", doc: "读写相机 { center, scale };getCenter() 直接给当前中心 [x, y](独立副本),setCenter(center) 只移动中心、保留当前比例并返回实例", examples: [{"group":"相机与视图","code":"// setCamera(camera) / getCamera():读写相机(只写一个字段也行)\nview.setCamera({ scale: 10 })\nview.setCamera({ center: [200, 120] })\nconst camera = view.getCamera()\n","from":"header"}] },
|
|
60
|
+
{ name: "getScale", kind: "method", params: "无", returns: "number:当前比例(像素 / 世界单位),与 getCamera().scale 同一份读数", doc: "读写当前比例(像素 / 世界单位):getScale() 与 getCamera().scale 同一份读数;setScale() 立即改比例,origin 是画布 CSS 像素锚点(缺省视口中心),返回实例", examples: [{"group":"相机与视图","code":"// getScale():读当前比例(与 getCamera().scale 同一份数)\nconst scale = view.getScale()\n","from":"header"}] },
|
|
61
|
+
{ name: "setScale", kind: "method", params: "scale: number 目标比例;origin?: [number, number] 画布 CSS 像素锚点(缺省视口中心)", returns: "this:立即改比例,受 minScale / maxScale 夹取", doc: "读写当前比例(像素 / 世界单位):getScale() 与 getCamera().scale 同一份读数;setScale() 立即改比例,origin 是画布 CSS 像素锚点(缺省视口中心),返回实例", examples: [{"group":"相机与视图","code":"// setScale(scale, origin?):立即改比例;origin 是画布 CSS 像素锚点,缺省视口中心\nview.setScale(3)\nview.setScale(3, [320, 180])\n","from":"header"}] },
|
|
62
|
+
{ name: "getCenter", kind: "method", params: "无", returns: "[number, number]:当前视图中心,返回独立副本;改返回值不会动引擎", doc: "读写相机 { center, scale };getCenter() 直接给当前中心 [x, y](独立副本),setCenter(center) 只移动中心、保留当前比例并返回实例", examples: [{"group":"相机与视图","code":"// getCenter() / setCenter(center):只读写视图中心(setCenter 保留当前比例,返回实例)\nconst center = view.getCenter() // [x, y] 的副本\ncenter[0] += 100 // 改副本不会移动视图\nview.setCenter([116.4, 39.9])\n","from":"header"}] },
|
|
63
|
+
{ name: "setCenter", kind: "method", params: "center: [number, number] 新的视图中心", returns: "this:只移动中心、保留当前比例,可链式调用", doc: "读写相机 { center, scale };getCenter() 直接给当前中心 [x, y](独立副本),setCenter(center) 只移动中心、保留当前比例并返回实例", examples: [{"group":"相机与视图","code":"// getCenter() / setCenter(center):只读写视图中心(setCenter 保留当前比例,返回实例)\nconst center = view.getCenter() // [x, y] 的副本\ncenter[0] += 100 // 改副本不会移动视图\nview.setCenter([116.4, 39.9])\n","from":"header"}] },
|
|
60
64
|
{ name: "stopCameraAnimation", kind: "method", params: "无", returns: "this:停止当前相机飞行并停在当前帧;没有飞行时是空操作", doc: "停止当前相机飞行(停在当前帧,返回实例)/ 读当前飞行 { active, progress, duration, from, to }(没有动画时 null)", examples: [{"group":"相机与视图","code":"// stopCameraAnimation() / getCameraAnimation():停止飞行 / 读当前飞行读数(没有动画时为 null)\nconst flight = view.getCameraAnimation() // { active, progress, duration, from, to }\nview.stopCameraAnimation() // 停在当前帧,不补跳到终点\n","from":"header"}] },
|
|
61
65
|
{ name: "getCameraAnimation", kind: "method", params: "无", returns: "GisViewCameraAnimation | null:{ active, progress, duration, from, to },progress 是时间进度(0 ~ 1),没有动画时 null", doc: "停止当前相机飞行(停在当前帧,返回实例)/ 读当前飞行 { active, progress, duration, from, to }(没有动画时 null)", examples: [{"group":"相机与视图","code":"// stopCameraAnimation() / getCameraAnimation():停止飞行 / 读当前飞行读数(没有动画时为 null)\nconst flight = view.getCameraAnimation() // { active, progress, duration, from, to }\nview.stopCameraAnimation() // 停在当前帧,不补跳到终点\n","from":"header"}] },
|
|
66
|
+
{ name: "getIdleTime", kind: "method", params: "无", returns: "number:距创建或上一次指针 / 滚轮 / 键盘操作的毫秒数;程序化 API 调用不重置", doc: "距创建或上一次指针 / 滚轮 / 键盘操作的毫秒数;程序化 API 调用不重置。配合 idleTimeout / onIdle / idle 做「多久没人动」的读数", examples: [{"group":"相机与视图","code":"// getIdleTime():距创建或上一次指针 / 滚轮 / 键盘操作的毫秒数\nconst idleTime = view.getIdleTime()\nview.updateOptions({ idleTimeout: 60000, onIdle: ({ idleTime }) => console.log(idleTime) })\n","from":"header"}] },
|
|
62
67
|
{ name: "getZoomBaseScale", kind: "method", params: "无", returns: "number 缩放联动的基准比例(pointZoomScale / lineZoomScale 共用那一份;缺省是首次适应视图时的 camera.scale)", doc: "读 / 重定缩放联动的基准比例(缺省是首次适应视图时的比例):不传参数就取当下相机的比例 —— 把现在这一屏当成「原样大小」,之后放大缩小都从它算倍数;配合 pointZoomScale / lineZoomScale 使用", examples: [{"group":"相机与视图","code":"// getZoomBaseScale() / setZoomBaseScale(scale?):缩放联动的基准比例(配合 pointZoomScale / lineZoomScale)\nconst zoomBase = view.getZoomBaseScale() // 基准(缺省首次适应视图时的 camera.scale)\nview.setZoomBaseScale() // 以当下这一屏为「原样大小」,之后放大缩小都从它算倍数\nview.setZoomBaseScale(2.5) // 也可以直接给一个比例\n","from":"header"}] },
|
|
63
68
|
{ name: "setZoomBaseScale", kind: "method", params: "scale?: number 新的基准比例;不传取当下相机的比例(把现在这一屏当成「原样大小」)", returns: "this", doc: "读 / 重定缩放联动的基准比例(缺省是首次适应视图时的比例):不传参数就取当下相机的比例 —— 把现在这一屏当成「原样大小」,之后放大缩小都从它算倍数;配合 pointZoomScale / lineZoomScale 使用", examples: [{"group":"相机与视图","code":"// getZoomBaseScale() / setZoomBaseScale(scale?):缩放联动的基准比例(配合 pointZoomScale / lineZoomScale)\nconst zoomBase = view.getZoomBaseScale() // 基准(缺省首次适应视图时的 camera.scale)\nview.setZoomBaseScale() // 以当下这一屏为「原样大小」,之后放大缩小都从它算倍数\nview.setZoomBaseScale(2.5) // 也可以直接给一个比例\n","from":"header"}] },
|
|
64
69
|
{ name: "getBounds", kind: "method", params: "无", returns: "GisViewBounds:每次返回独立副本;重复调用命中数据包围盒缓存,改点 / 改线 / 追加或拖拽后下一次读数自动重建", doc: "数据范围(没有点时回退到背景 GeoJSON 的 rawBounds,也就是 aspectScale 之前的真实经纬度范围);每次返回独立副本,重复调用命中缓存", examples: [{"group":"相机与视图","code":"// getBounds() / getViewRect() / getViewport():数据范围 / 视口世界矩形 / 画布尺寸读数\nconst dataBounds = view.getBounds()\nconst viewRect = view.getViewRect()\nconst { cssWidth, cssHeight, pixelRatio } = view.getViewport()\n","from":"header"}] },
|
|
@@ -146,7 +151,7 @@ export const API_SECTIONS = [
|
|
|
146
151
|
{ name: "isSelected", kind: "method", params: "ref: GisViewFeatureRef | GisViewFeatureKey | GisViewSelectionRefObject 要素定位(id / 下标 / { id } / { index } / { type, index } / { item })", returns: "boolean", doc: "这个要素在不在当前选中集里:isSelected('node-0')(id)/ isSelected({ type: 'line', index: 12 })(也可以只写下标,按 id 认不出来时当下标),返回 true / false。面板上高亮「当前这一行」时不必自己比对 getSelections();选中集变化时缓存一份键集合(见「接口选中」),十万级选中下这一问也是常数级", examples: [{"group":"选中、复制与合并","code":"// getSelections() / getSelectionInfo() / getSelectionData() / isSelected(ref):读回选中\nconst picks = view.getSelections()\nconst info = view.getSelectionInfo() // { ids, count, points, lines, channels }\nconst selection = view.getSelectionData() // { ids, count, points, lines, channels, bounds, … }\nconst selected = view.isSelected('a')\n","from":"header"}] },
|
|
147
152
|
{ name: "getSelectionData", kind: "method", params: "无", returns: "GisViewSelectionData:{ ids, count, pointCount, lineCount, channelCount, points, lines, channels, items, pointIndexes, lineIndexes, bounds }(bounds 是世界包围盒,空选中时 null;items 的线路不带通道字段,channels 是去重后的所属通道)", doc: "选中集一次取全:读数(ids / count / pointCount / lineCount / channelCount)加要素本身(points / lines / channels(按通道去重,与 getData() 同一批对象)),另有 items(与 getSelections() 同一份,通道回线不带通道字段)、pointIndexes / lineIndexes 与 bounds(世界包围盒,空选中时 null),见「接口选中(selectFeatures)与读回选中」", examples: [{"group":"选中、复制与合并","code":"// getSelections() / getSelectionInfo() / getSelectionData() / isSelected(ref):读回选中\nconst picks = view.getSelections()\nconst info = view.getSelectionInfo() // { ids, count, points, lines, channels }\nconst selection = view.getSelectionData() // { ids, count, points, lines, channels, bounds, … }\nconst selected = view.isSelected('a')\n","from":"header"}] },
|
|
148
153
|
{ name: "getCascadeHighlight", kind: "method", params: "无", returns: "GisViewCascadeHighlightInfo | null:当前点击级联高亮的来源、范围与节点 / 线路读数 { origin, scope, points, lines, pointIndexes, lineIndexes },不改变选中集", doc: "当前点击级联高亮的读数:{ origin, scope, points, lines, pointIndexes, lineIndexes };没有高亮或 cascadeHighlight 关着时返回 null。它只读、不改选中集,见「点击级联高亮」", examples: [{"group":"选中、复制与合并","code":"// getCascadeHighlight():读点击级联高亮(与选中集分开;没有高亮时为 null)\nconst cascade = view.getCascadeHighlight() // { origin, scope, points, lines, pointIndexes, lineIndexes }\nview.updateOptions({\n cascadeHighlight: {\n scope: 'points',\n triggerOnClick: true,\n triggerOnMultiSelect: false,\n triggerOnBoxSelect: true,\n clearOnEmptyClick: true\n }\n})\nview.on('cascadeHighlight', payload => console.log(payload?.pointIndexes, payload?.lineIndexes))\n","from":"header"}] },
|
|
149
|
-
{ name: "selectInBox", kind: "method", params: "box: GisViewRect 画布 CSS 像素矩形 { x, y, width, height }(与手动框选同一套坐标);options?: GisViewSelectInBoxOptions:selectionKinds 临时覆盖这一次保留哪几类('point' / 'line' / 'channel'、数组、'all' / true / false / null,不写沿用全局 selectionKinds),originalEvent 原样带进 onSelect。空框不会选中任何要素", returns: "this(每次框选都发 onSelect,空框为 null;集合变化时再发 onSelectChange,顺序 onSelect → onSelectChange,cause 为 boxSelect)", doc: "按画布 CSS 像素矩形框选,等价于 Shift + 拖动(跟随 shortcuts.boxSelect);options.selectionKinds 可只覆盖这一次的节点 / 线路 /
|
|
154
|
+
{ name: "selectInBox", kind: "method", params: "box: GisViewRect 画布 CSS 像素矩形 { x, y, width, height }(与手动框选同一套坐标);options?: GisViewSelectInBoxOptions:selectionKinds 临时覆盖这一次保留哪几类('point' / 'line' / 'channel' / 'lineEndpoints' / 'channelEndpoints'、数组、'all' / true / false / null,不写沿用全局 selectionKinds),originalEvent 原样带进 onSelect。空框不会选中任何要素", returns: "this(每次框选都发 onSelect,空框为 null;集合变化时再发 onSelectChange,顺序 onSelect → onSelectChange,cause 为 boxSelect)", doc: "按画布 CSS 像素矩形框选,等价于 Shift + 拖动(跟随 shortcuts.boxSelect);options.selectionKinds 可只覆盖这一次的节点 / 线路 / 通道类型过滤,也支持 'lineEndpoints' / 'channelEndpoints' 要求两端节点都在框内。每次框选操作都发 onSelect(空框的载荷为 null),选中集实际变化时再发 onSelectChange,顺序 onSelect → onSelectChange(cause: 'boxSelect');通道回线的分组字段与鼠标框选同一份", examples: [{"group":"选中、复制与合并","code":"// selectInBox(box, options?):用矩形框选(画布 CSS 像素,与手动框选同一套判定)\nview.selectInBox({ x: 40, y: 40, width: 320, height: 200 })\nview.selectInBox({ x: 40, y: 40, width: 320, height: 200 }, { selectionKinds: ['line', 'channel'] })\nview.selectInBox({ x: 40, y: 40, width: 320, height: 200 }, { selectionKinds: ['lineEndpoints', 'channelEndpoints'] }) // 两端节点都在框内才命中\n","from":"header"}] },
|
|
150
155
|
{ name: "beginCopyPoint", kind: "method", params: "options: GisViewCopyStartOptions:id / index / item 三选一给来源,都不给就进入「下一次点选节点」模式;coordinate / screen 是落点(缺省按 copy.offset);follow 让预览跟指针;autoCommit 覆盖 copy.autoCommit;commit: true 出预览即落地;via / originalEvent 原样带回。必须配置 copy(enabled 不为 false),否则返回 null。预览节点插在 points 末尾且不带 id,不会把绑定源 id 的线路 / 通道带过去", returns: "GisViewPointCopyPayload | null:phase: 'start' 的预览载荷;来源认不出来时返回 null", doc: "开始复制一个节点:给 id / index 直接出预览(commit: true 出预览即落地,follow: true 跟随鼠标,autoCommit: false 停在预览态),不给来源就是「先点按钮再选节点」模式,见「节点复制」", examples: [{"group":"选中、复制与合并","code":"// beginCopyPoint(options) / getPointCopy() / updateCopyPoint(patch) / commitPointCopy() / cancelPointCopy()\nview.updateOptions({ copy: { enabled: true, autoCommit: false } }) // API 复制入口要先开 copy 配置\nview.beginCopyPoint({ id: 'a', coordinate: [40, 30] }) // 出预览并钉在世界坐标 [40, 30]\nview.beginCopyPoint({ id: 'a', follow: true }) // 预览跟着指针走(autoCommit 缺省停住)\nview.beginCopyPoint() // 先点按钮再选节点(点中下一个节点当来源)\nview.updateCopyPoint({ name: '新节点' }) // 字段级改预览节点(落点仍由 coordinate / 指针决定)\nconst copyEnd = view.commitPointCopy() // 落地:返回 end 载荷;没有预览时为 null\nview.cancelPointCopy() // 取消:预览撤掉,数据与历史不动\nconst copyState = view.getPointCopy() // 当前预览 / 选点态(没有就是 null)\n","from":"header"}] },
|
|
151
156
|
{ name: "commitPointCopy", kind: "method", params: "无:把当前复制预览落地,先发 commit、落地后发 end;commit 阶段载荷里的 cancel() 可以拦住这次复制", returns: "GisViewPointCopyPayload | null:成功的 end 载荷;没有预览或已被取消时为 null", doc: "落地 / 取消预览中的复制(返回 end / cancel 载荷)", examples: [{"group":"选中、复制与合并","code":"// beginCopyPoint(options) / getPointCopy() / updateCopyPoint(patch) / commitPointCopy() / cancelPointCopy()\nview.updateOptions({ copy: { enabled: true, autoCommit: false } }) // API 复制入口要先开 copy 配置\nview.beginCopyPoint({ id: 'a', coordinate: [40, 30] }) // 出预览并钉在世界坐标 [40, 30]\nview.beginCopyPoint({ id: 'a', follow: true }) // 预览跟着指针走(autoCommit 缺省停住)\nview.beginCopyPoint() // 先点按钮再选节点(点中下一个节点当来源)\nview.updateCopyPoint({ name: '新节点' }) // 字段级改预览节点(落点仍由 coordinate / 指针决定)\nconst copyEnd = view.commitPointCopy() // 落地:返回 end 载荷;没有预览时为 null\nview.cancelPointCopy() // 取消:预览撤掉,数据与历史不动\nconst copyState = view.getPointCopy() // 当前预览 / 选点态(没有就是 null)\n","from":"header"}] },
|
|
152
157
|
{ name: "cancelPointCopy", kind: "method", params: "无:撤掉预览并补一条 cancel,数据与历史不动", returns: "GisViewPointCopyPayload | null:取消载荷;没有预览时为 null", doc: "落地 / 取消预览中的复制(返回 end / cancel 载荷)", examples: [{"group":"选中、复制与合并","code":"// beginCopyPoint(options) / getPointCopy() / updateCopyPoint(patch) / commitPointCopy() / cancelPointCopy()\nview.updateOptions({ copy: { enabled: true, autoCommit: false } }) // API 复制入口要先开 copy 配置\nview.beginCopyPoint({ id: 'a', coordinate: [40, 30] }) // 出预览并钉在世界坐标 [40, 30]\nview.beginCopyPoint({ id: 'a', follow: true }) // 预览跟着指针走(autoCommit 缺省停住)\nview.beginCopyPoint() // 先点按钮再选节点(点中下一个节点当来源)\nview.updateCopyPoint({ name: '新节点' }) // 字段级改预览节点(落点仍由 coordinate / 指针决定)\nconst copyEnd = view.commitPointCopy() // 落地:返回 end 载荷;没有预览时为 null\nview.cancelPointCopy() // 取消:预览撤掉,数据与历史不动\nconst copyState = view.getPointCopy() // 当前预览 / 选点态(没有就是 null)\n","from":"header"}] },
|
|
@@ -160,9 +165,9 @@ export const API_SECTIONS = [
|
|
|
160
165
|
{ name: "pastePoint", kind: "method", params: "options: GisViewPasteOptions:screen / coordinate(落在哪里,缺省光标位置)、offset(屏幕像素偏移)、select(粘贴后选中新节点)、label / via / originalEvent;单节点且快照里没有内部线路 / 通道时仍走原预览,其余走整组落地", returns: "GisViewCopyItem | GisViewBatchCopyPayload | null", doc: "剪贴板:copyPointToClipboard 默认收当前选中的全部节点(只有没选中才回落到光标下的那个),copyPointsToClipboard 只认给定 / 选中的一批;Ctrl+V 时单节点且没有内部线路 / 通道仍走原预览,多节点或带线路 / 通道走整组落地,pastePoints 强制整组(单节点也走批量载荷)。getPointClipboard() 读 count / sources / items / lines / channels / anchor 快照,见「节点复制」", examples: [{"group":"选中、复制与合并","code":"// copyPoint(source?) / copyPoints(sources?, options?) / copySelectedPoints(options?) / copyPointToClipboard(sources?, options?) / copyPointsToClipboard(sources?, options?) / pastePoint(options?) / pastePoints(options?) / getPointClipboard()\nconst copyItem = view.copyPoint('a') // 一步到位,落在原位置旁边\nconst batchCopy = view.copyPoints(['a', 'b'], { select: true }) // 只复制这两个节点(不带未选中的线路 / 通道)\nconst selectedCopy = view.copySelectedPoints({ coordinate: [120, 80] }) // 复制当前选中集:节点 + 选中线路 / 通道\nview.copySelectedPoints({ withLines: true, withChannels: true }) // 恢复旧口径:来源内部线路 / 通道全带\nview.copyPoints(['a', 'b'], { lineIndexes: [0], channelIndexes: [1] }) // 再显式点名线路 / 通道\nview.copyPointToClipboard('a') // 收进剪贴板(默认整个选中集,Ctrl+C 的接口写法)\nview.copyPointsToClipboard(['a', 'b', 'c']) // 只把给定的一批收进剪贴板\nview.pastePoint({ screen: [320, 200] }) // 粘到光标处(Ctrl+V 的接口写法)\nview.pastePoint({ coordinate: [120, 80], offset: [40, 0] })\nconst pastedBatch = view.pastePoints({ coordinate: [160, 100] }) // 强制整组落地(单节点也走批量路)\nconsole.log(batchCopy.count, batchCopy.lines.length, selectedCopy.indexes, pastedBatch?.count)\nconst clipboard = view.getPointClipboard()\n","from":"header"}] },
|
|
161
166
|
{ name: "pastePoints", kind: "method", params: "options 同上;强制整组粘贴(单节点也走批量路),返回带 count / indexes / lines / channels / revert() 的完整载荷", returns: "GisViewBatchCopyPayload | null", doc: "剪贴板:copyPointToClipboard 默认收当前选中的全部节点(只有没选中才回落到光标下的那个),copyPointsToClipboard 只认给定 / 选中的一批;Ctrl+V 时单节点且没有内部线路 / 通道仍走原预览,多节点或带线路 / 通道走整组落地,pastePoints 强制整组(单节点也走批量载荷)。getPointClipboard() 读 count / sources / items / lines / channels / anchor 快照,见「节点复制」", examples: [{"group":"选中、复制与合并","code":"// copyPoint(source?) / copyPoints(sources?, options?) / copySelectedPoints(options?) / copyPointToClipboard(sources?, options?) / copyPointsToClipboard(sources?, options?) / pastePoint(options?) / pastePoints(options?) / getPointClipboard()\nconst copyItem = view.copyPoint('a') // 一步到位,落在原位置旁边\nconst batchCopy = view.copyPoints(['a', 'b'], { select: true }) // 只复制这两个节点(不带未选中的线路 / 通道)\nconst selectedCopy = view.copySelectedPoints({ coordinate: [120, 80] }) // 复制当前选中集:节点 + 选中线路 / 通道\nview.copySelectedPoints({ withLines: true, withChannels: true }) // 恢复旧口径:来源内部线路 / 通道全带\nview.copyPoints(['a', 'b'], { lineIndexes: [0], channelIndexes: [1] }) // 再显式点名线路 / 通道\nview.copyPointToClipboard('a') // 收进剪贴板(默认整个选中集,Ctrl+C 的接口写法)\nview.copyPointsToClipboard(['a', 'b', 'c']) // 只把给定的一批收进剪贴板\nview.pastePoint({ screen: [320, 200] }) // 粘到光标处(Ctrl+V 的接口写法)\nview.pastePoint({ coordinate: [120, 80], offset: [40, 0] })\nconst pastedBatch = view.pastePoints({ coordinate: [160, 100] }) // 强制整组落地(单节点也走批量路)\nconsole.log(batchCopy.count, batchCopy.lines.length, selectedCopy.indexes, pastedBatch?.count)\nconst clipboard = view.getPointClipboard()\n","from":"header"}] },
|
|
162
167
|
{ name: "getPointClipboard", kind: "method", params: "无", returns: "GisViewClipboardItem | null", doc: "剪贴板:copyPointToClipboard 默认收当前选中的全部节点(只有没选中才回落到光标下的那个),copyPointsToClipboard 只认给定 / 选中的一批;Ctrl+V 时单节点且没有内部线路 / 通道仍走原预览,多节点或带线路 / 通道走整组落地,pastePoints 强制整组(单节点也走批量载荷)。getPointClipboard() 读 count / sources / items / lines / channels / anchor 快照,见「节点复制」", examples: [{"group":"选中、复制与合并","code":"// copyPoint(source?) / copyPoints(sources?, options?) / copySelectedPoints(options?) / copyPointToClipboard(sources?, options?) / copyPointsToClipboard(sources?, options?) / pastePoint(options?) / pastePoints(options?) / getPointClipboard()\nconst copyItem = view.copyPoint('a') // 一步到位,落在原位置旁边\nconst batchCopy = view.copyPoints(['a', 'b'], { select: true }) // 只复制这两个节点(不带未选中的线路 / 通道)\nconst selectedCopy = view.copySelectedPoints({ coordinate: [120, 80] }) // 复制当前选中集:节点 + 选中线路 / 通道\nview.copySelectedPoints({ withLines: true, withChannels: true }) // 恢复旧口径:来源内部线路 / 通道全带\nview.copyPoints(['a', 'b'], { lineIndexes: [0], channelIndexes: [1] }) // 再显式点名线路 / 通道\nview.copyPointToClipboard('a') // 收进剪贴板(默认整个选中集,Ctrl+C 的接口写法)\nview.copyPointsToClipboard(['a', 'b', 'c']) // 只把给定的一批收进剪贴板\nview.pastePoint({ screen: [320, 200] }) // 粘到光标处(Ctrl+V 的接口写法)\nview.pastePoint({ coordinate: [120, 80], offset: [40, 0] })\nconst pastedBatch = view.pastePoints({ coordinate: [160, 100] }) // 强制整组落地(单节点也走批量路)\nconsole.log(batchCopy.count, batchCopy.lines.length, selectedCopy.indexes, pastedBatch?.count)\nconst clipboard = view.getPointClipboard()\n","from":"header"}] },
|
|
163
|
-
{ name: "mergePoints", kind: "method", params: "source: GisViewPointRef 被并入的节点(并完就没了)、target: GisViewPointRef 接收的节点、options?: { originalEvent?: Event | null; item?: GisViewPoint }:item
|
|
168
|
+
{ name: "mergePoints", kind: "method", params: "source: GisViewPointRef 被并入的节点(并完就没了)、target: GisViewPointRef 接收的节点、options?: { originalEvent?: Event | null; item?: GisViewPoint }:item 可以给一份已经改好的业务字段结果(确认阶段改过 payload.item 之后就是它);未给 item 时只对 merge.maxKeys 列出的字段取双方最高值(缺省空表,全部字段取保留节点,数组 / 逗号字符串均可);最终 id、坐标与 mergeInfo 由组件维护", returns: "GisViewMergeOutcome:保留节点写完整 mergeInfo,受影响通道写轻量 mergeInfo", doc: "把来源节点并进目标节点(接口调用,不做确认):来源 / 目标收 id、下标或 { id } / { index },节点数据按 merge.createItem 合并(缺省以保留节点为底,名称 / 图标等业务字段取保留端,merge.maxKeys 列出的数值字段取双方最高、缺省不取,尺寸取双方最大、图标类型用保留端),线路 from / to 与通道 from / to 改到保留节点,删自环 / 零长线 / 自环通道、把撞成同一条的通道合成一条。保留节点写完整 mergeInfo 快照,受影响通道写轻量 mergeInfo;返回 { ok, item, linesChanged, removedLines, removedChannels, mergedChannels },并不了返回 ok: false 并另发一条失败事件,见「节点合并」", examples: [{"group":"选中、复制与合并","code":"// mergePoints(source, target, options?):把 source 并进 target(接口调用,不做确认)\nconst merged = view.mergePoints('a', 'b')\nconst mergedCustom = view.mergePoints('a', 'b', { item: { name: '合并结果', size: 12 } })\nconsole.log(merged.item?.mergeInfo?.sourceIds) // 保留节点上的来源 id;只有 merge.maxKeys 列出的字段取最高,缺省全部取保留端\n","from":"header"}] },
|
|
164
169
|
{ name: "mergeSelectedPoints", kind: "method", params: "options: GisViewMergeSelectedOptions:target 指定并到哪一个(不给就自动挑绑定线路最多的);sources 直接给来源(不依赖选中集);item 是最终节点补丁或 (context) => 补丁(上下文含 item / merged / source / target / sourceIndex / targetIndex / merge / view;坐标与 id 仍按 target 保留);force: true 越过 mergeable: false;label / originalEvent", returns: "GisViewMergeSelectedOutcome", doc: "框选 / 多选之后一步把选中的节点并到一个目标上(接口调用):target 不指定就自动挑绑定线路最多的那一个(一样多取画得大的、再取下标小的),来源默认是除目标之外的选中节点、也可以用 sources(id / 下标 / { id } / { index },单个或数组)直接给 —— 这时不用先选中;mergeable: false 默认跳过(force: true 越过)、label 改这一步历史的标签。多个来源合成一步历史(数据变更收成一条 batch),返回 { phase: 'mergeSelected', ok, reason, target, merged, skipped, sourcesMerged, linesChanged, removedLines, removedChannels, mergedChannels, channelsChanged },见「节点合并」", examples: [{"group":"选中、复制与合并","code":"// mergeSelectedPoints(options?):框选 / 多选之后一次并完(目标缺省挑绑定线路最多的那个)\nconst mergedAll = view.mergeSelectedPoints()\nview.mergeSelectedPoints({ target: 'b', sources: ['a', 'c'], force: true })\n","from":"header"}] },
|
|
165
|
-
{ name: "splitPoint", kind: "method", params: "source: GisViewPointRef 要拆的节点;parts
|
|
170
|
+
{ name: "splitPoint", kind: "method", params: "source: GisViewPointRef 要拆的节点;parts?: GisViewSplitPointPart[] | null 省略 / null / [] 且节点带 mergeInfo 时自动解除合并,传数组时至少两份,每份可直接写节点字段或放进 item,并用 lines / channels / channelFrom / channelTo 分配线路与通道端点;options?: GisViewSplitPointOptions:keepSourceId(缺省 true,第一份沿用来源 id)/ label / select(缺省 false,不选中结果且保留无关选中;true 选中全部结果节点)/ autoLines?: 'first' | 'alternate'(缺省 first 跟第一份;alternate 按「通道成组、独立线路单条」轮流给负载最少的一份,手工拆分推荐)", returns: "GisViewSplitPointOutcome:{ ok, reason, source, items, indexes, pointIds, linesChanged, removedLines, removedLineIds, removedLineIndexes, channelsChanged, removedChannels, removedChannelIds, autoLines, autoAssignedLines, lineAssignments, autoRestored, mergeSourceIds, skipped, changes };自动解除时 autoRestored: true、mergeSourceIds 给恢复的来源 id;lineAssignments 每项 { index, pointId, lineIds, lineCount };changes 可直接作为后端事务输入", doc: "mergePoints 的逆操作。省略 parts(或传 null / [])且节点带 mergeInfo 时自动解除合并:恢复第一次合并前的保留节点、全部来源节点、线路与通道,保留合并后新建且不在快照里的要素;来源 id 冲突 / 追溯不完整时 ok: false 且不动数据,整次一步历史。传 parts 时手工拆成两份或更多(第一份接在原下标上、缺省沿用原 id,其余追加),按每份 item / 顶层字段生成节点,按 lines 分配线路、按 channels / channelFrom / channelTo 分配通道两端;未分配线路默认跟第一份,autoLines: 'alternate' 按「通道成员成组、独立线路单条」轮流给负载最少的一份,未分配通道端点跟第一条被分配过的成员回线。options.select 缺省 false:不选中结果,只摘掉来源节点自己的选中态;写 true 才选中全部结果节点。拆完删自环 / 零长度线路、两端相同的通道与成员全空的通道。返回 { autoRestored, mergeSourceIds, autoLines, autoAssignedLines, lineAssignments, changes, ... },changes 可直接作为后端事务输入;手工拆分至少两份、坐标必须有效、线路不能重复分配,写错时 ok: false 并在 reason 说明", examples: [{"group":"选中、复制与合并","code":"// splitPoint(source):有 mergeInfo 时自动解除合并(省略 parts / null / [] 等价)\nconst autoRestored = view.splitPoint('b', null, { label: '解除合并(自动恢复)' })\nconsole.log(autoRestored.autoRestored, autoRestored.mergeSourceIds, autoRestored.changes)","from":"header"},{"group":"选中、复制与合并","code":"// 默认不选中结果;需要选中全部恢复节点时写 splitPoint('b', null, { select: true })\n","from":"header"},{"group":"选中、复制与合并","code":"// splitPoint(source, parts, options?):手工拆成多份(mergePoints 的逆操作)\nconst splitResult = view.splitPoint('a', [\n { x: 0, y: 0, name: '甲站(主)' }, // 第一份沿用原下标 / id\n { x: 80, y: 40, name: '甲站(东)', lines: ['l1'] } // 显式分给第二份\n], { autoLines: 'alternate', label: '解除合并' })","from":"header"}] },
|
|
166
171
|
{ name: "getPointMerge", kind: "method", params: "无(载荷带 impact:lineCount / linesChanged / removedLines / lineIds / removedLineIds 与通道读数,确认前就能估算影响)", returns: "GisViewPointMergePayload | null", doc: "读 / 裁决 / 收尾当前待确认的合并(把一个节点拖到另一个节点上之后):resolvePointMerge(true, { keep, item }) 推进到 confirm 阶段 —— keep 选保留碰撞目标(缺省)还是拖动的来源,item 改写最终节点的信息与样式,位置 / id 始终取保留端;resolvePointMerge(false) 让拖动的节点回原位。pending / confirm / getPointMerge() 的载荷带 impact(受影响线路条数、具体 lineIds 与通道读数;lineCount 按线路去重,linesChanged / removedLines 与落地结果同口径)。自己接管数据落地时用 commitPointMerge() 收状态、revertPointMerge() 还原(silent: true 不补发 cancel 载荷)", examples: [{"group":"选中、复制与合并","code":"// getPointMerge() / resolvePointMerge(confirmed?, options?) / commitPointMerge() / revertPointMerge()\nconst pendingMerge = view.getPointMerge() // 待确认的那一份载荷(没有就是 null)\nconsole.log(pendingMerge?.impact?.lineCount) // 这次合并会影响几条线路(改写 + 删除,按线路去重)\nconsole.log(pendingMerge?.impact?.lineIds) // 具体是哪几条(没有 id 时是 lines 下标)\nview.resolvePointMerge(true) // 确认(false = 取消)\nview.resolvePointMerge(true, { keep: 'source', item: { name: '合并结果', size: 18 } })\nview.resolvePointMerge(true, { keep: 'target', item: { color: '#2f6fd0', strokeColor: '#ffffff' } })\nview.resolvePointMerge(false) // 取消(拖动的节点回原位,数据不动)\nview.commitPointMerge() // 自己接管数据时收尾\nview.revertPointMerge() // 反悔(silent: true 时不补发 cancel 载荷)\n","from":"header"}] },
|
|
167
172
|
{ name: "resolvePointMerge", kind: "method", params: "confirmed?: boolean(缺省 true = 确认,false = 取消);options?: GisViewPointMergeConfirmOptions:keep 选 'target'(缺省,保留碰撞目标)/ 'source'(保留拖动的来源),item 是最终节点字段补丁(名称 / 分区 / 颜色 / 尺寸 / 图标 / 描边等;位置与 id 始终取保留端)", returns: "GisViewPointMergePayload | null", doc: "读 / 裁决 / 收尾当前待确认的合并(把一个节点拖到另一个节点上之后):resolvePointMerge(true, { keep, item }) 推进到 confirm 阶段 —— keep 选保留碰撞目标(缺省)还是拖动的来源,item 改写最终节点的信息与样式,位置 / id 始终取保留端;resolvePointMerge(false) 让拖动的节点回原位。pending / confirm / getPointMerge() 的载荷带 impact(受影响线路条数、具体 lineIds 与通道读数;lineCount 按线路去重,linesChanged / removedLines 与落地结果同口径)。自己接管数据落地时用 commitPointMerge() 收状态、revertPointMerge() 还原(silent: true 不补发 cancel 载荷)", examples: [{"group":"选中、复制与合并","code":"// getPointMerge() / resolvePointMerge(confirmed?, options?) / commitPointMerge() / revertPointMerge()\nconst pendingMerge = view.getPointMerge() // 待确认的那一份载荷(没有就是 null)\nconsole.log(pendingMerge?.impact?.lineCount) // 这次合并会影响几条线路(改写 + 删除,按线路去重)\nconsole.log(pendingMerge?.impact?.lineIds) // 具体是哪几条(没有 id 时是 lines 下标)\nview.resolvePointMerge(true) // 确认(false = 取消)\nview.resolvePointMerge(true, { keep: 'source', item: { name: '合并结果', size: 18 } })\nview.resolvePointMerge(true, { keep: 'target', item: { color: '#2f6fd0', strokeColor: '#ffffff' } })\nview.resolvePointMerge(false) // 取消(拖动的节点回原位,数据不动)\nview.commitPointMerge() // 自己接管数据时收尾\nview.revertPointMerge() // 反悔(silent: true 时不补发 cancel 载荷)\n","from":"header"}] },
|
|
168
173
|
{ name: "commitPointMerge", kind: "method", params: "无:收掉「已确认、数据已由使用方并好」的合并状态;mergePoints / resolvePointMerge 的正常路径由组件自己调用,只有完全自建合并落地流程时才手动调", returns: "boolean:真的收掉了一个待确认合并为 true,没有可收的状态为 false", doc: "读 / 裁决 / 收尾当前待确认的合并(把一个节点拖到另一个节点上之后):resolvePointMerge(true, { keep, item }) 推进到 confirm 阶段 —— keep 选保留碰撞目标(缺省)还是拖动的来源,item 改写最终节点的信息与样式,位置 / id 始终取保留端;resolvePointMerge(false) 让拖动的节点回原位。pending / confirm / getPointMerge() 的载荷带 impact(受影响线路条数、具体 lineIds 与通道读数;lineCount 按线路去重,linesChanged / removedLines 与落地结果同口径)。自己接管数据落地时用 commitPointMerge() 收状态、revertPointMerge() 还原(silent: true 不补发 cancel 载荷)", examples: [{"group":"选中、复制与合并","code":"// getPointMerge() / resolvePointMerge(confirmed?, options?) / commitPointMerge() / revertPointMerge()\nconst pendingMerge = view.getPointMerge() // 待确认的那一份载荷(没有就是 null)\nconsole.log(pendingMerge?.impact?.lineCount) // 这次合并会影响几条线路(改写 + 删除,按线路去重)\nconsole.log(pendingMerge?.impact?.lineIds) // 具体是哪几条(没有 id 时是 lines 下标)\nview.resolvePointMerge(true) // 确认(false = 取消)\nview.resolvePointMerge(true, { keep: 'source', item: { name: '合并结果', size: 18 } })\nview.resolvePointMerge(true, { keep: 'target', item: { color: '#2f6fd0', strokeColor: '#ffffff' } })\nview.resolvePointMerge(false) // 取消(拖动的节点回原位,数据不动)\nview.commitPointMerge() // 自己接管数据时收尾\nview.revertPointMerge() // 反悔(silent: true 时不补发 cancel 载荷)\n","from":"header"}] },
|
|
@@ -211,6 +216,7 @@ export const API_SECTIONS = [
|
|
|
211
216
|
{ name: "commitAddChannel", kind: "method", params: "input?: GisViewChannelAddCommitInput,只接受一个容器对象;不传 / null 用草稿的推荐方案。字段:channel?(通道对象与 groups)/ line?(独立线路对象)/ lines? 或 lineData?(成员回线表)/ channelGroups? 或 group?(分组声明)/ lineProps? / linePropsByMember? / channelProps? / path? / routing? / resolution? / from? / to? / name? / id?。lines 与 lineData 同义且 lines 优先,空数组沿用草稿;channel.lineIds 只在线路表缺省时当回线 id 种子。字段优先级:from / to = 顶层 → channel → line → lines 第一个对象项 → 草稿;path = 顶层 → line → channel → 草稿;分组 = channelGroups → group → channel.groups;lineProps = 草稿 → 顶层 → line.lineProps → 逐条;channelProps = 草稿 → channel 业务字段 → 顶层 channelProps。resolution 收 'auto' / 'newChannel' / 'newGroup' / 'joinGroup' / 'newLine' 或 { type, groupId?, groupIndex?, channelId? }。旧顶层分派字段(kind / circuits / channelId / groupId / lineId / lineItems / lineIds / start / end 等)明确失败。options?: { auto?: boolean; continuous?: boolean; originalEvent?: Event | null; select?: boolean };select: true 才选中这次新建的全部回线,缺省不动选中集。调用前草稿必须 ready;没有草稿的程序化新增用 addChannel / addLine", returns: "GisViewChannelAddResult", doc: "把已 ready 的草稿落到数据上。第一个参数只接受一个容器对象:{ channel?, line?, lines? / lineData?, channelGroups? / group?, lineProps?, linePropsByMember?, channelProps?, path?, routing?, resolution?, from?, to?, name?, id? };字符串、数组和旧顶层分派字段(kind / circuits / channelId / groupId / lineId / lineItems / lineIds 等)都明确失败。options?: { auto?, continuous?, originalEvent?, select? };select: true 才选中落地的新回线。完整优先级见「10 通道编辑与新增」。", examples: [{"group":"拐点与通道","code":"// commitAddChannel(input?, options?) / cancelAddChannel() / endAddChannel()\nview.beginAddChannel({\n circuits: 3,\n channelDraftStyle: {\n color: '#2f6fd0', width: 2.5, arrow: true, arrowSize: 14, arrowPositions: [0, 0.5, 1],\n circuitSpacing: 12, opacity: 0.9,\n // 两端示例点:false 全关;对象可统一 size / color / shape,from / to 再分别覆盖\n dots: { size: 5, shape: 'square', from: { color: '#2f6fd0' }, to: { color: '#d9544d' } },\n layer: 'below-points' // 示例线 / 箭头 / customDraw 画在真实节点之下;示例点仍在节点之后\n }\n}) // 点两个节点:第一个起点、第二个终点;通道 3 回时预览也画 3 条平行回线\nview.beginAddChannel({ from: 'station-a' }) // 只预指定起点:接下来只点终点(没有 from + to 的写法)\nconst draft = view.getAddChannelDraft() // 草稿读数(跟随光标的预览、两个节点、方案表与实际 style)\nview.updateAddChannelStyle({ arrowPositions: [0.25, 0.75], arrowReverse: true }) // 字段级合并,只改箭头\nview.updateAddChannelStyle(null) // 回到全局 channelDraftStyle\n","from":"header"},{"group":"拐点与通道","code":"// 这一段最终落地几条回线由 circuits / lineData 决定;落地后是否选中新回线由 commitAddChannel 的 options.select 决定\nview.commitAddChannel({}, { select: true })\n","from":"header"},{"group":"拐点与通道","code":"// commitAddChannel 只负责把已 ready 的草稿落地;没有草稿的程序化新增用 addChannel / addLine。","from":"header"}] },
|
|
212
217
|
{ name: "getChannelAddOptions", kind: "method", params: "from / to 两端节点 id;count?: number 回数(缺省 1);kind?: 'channel' | 'line'(缺省 'channel')", returns: "GisViewChannelAddPlan | null", doc: "两个节点之间的新增方案:新通道 / 新分组 / 并进某一组 / 无法添加;count 是这一次要加的回数(余量按它判),kind: 'line' 时方案表为空(独立线路不挑方案)", examples: [{"group":"拐点与通道","code":"// getChannelAddOptions(from, to, count?, kind?):两个节点之间能怎么加(界面拿它让用户选)\nconst plan = view.getChannelAddOptions('a', 'b', 2)\nconst linePlan = view.getChannelAddOptions('a', 'b', 1, 'line')\n","from":"header"}] },
|
|
213
218
|
{ name: "getChannelBetween", kind: "method", params: "from / to 两端节点 id", returns: "GisViewChannelBetween | null", doc: "两个节点之间的通道读数(只读):有通道时 hasChannel: true,channelId / channelIndex / groupCount / currentGroupId 与 groups / group / channel(id / name / lineIds / 分组明细)都给全;没有通道时 hasChannel: false、channel: null、groups: [],端点认不出来返回 null", examples: [{"group":"拐点与通道","code":"// getChannelBetween(from, to):只要通道读数 —— 有没有通道 / 几组 / 当前哪组(不做方案判断,端点认不出返回 null)\nconst between = view.getChannelBetween('a', 'b')\nif (between?.hasChannel) {\n console.log(between.channelId, between.groupCount, between.groups.map(group => group.id), between.currentGroupId)\n}\n","from":"header"}] },
|
|
219
|
+
{ name: "getDirectConnections", kind: "method", params: "pointIds: string | number | Array<string | number> 一组节点 id(单条也收);只查集合内部的直接边,两端必须能查到节点,去重后少于两个返回空表", returns: "GisViewDirectConnection[]:type 为 'channel' / 'line' 的联合;每项带 from / to({ id, index, item })与 item,通道项有 channelId / channelIndex / lineIds,线路项有 lineId / lineIndex;空结果严格为 []", doc: "一组节点之间的直接通道 / 线路(只读):两端都必须真实存在且都在传入的 id 集合里,只认通道端点或线路 from / to,不穿中间节点;通道先按 channels 顺序、线路再按 lines 顺序,通道与成员回线可同时命中。每项带 type / from / to / item,通道项另有 channelId / channelIndex / lineIds,线路项另有 lineId / lineIndex;没有结果返回 []", examples: [{"group":"拐点与通道","code":"// getDirectConnections(pointIds):只取这组节点之间的直接通道 / 线路(不走中间节点;没有就是 [])\nconst directConnections = view.getDirectConnections(['a', 'b'])\nfor (const connection of directConnections) {\n if (connection.type === 'channel') {\n console.log('通道', connection.channelId, connection.lineIds, connection.from.id, connection.to.id)\n }\n else {\n console.log('线路', connection.lineId, connection.from.id, connection.to.id)\n }\n}\n","from":"header"}] },
|
|
214
220
|
{ name: "addChannel", kind: "method", params: "channel: GisViewChannelAddSpec 通道信息 { from, to, name?, id?, channelProps?, path?, routing?, lineData?, group? }(后两个是第二 / 第三段写在对象上的别名);lineData?: GisViewChannelLineData 线路数组(Partial<GisViewLine> / string / number 的一条或一批,按每项 id 建 lineIds);group?: GisViewChannelAddGroup | GisViewChannelAddGroup[] 可选分组信息 { id?, lineIds?, path? };options?: { emit?: boolean; select?: boolean },缺省不选中。只新建通道:两端已有通道时整条失败;旧 circuits / resolution / kind / channelId / lineItems 等入参已移除。path 是中间拐点,通道只写骨架拐点", returns: "GisViewChannelAddResult(channelLineIds 是落地后通道的完整成员表)", doc: "程序化只新建通道:第一段 { from, to, name?, id?, channelProps?, path?, routing?, lineData?, group? },第二段线路数据按每项 id 建 lineIds,第三段可选分组信息({ id?, lineIds?, path? })。两端已有通道时整条失败(reason 指路 addChannelGroupLines / joinChannelGroupLines)。options?: { emit?, select? },缺省不选中新回线。", examples: [{"group":"拐点与通道","code":"// commitAddChannel 只负责把已 ready 的草稿落地;没有草稿的程序化新增用 addChannel / addLine。","from":"header"},{"group":"拐点与通道","code":"// addChannel(spec, lineData?, group?, options?) / addChannels(input, options?)","from":"header"}] },
|
|
215
221
|
{ name: "addChannelGroupLines", kind: "method", params: "channelId 目标通道 id;lineData?: GisViewChannelLineData 这次新建的线路数组(按每项 id 建回线);group?: GisViewChannelAddGroup 新分组信息 { id?, path? }(缺省 ${通道 id}::N、不带拐点);options?: { emit?: boolean; select?: boolean }", returns: "GisViewChannelAddResult", doc: "给已有通道新加一组回线:第二段按每项 id 建回线,groupInfo({ id?, groupId?, path?, ... })给新分组的 id 与中间拐点,缺省 ${通道 id}::N、不带拐点;options?: { emit?, select? },缺省不选中", examples: [{"group":"拐点与通道","code":"// addChannelGroupLines(channelId, lineData?, group?, options?) / joinChannelGroupLines(channelId, groupId?, lineData?, options?)","from":"header"}] },
|
|
216
222
|
{ name: "addChannelGroups", kind: "method", params: "channelId 目标通道 id;groups: GisViewChannelAddGroupInput | GisViewChannelAddGroupInput[] 每项 { id?, groupId?, path?, lineData? | lines? }(线路数据与 addChannel 第二段同一份写法,lineItems 已移除);options?: { emit?: boolean; label?: string; select?: boolean },emit: false 只落地不通知", returns: "GisViewAddChannelGroupsResult", doc: "给已有通道一次新加多组回线:groups 每项 { id?, groupId?, path?, lineData? | lines?, ... };旧 lineItems 会让整批明确失败且不写数据。逐组落地但只记一步历史、只发一条 addChannelGroups 数据变更;options?: { emit?, label?, select? }", examples: [{"group":"拐点与通道","code":"// addChannelGroups(channelId, groups, options?) / addLine(spec, lineData?, options?):程序化新增","from":"header"}] },
|
|
@@ -259,9 +265,9 @@ export const API_SECTIONS = [
|
|
|
259
265
|
title: "标签",
|
|
260
266
|
items: [
|
|
261
267
|
{ name: "getLabelStates", kind: "method", params: "kind?: 'point' | 'line' 只看一类(不传两类都给)", returns: "GisViewLabelState[]", doc: "标签的运行时状态(拖出来的偏移 + 逐条覆盖,每条带 labelId):kind 写 'point' / 'line' 只取一类;做持久化 / 回显编辑面板用它,见「标签的拖动与编辑」", examples: [{"group":"标签","code":"// getLabelStates(kind?) / getLabels(kind, ref?):标签状态(持久化那一份)/ 标签读数\nconst labelStates = view.getLabelStates()\nconst lineStates = view.getLabelStates('line')\nconst labelsOfPoint = view.getLabels('point', 'a') // 一个要素上的标签\nconst labeledLines = view.getLabels('line') // 不传 ref = 有标签的线路清单\n","from":"header"}] },
|
|
262
|
-
{ name: "getLabels", kind: "method", params: "kind: 'point' | 'line' 看哪一类;ref?: GisViewFeatureRef 看哪一个要素(不传 = 给「有标签的要素」清单)", returns: "GisViewLabelListItem[] | null / GisViewItemLabelsInfo[]", doc: "一条要素上现在有哪些标签(配置里的每一条 + 数据 / 运行时多出来的,各自带内容 / 锚点 / 偏移 / 样式 /
|
|
268
|
+
{ name: "getLabels", kind: "method", params: "kind: 'point' | 'line' 看哪一类;ref?: GisViewFeatureRef 看哪一个要素(不传 = 给「有标签的要素」清单)", returns: "GisViewLabelListItem[] | null / GisViewItemLabelsInfo[]", doc: "一条要素上现在有哪些标签(配置里的每一条 + 数据 / 运行时多出来的,各自带内容 / 锚点 / 偏移 / 样式 / 可见性、当下生效的 zIndex / followNodeZIndex / zoomScale、来源(source:'config' 配置里定义的 / 'data' 数据里写的 / 'runtime' 运行时加的)与运行时状态);不给 ref 时给「有标签的要素」清单;找不到要素返回 null", examples: [{"group":"标签","code":"// getLabelStates(kind?) / getLabels(kind, ref?):标签状态(持久化那一份)/ 标签读数\nconst labelStates = view.getLabelStates()\nconst lineStates = view.getLabelStates('line')\nconst labelsOfPoint = view.getLabels('point', 'a') // 一个要素上的标签\nconst labeledLines = view.getLabels('line') // 不传 ref = 有标签的线路清单\n","from":"header"}] },
|
|
263
269
|
{ name: "setLabelContent", kind: "method", params: "content: GisViewLabelContent | GisViewLineLabelContent | null 新内容(模板串 {字段} / 函数 / null 回到默认);options: GisViewSetLabelContentOptions kind 缺省 'point'('line' / 'both')、labelId 缺省 'default'('*' 换配置里的每一条)", returns: "this", doc: "一键换全局标签内容(面板上「显示名称 / 电压等级」这类切换):content 与 label.content 同一套写法('{vn_kv}' 模板串 / 函数 / null 回到默认),只换内容,位置 / 样式 / 显隐保持;options.kind 缺省 'point'('line' / 'both' 连线路标签一起),options.labelId 缺省 'default'(写 '*' 换配置里的每一条),见「节点标签」", examples: [{"group":"标签","code":"// setLabelContent(content, options?):一键换全局标签内容(模板串 / 函数 / null 回默认)\nview.setLabelContent('{name}')\nview.setLabelContent('{name}({vn_kv} kV)')\nview.setLabelContent(null)\nview.setLabelContent('{name}', { kind: 'both', labelId: 'default' })\n","from":"header"}] },
|
|
264
|
-
{ name: "updateLabel", kind: "method", params: "kind 哪一类;ref 哪个要素;patch: GisViewLabelPatch 要改的项:labelId(改哪一条,缺省 'default')、content / html / position / style(增量合并)/ offset / visibility / parallel / hidden,写 null 回到默认", returns: "GisViewLabelState | null", doc: "逐条改一个标签:patch.labelId 指定改哪一条(缺省 'default'),另外认 content / html / position / style / offset / visibility / parallel / hidden,不写的保持、写 null 回到默认,style 是增量合并;改完当场重排一次并返回这一条的最新状态读数,找不到要素或这条要素上没有这一条标签时返回 null 并记一条 warning", examples: [{"group":"标签","code":"// updateLabel(kind, ref, patch):改一个要素的一条标签(labelId 缺省 'default')\nview.updateLabel('point', 'a', { style: { color: '#f60' } })\nview.updateLabel('point', 'a', { labelId: 'volt', content: '{vn_kv} kV' })\nview.updateLabel('line', 'l1', { labelId: 'note1', hidden: true })\nview.updateLabel('point', 'a', { position: 'bottom', offset: [0, 6], visibility: 'always' })\n","from":"header"}] },
|
|
270
|
+
{ name: "updateLabel", kind: "method", params: "kind 哪一类;ref 哪个要素;patch: GisViewLabelPatch 要改的项:labelId(改哪一条,缺省 'default')、content / html / position / style(增量合并)/ offset / visibility / parallel / hidden / zIndex / followNodeZIndex / zoomScale,写 null 回到默认", returns: "GisViewLabelState | null", doc: "逐条改一个标签:patch.labelId 指定改哪一条(缺省 'default'),另外认 content / html / position / style / offset / visibility / parallel / hidden / zIndex / followNodeZIndex / zoomScale,不写的保持、写 null 回到默认,style 是增量合并;改完当场重排一次并返回这一条的最新状态读数,找不到要素或这条要素上没有这一条标签时返回 null 并记一条 warning", examples: [{"group":"标签","code":"// updateLabel(kind, ref, patch):改一个要素的一条标签(labelId 缺省 'default')\nview.updateLabel('point', 'a', { style: { color: '#f60' } })\nview.updateLabel('point', 'a', { labelId: 'volt', content: '{vn_kv} kV' })\nview.updateLabel('line', 'l1', { labelId: 'note1', hidden: true })\nview.updateLabel('point', 'a', { position: 'bottom', offset: [0, 6], visibility: 'always' })\nview.updateLabel('point', 'a', { followNodeZIndex: true }) // 跟随节点样式链的 zIndex\nview.updateLabel('point', 'a', { zIndex: 30 }) // 显式层级压过跟随\nview.updateLabel('line', 'l1', { zIndex: 10, zoomScale: 1 }) // 线路标签层级 + 字号随地图缩放\nview.updateLabel('point', 'a', { zIndex: null, zoomScale: null }) // 回到配置默认\n","from":"header"}] },
|
|
265
271
|
{ name: "addLabel", kind: "method", params: "kind / ref 同上;definition: GisViewItemLabel 一条标签的定义(与配置里同一套写法:content / position / offset / style / html…);labelId?: string 指定 id(缺省自动取 note1 / note2…)", returns: "GisViewLabelState | null", doc: "运行时加一条标签(不写进业务数据):definition 与配置里的一条同一套写法,id 缺省自动取 note1 / note2…;同 id 已存在时按 updateLabel 处理", examples: [{"group":"标签","code":"// addLabel(kind, ref, definition, labelId?) / removeLabel(kind, ref, labelId?)\nconst addedLabel = view.addLabel('point', 'a', { content: '{name} 备注', position: 'bottom' })\nview.addLabel('point', 'a', { content: '临时' }, 'note9')\nview.removeLabel('point', 'a', 'note9')\nview.removeLabel('point', 'a') // 缺省摘 'default'\n","from":"header"}] },
|
|
266
272
|
{ name: "removeLabel", kind: "method", params: "kind / ref;labelId?: string 删哪一条(缺省 'default')", returns: "GisViewRemoveLabelResult | null", doc: "删一条标签:运行时加的(addLabel)删掉那一份;数据 / 配置里还声明着同 id 的标签时再标一条隐藏(它照样会画出来,数据是使用方的,组件只记一条覆盖)。返回 { removed, hidden },找不到返回 null", examples: [{"group":"标签","code":"// addLabel(kind, ref, definition, labelId?) / removeLabel(kind, ref, labelId?)\nconst addedLabel = view.addLabel('point', 'a', { content: '{name} 备注', position: 'bottom' })\nview.addLabel('point', 'a', { content: '临时' }, 'note9')\nview.removeLabel('point', 'a', 'note9')\nview.removeLabel('point', 'a') // 缺省摘 'default'\n","from":"header"}] },
|
|
267
273
|
{ name: "addLabels", kind: "method", params: "kind;refs: GisViewLabelRef | 数组 批量定位(单个 / 数组 / 'all' / 'visible' / 'selection',线路还认 { channel } / { group });definition 一条定义、定义数组,或 (item, index) => 定义;options: { labelId?, overwrite? } 已有同 id 的缺省跳过、overwrite: true 覆盖", returns: "GisViewAddLabelsResult", doc: "批量加同一套标签:refs 见「统一加 / 改 / 删一批标签」(单个 / 数组 / 'all' / 'visible' / 'selection' / { channel } / { group }),definition 认一条定义、数组或 (item, index) => 定义,已有同 id 的缺省跳过、options.overwrite 覆盖;返回 { kind, requested, added, updated, skipped }", examples: [{"group":"标签","code":"// addLabels(kind, refs, definition, options?):批量加(refs 认 'all' / 'visible' / 'selection' / 数组)\nview.addLabels('point', 'all', { content: '{name}' })\nview.addLabels('point', ['a', 'b'], item => ({ content: item.name }), { labelId: 'tag' })\nview.addLabels('line', { channel: 'c1' }, { content: '{name}' }, { labelId: 'tag', overwrite: true })\n","from":"header"}] },
|
|
@@ -299,7 +305,7 @@ export const API_SECTIONS = [
|
|
|
299
305
|
{
|
|
300
306
|
title: "导出",
|
|
301
307
|
items: [
|
|
302
|
-
{ name: "exportData", kind: "method", params: "options: GisViewExportDataOptions:scope('all' 缺省 / 'viewport' / 'selection',也认 visible / view / selected)、format('view' 缺省 / 'input' / 'new' / 'test' / 'full')、parts(只导 points / lines / channels / parallelGroups 里的哪几份)、points / lines / channels(只导指定要素)、withLines: false(selection 不要两端都在集合里的线路)、labels、extra。format: 'full' / 'input' 返回可直接回灌的数据,不夹带 scope / counts 读数", returns: "GisViewExportDataResult | GisViewDocument(format: 'full')", doc: "统一导出入口:scope 选范围('all' 缺省 / 'viewport' / 'selection',也认 visible / view / selected),parts 选分项,format 选口径。format: 'view'(缺省)给 { points, lines, channels, parallelGroups }、'new' 给 new.json 口径、'test' 给 test.json 口径、'input' 给与 createGisView 入参同构的回灌口径、'full' 给标准文档;format 也可以是注册过的自定义名字。points / lines / channels
|
|
308
|
+
{ name: "exportData", kind: "method", params: "options: GisViewExportDataOptions:scope('all' 缺省 / 'viewport' / 'selection',也认 visible / view / selected)、format('view' 缺省 / 'input' / 'new' / 'test' / 'full')、parts(只导 points / lines / channels / parallelGroups 里的哪几份)、points / lines / channels(只导指定要素)、selectionKinds(仅 viewport,支持 lineEndpoints / channelEndpoints)、withLines: false(selection 不要两端都在集合里的线路)、labels、extra。format: 'full' / 'input' 返回可直接回灌的数据,不夹带 scope / counts 读数", returns: "GisViewExportDataResult | GisViewDocument(format: 'full')", doc: "统一导出入口:scope 选范围('all' 缺省 / 'viewport' / 'selection',也认 visible / view / selected),parts 选分项,format 选口径。format: 'view'(缺省)给 { points, lines, channels, parallelGroups }、'new' 给 new.json 口径、'test' 给 test.json 口径、'input' 给与 createGisView 入参同构的回灌口径、'full' 给标准文档;format 也可以是注册过的自定义名字。points / lines / channels 可以只要一部分;scope: 'viewport' 可用 selectionKinds 按类型或 lineEndpoints / channelEndpoints 筛。解不出的引用进 warnings,format 写错(或没注册)抛异常,见「导出数据」与「自定义导出格式」", examples: [{"group":"导出","code":"// exportData(options?):统一入口 —— scope 选范围(all / viewport / selection),parts 选分项,format 选口径\nconst viewFormat = view.exportData() // 全量 + view 口径(缺省)\nconst inViewport = view.exportData({ scope: 'viewport', margin: 24 }) // 视口内,可外扩 24 屏幕像素\nconst endpointsOnly = view.exportData({ scope: 'viewport', selectionKinds: ['lineEndpoints', 'channelEndpoints'] }) // 两端节点都在视口内\nconst picked = view.exportData({ scope: 'selection', parts: ['station', 'channel'], withLines: true })\nconst fullDoc = view.exportData({ format: 'full' }) // 标准数据文档:整份喂回 createGisView / importData 就回到这一屏\nconst testFormat = view.exportData({ format: 'test', parts: ['line', 'waypoint'] })\nconst onlyPoints = view.exportData({ points: ['a', 'b'], labels: false, extra: { exported_at: Date.now() } })\n","from":"header"},{"group":"导出","code":"// exportSelection(options?) / exportData({ scope: 'selection' }):导出选中的那几个\nconst exportedSelection = await view.exportSelection({ withLines: true, scale: 2 })\nview.exportSelection({ points: ['a', 1], format: 'data', withLines: false })\nconst selectionData = view.exportData({ scope: 'selection', parts: ['station', 'channel'] })","from":"header"}] },
|
|
303
309
|
{ name: "exportImage", kind: "method", params: "options?: GisViewExportImageOptions:type('image/png' / 'image/jpeg' / 'image/webp' / 'svg')、quality(JPEG / WebP 0 ~ 1)、scale(导出倍数;SVG 只影响宽高)、scope('viewport' 缺省 / 'all' 全部内容)、padding(scope: 'all' 的留白,缺省 24)、background(缺省带背景 / false 或 'none' 透明 / 颜色字符串换底色)、includeLabels(缺省 true)、download(true 或文件名)", returns: "Promise<string>(data URL)", doc: "导出当前画面(含标签)为图片,返回 data URL;scope: 'viewport'(缺省)导当前视口、'all' 临时适应全部可见内容,另有 padding / type / quality / scale / background / includeLabels / download,见「导出图片」", examples: [{"group":"导出","code":"// exportImage(options?):导出图片(Promise<dataURL>;type: 'svg' 走矢量导出)\nconst imageUrl = await view.exportImage({ scale: 2, background: '#ffffff' })\nawait view.exportImage({ type: 'image/jpeg', quality: 0.9, download: '场景.jpg' }) // 也可以直接下载\nawait view.exportImage({ scope: 'all', padding: 24, includeLabels: false }) // 全部内容(导完恢复相机)\n","from":"header"}] },
|
|
304
310
|
{ name: "exportSelection", kind: "method", params: "options?: GisViewExportSelectionOptions:format / type / quality / scale / padding(只导选中要素那一块)", returns: "Promise<GisViewExportSelectionResult>", doc: "把选中的节点(可选带上两端都在集合里的线路)单独导成图片 / 数据:points 不给就用选中集,withLines / format / padding 见「导出选中的节点」;返回 { ok, reason, points, lines, counts, box, pointIndexes, lineIndexes, image },出图时临时藏起别的要素与相机、出完还原", examples: [{"group":"导出","code":"// exportSelection(options?) / exportData({ scope: 'selection' }):导出选中的那几个\nconst exportedSelection = await view.exportSelection({ withLines: true, scale: 2 })\nview.exportSelection({ points: ['a', 1], format: 'data', withLines: false })\nconst selectionData = view.exportData({ scope: 'selection', parts: ['station', 'channel'] })","from":"header"}] },
|
|
305
311
|
]
|
|
@@ -377,6 +383,7 @@ export const API_OPTIONS = [
|
|
|
377
383
|
{ name: "channelTangentInset", type: "number | null", defaultValue: "null", doc: "两端切点往节点里收多少 CSS 像素:缺省(null)按成员回线里最粗那条的线宽收,线因此不会从节点边缘探出去;0 表示切点正好落在节点边上,负数外收(切点往节点外让、回线整段比节点宽);单个通道可用 tangentInset 覆盖;内收两侧合计最多收掉节点宽度的 40%,外收单侧最多让出 50%" },
|
|
378
384
|
{ name: "channelMaxGroups", type: "number", defaultValue: "0", doc: "一条通道最多几个分组(0 表示不限):新增通道时用来判断还能不能变成新分组,见「新增通道」" },
|
|
379
385
|
{ name: "channelGroupMaxLines", type: "number", defaultValue: "0", doc: "一个分组最多几条回线(0 表示不限):新增通道时用来判断还能不能并进某一组,见「新增通道」" },
|
|
386
|
+
{ name: "channelSimplify", type: "boolean | GisViewChannelSimplifyOptions", defaultValue: "false", doc: "通道简略:true 用缺省阈值 4;对象可调 enabled / threshold / style。分组回线数严格大于阈值时只画一条代表线,见「通道简略(channelSimplify)」" },
|
|
380
387
|
{ name: "channelDraftStyle", type: "GisViewChannelDraftStyle", defaultValue: "蓝色 2px + 两端圆点,箭头关闭", doc: "新增通道草稿预览的全局样式:color / width / dot / dotColor / dots(false 关示例点,或 { show, size, color, shape, from, to } 分端配置;示例点固定在点中的节点中心)/ layer('above' 默认,'below-points' 让示例线 / 箭头 / customDraw 位于真实节点之下)/ arrow / arrowSize / arrowPositions / arrowReverse / arrowColor / circuitSpacing / opacity / customDraw;beginAddChannel({ channelDraftStyle }) 可按这一次草稿覆盖,updateAddChannelStyle(patch) 可在草稿期间增量修改" },
|
|
381
388
|
{ name: "webglLayers", type: "GisViewWebGLLayer[]", defaultValue: "[]", doc: "WebGL 自定义绘制层:每层提供 draw({ gl, canvas, viewport, camera, frame, project, unproject, requestRender }),在内置内容之后按 order 绘制;运行时也可用 addWebGLLayer / updateWebGLLayer / removeWebGLLayer 维护" },
|
|
382
389
|
{ name: "background", type: "GisViewBackground", defaultValue: "浅色底", doc: "背景层,支持底色、图片与 GeoJSON" },
|
|
@@ -388,10 +395,10 @@ export const API_OPTIONS = [
|
|
|
388
395
|
{ name: "effects", type: "GisViewEffectsInput", defaultValue: "关", doc: "动画效果(全局缺省):线路上的跑动图标(line,ECharts lines.effect 那一类)与节点上的扩散涟漪(point,effectScatter 那一类),逐要素用 points[].effect / lines[].effect 覆盖;没配就是关的,但「只在数据里逐条配了 effect」的场景照样会动。false 或 { enabled: false } 是一处关掉(谁都别动);运行时有 updateOptions({ effects }) / getEffects() / getLineEffects(),见「动画效果(effects)」" },
|
|
389
396
|
{ name: "lineDirection", type: "GisViewLineDirectionInput", defaultValue: "关(null)", doc: "线路方向箭头(全局缺省):沿线摆一串静态箭头,朝向跟着线路切向走(起点 / from 那一端 → 终点,reverse 指回上游),按弧长等分、缺省每条线只在中点一个;逐条线路用 lines[].direction 覆盖,写法与 effects 同构(true 用全局、对象逐字段覆盖、false / null 关掉),见「线路方向箭头(lineDirection)」" },
|
|
390
397
|
{ name: "prebake", type: "GisViewPrebakeOptions | true", defaultValue: "关", doc: "贴图符号预热:把「这次画面会出现什么」提前告诉组件 —— 两种写法:combos 逐组合(精确,getSymbolCombos() 收出来的那份)/ symbols × pointColors × sizes 与 lineColors × 线路动画图标 全排列(省事,颜色与尺寸由同一个字段决定时会多烤很多)—— 第一帧之前就烤好,画到它们时命中的是现成的贴图(省掉解码 + 光栅化那一下);组合数与数据量无关,不配就是从前那条按需路径。读数 getPrebake() / getSymbolCombos()、手动再烤一遍 runPrebake(),见「贴图符号预热(prebake)」" },
|
|
391
|
-
{ name: "label", type: "GisViewLabelOptions | GisViewLabelOptions[]", defaultValue: "无", doc: "节点标签:内容 / 位置 / 显隐 / 避让 / 拖动与编辑都可配,写数组就是同一个节点上多条标签,与 lineLabel
|
|
398
|
+
{ name: "label", type: "GisViewLabelOptions | GisViewLabelOptions[]", defaultValue: "无", doc: "节点标签:内容 / 位置 / 显隐 / 避让 / 层级 / 缩放字号 / 拖动与编辑都可配,写数组就是同一个节点上多条标签,与 lineLabel 共用一套避让网格;zIndex 显式定层,followNodeZIndex 跟随节点样式链,zoomScale 控制字号是否随地图缩放,见「节点标签」" },
|
|
392
399
|
{ name: "labelOptimize", type: "boolean", defaultValue: "false", doc: "标签显示优化开关:缺省关 = 强制显示(不避让、不按 maxCount 截断、不设 scanLimit / 扫描预算,节点 / 线路的每个可见要素该出现的标签一条不少);写 true 与从前一致 —— 避让 / 换落点 / 数量上限 / 候选上限全部生效。标签订得密、数据量大(十万级)时建议打开,见「标签显示优化开关」" },
|
|
393
400
|
{ name: "labelRender", type: "'auto' | 'canvas' | 'dom'", defaultValue: "'auto'", doc: "纯文本标签的容器渲染方式:auto 在强制显示档(labelOptimize 未开且未进密集档)下,同一层纯文本标签达到 1024 条时改画到一张 Canvas;canvas 不受数量阈值限制,优化档 / 密集档也强制画布并直接用画布尺寸参与避让;dom 始终逐条建 .gis-view__label。HTML / 元素内容 / 可拖拽 / 可编辑 / 超出 Canvas 样式能力的标签仍走 DOM。只影响容器,不改内容、锚点、显隐以及 maxCount / when / scanLimit 等优化策略,见「标签容器渲染(labelRender)」" },
|
|
394
|
-
{ name: "lineLabel", type: "GisViewLineLabelOptions | GisViewLineLabelOptions[]", defaultValue: "无", doc: "线路标签:位置沿线走(比例 / 百分比 /
|
|
401
|
+
{ name: "lineLabel", type: "GisViewLineLabelOptions | GisViewLineLabelOptions[]", defaultValue: "无", doc: "线路标签:位置沿线走(比例 / 百分比 / 绝对距离),内容、避让、显隐、层级与缩放字号都可配,与节点标签共用一套避让网格;写数组就是同一条线上多条标签,见「线路标签」" },
|
|
395
402
|
{ name: "labelStates", type: "GisViewLabelState[]", defaultValue: "无", doc: "标签的运行时状态(getLabelStates() 的那一份:拖出来的偏移、改过的内容与样式、运行时加的标签、隐藏覆盖):创建时喂回来就回显,等价于创建之后调 setLabelStates(states);updateOptions({ labelStates }) 同样认。exportData({ format: 'input' }) 的结果里就叫 labelStates,存档 → 回灌直接接上" },
|
|
396
403
|
{ name: "graphics", type: "GisViewGraphic[]", defaultValue: "无", doc: "与节点无关的扩展图形:按世界坐标放 SVG 路径 / 图片 / Canvas,支持锚点、偏移、旋转、透明度、zIndex 与 scaleWithView;位于画布之上、标签之下,运行时用 addGraphic / addGraphics / updateGraphic / removeGraphic / clearGraphics 增删改,见「扩展图形(graphic)」" },
|
|
397
404
|
{ name: "tooltip", type: "GisViewTooltipOptions", defaultValue: "无", doc: "悬停提示:点 / 线 / 通道分别配置内容,见「悬浮提示」" },
|
|
@@ -417,7 +424,7 @@ export const API_OPTIONS = [
|
|
|
417
424
|
{ name: "boxSelect", type: "boolean", defaultValue: "false", doc: "是否允许按住框选快捷键(shortcuts.boxSelect,默认 Shift)拖动鼠标框选要素;缺省关,写 boxSelect: true 或 features: { boxSelect: true } 才开。框选默认只收节点,selectionKinds 可把线路 / 通道也纳入" },
|
|
418
425
|
{ name: "multiSelect", type: "boolean", defaultValue: "false", doc: "多选开关:打开后不用按修饰键,直接单击节点 / 线路就取反累加选中(与按住 shortcuts.multiSelect 点击同一套行为、同一个 multiSelectStyle;取反那一下不经过 onClick,onSelectChange.action.type 是 toggleSelect);缺省关,关着时多选走框选(boxSelect)与按住多选快捷键(默认 Ctrl / ⌘)。运行时 updateOptions({ multiSelect }) 切换只重画一帧、不重排场景" },
|
|
419
426
|
{ name: "selectTrigger", type: "'click' | 'dblClick'", defaultValue: "'click'", doc: "选中触发方式:click 第一次单击就改选中集;dblClick 第一下只派发 onClick,等双击判定命中的第二下才改选中集,并同时派发 onClick 与 onDblClick。Ctrl / ⌘ 多选与 multiSelect 在双击模式下同样等第二下才取反。运行时走 updateOptions({ selectTrigger }),只重画一帧、不重排场景" },
|
|
420
|
-
{ name: "selectionKinds", type: "GisViewSelectionKindsInput", defaultValue: "无(框选只收节点;Ctrl 多选收节点 / 线路 / 通道)", doc: "框选与 Ctrl / 多选点击的类型过滤:'point' 节点、'line' 通道外的独立线路、'channel'
|
|
427
|
+
{ name: "selectionKinds", type: "GisViewSelectionKindsInput", defaultValue: "无(框选只收节点;Ctrl 多选收节点 / 线路 / 通道)", doc: "框选与 Ctrl / 多选点击的类型过滤:'point' 节点、'line' 通道外的独立线路、'channel' 通道回线;另有 'lineEndpoints' / 'channelEndpoints',只在框选时要求线路 / 通道两端节点都在框内。可写数组任意组合,'all' / true 全开,false / null 全关。通道回线只归 channel 管,通道外的线路只归 line 管;通道回线仍按 channelSelectMode 摊开。不写时保留旧口径;普通单选与 select / selectFeatures 不受它限制。运行时走 updateOptions({ selectionKinds }),见「框选」与「选择类型过滤」" },
|
|
421
428
|
{ name: "selectionBoxStyle", type: "GisViewSelectionBoxStyle", defaultValue: "蓝底 0.16 透明 + 1px 蓝框", doc: "框选矩形的填充与边框:fill、fillOpacity、stroke、strokeWidth" },
|
|
422
429
|
{ name: "selectionOnTop", type: "boolean", defaultValue: "true", doc: "选中的节点 / 拖动中的整组 / 待确认合并的目标节点,以及选中线路所在的整条通道,是否画在所有要素之上(与 zIndex 无关),见「选中 / 拖动的层级」" },
|
|
423
430
|
{ name: "channelSelectMode", type: "'line' | 'group' | 'channel'", defaultValue: "'line'", doc: "通道选中模式:点中通道里的一条回线时选中什么 —— 'line' 只选这一条、'group' 连它所在的分组一起、'channel' 整条通道(所有分组的回线);通道以外的线路永远只选自己。普通点选与 Ctrl / ⌘ + 点击加点共用这一档高亮范围;Ctrl / ⌘ + 点击在 group / channel 下按整批取反;切换走 updateOptions({ channelSelectMode }),只重画一帧、不重排场景,见「通道选中模式」" },
|
|
@@ -439,14 +446,17 @@ export const API_OPTIONS = [
|
|
|
439
446
|
{ name: "shortcuts", type: "GisViewShortcuts", defaultValue: "见「快捷键」", doc: "所有快捷键都可自定义:框选 / 多选 / 加点 / 复制 / 粘贴 / 取消 / 删除 / 适应视图,没写的动作沿用默认值,写 false 等于关掉这个动作的快捷键" },
|
|
440
447
|
{ name: "copy", type: "GisViewCopyOptions", defaultValue: "缺省关", doc: "复制节点(写了这份配置才算开,enabled: false 显式关掉):enabled 开关、offset 落点偏移(默认 [28, 24] 像素)、autoCommit(交互入口落地前是否自动确认:不写就是落地,false 停在预览态等 commitPointCopy() / 载荷里的 payload.commit())、idPrefix(默认 copy-)、createId / createItem 定制复制品,见「节点复制」" },
|
|
441
448
|
{ name: "remove", type: "GisViewRemoveOptions", defaultValue: "缺省关", doc: "删除选中的拐点 / 线路 / 节点(写了这份配置才算开,enabled: false 显式关掉):enabled 开关、scope(confirm() 不带参数时的缺省范围:'lines' 只删选中的回线 / 'groups' 连所在分组 / 'channels' 连整条通道,缺省 'lines')、confirm(不写停在 pending 等使用方裁决 / false 直接删 / 函数自行裁决,支持 Promise)。Delete 键与 requestRemove() 都先出一份「要删什么、连带什么」的载荷,确认之后才动数据;删节点会连挂在它身上的线路与被它锚定的通道一起删,见「删除(remove)」" },
|
|
442
|
-
{ name: "merge", type: "GisViewMergeOptions", defaultValue: "缺省关", doc: "合并节点(写了这份配置才算开,enabled: false 显式关掉):enabled 开关、trigger 触发时机('collision' 两个节点半径相碰 / 'center' 拖动节点中心进入目标节点区域)、distance 额外像素容差、confirm(不写停在 pending 等使用方裁决 / false 直接合并 / 函数自行裁决)、channelGroups('keep' 各自保留分组 / 'merge' 合成一个分组)、createItem 定制合并结果,见「节点合并」" },
|
|
449
|
+
{ name: "merge", type: "GisViewMergeOptions", defaultValue: "缺省关", doc: "合并节点(写了这份配置才算开,enabled: false 显式关掉):enabled 开关、trigger 触发时机('collision' 两个节点半径相碰 / 'center' 拖动节点中心进入目标节点区域)、distance 额外像素容差、confirm(不写停在 pending 等使用方裁决 / false 直接合并 / 函数自行裁决)、channelGroups('keep' 各自保留分组 / 'merge' 合成一个分组)、maxKeys 选哪些字段取双方最高、createItem 定制合并结果,见「节点合并」" },
|
|
443
450
|
{ name: "minScale", type: "number", defaultValue: "0.002 / 20000", doc: "缩放范围(像素 / 世界单位)" },
|
|
444
451
|
{ name: "maxScale", type: "number", defaultValue: "0.002 / 20000", doc: "缩放范围(像素 / 世界单位)" },
|
|
445
452
|
{ name: "fitPadding", type: "number", defaultValue: "48", doc: "适应视图时四周留白(CSS 像素);留白比画布还大时按「内容至少留 48px」反过来压留白,不会把内容挤成一个点" },
|
|
446
453
|
{ name: "fitOnInit", type: "boolean", defaultValue: "true", doc: "首次拿到数据时自动适应视图;配了 initialView 时以它为准(false 只关掉「适应」,initialView 仍然生效,见「初始视图」)" },
|
|
454
|
+
{ name: "center", type: "GisViewCoordinate", defaultValue: "无", doc: "首屏中心 [x, y] / { x, y },是 initialView.center 的顶层简写;显式给出非空 initialView 时以那一份为准" },
|
|
455
|
+
{ name: "scale", type: "number", defaultValue: "无", doc: "首屏绝对比例(像素 / 世界单位),是 initialView.scale 的顶层简写;显式给出非空 initialView 时以那一份为准" },
|
|
447
456
|
{ name: "initialView", type: "GisViewInitialView", defaultValue: "无", doc: "首次加载的相机落位:中心点、绝对比例、相对放大倍数或要适应的范围,见「初始视图」" },
|
|
448
457
|
{ name: "progressiveInit", type: "boolean", defaultValue: "true", doc: "大数据(2 万点以上)初始化是否从视图中心向外发散渲染:首帧只排中心附近的一批,剩下的分帧往外补,见「大数据量」" },
|
|
449
458
|
{ name: "statsInterval", type: "number", defaultValue: "250", doc: "onStats 的最小间隔(毫秒),0 表示每帧都发" },
|
|
459
|
+
{ name: "idleTimeout", type: "number", defaultValue: "0(关闭)", doc: "用户操作空闲阈值(毫秒):根节点上这么久没有指针 / 滚轮 / 键盘活动就发一次 onIdle / idle;每个空闲段只触发一次,恢复操作后重新计时" },
|
|
450
460
|
{ name: "renderEmitInterval", type: "number", defaultValue: "400", doc: "onRender 的节流间隔(毫秒),0 与 onStats 同拍(再配上 statsInterval: 0 就是每帧一条)" },
|
|
451
461
|
{ name: "plugins", type: "GisViewPlugin[]", defaultValue: "[]", doc: "插件:(view, context) => hook,返回的 destroy 在实例销毁时倒序回调,见「插件」" },
|
|
452
462
|
{ name: "zoomStep", type: "number", defaultValue: "1.4", doc: "zoomIn() / zoomOut() 的步进倍率" },
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
| `shadow` | `GisViewShadow` | 无(不画阴影) | 阴影:`{ color, blur, offsetX, offsetY }`,偏移与模糊都是 CSS 像素 |
|
|
16
16
|
| `visible` | `boolean` | `true` | `false` 时这个节点不画(等价于被筛选隐藏,但数据还在);被它锚定的通道与回线一起消失 |
|
|
17
17
|
| `clickable` / `draggable` / `copyable` / `mergeable` | `boolean` | 前两个跟随 `options.clickable` / `options.draggable`(**`options.draggable` 缺省关**:不写它就没有节点可拖,逐条的 `draggable: true` 也得等这个总开关或者 `features.drag` 打开才生效);`copyable` / `mergeable` 缺省 `true` | 逐条覆盖 `options` 上的同名开关 |
|
|
18
|
+
| `mergeInfo` | `GisViewMergeInfo \| null` | 无 | `mergePoints` / `mergeSelectedPoints` 写入的合并追溯(版本 `1`):保留节点保存 `targetPoint`、`sourceIds`、来源 `points` 快照与受影响 `lines` / `channels` 快照;`splitPoint(source)` 省略 `parts` 时据此自动解除合并。可 JSON 序列化,随数据导出;保留字段,业务数据不要占用。字段详解见 [manual 07 的「合并追溯」](../manual/07-%E6%8C%87%E9%92%88%E4%B8%8E%E8%A6%81%E7%B4%A0%E7%BC%96%E8%BE%91.md#%E5%90%88%E5%B9%B6%E8%BF%BD%E6%BA%AFmergeinfo) |
|
|
18
19
|
| `cursor` / `ctrlCursor` | `GisViewCursorValue` | 跟随 `options.cursorStyle.point` / `cursorStyle.ctrl.point` | 悬停这个点时的光标(按住 Ctrl / ⌘ 时用后者),写法见 GisView.md 的「光标」 |
|
|
19
20
|
| `hoverStyle` / `selectStyle` / `multiSelectStyle` / `boxSelectStyle` | `GisViewPointStyle` | 分别跟随 `options.pointHoverStyle` / `pointSelectStyle` / `pointMultiSelectStyle` / `pointBoxSelectStyle`(后两个缺省回落到选中样式) | 逐条覆盖悬停 / 选中 / Ctrl 多选 / 框选样式,按字段覆盖自身样式 |
|
|
20
21
|
| `labels` | `GisViewItemLabel \| GisViewItemLabel[]` | 无(不写且没配 `label` 就不画标签) | 这个点上的标签清单(可以多条),见下文「标签」;`labelVisible` / `labelVisibility` / `labelPosition` / `labelOffset` 是旧式单条写法 |
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| `from` / `to` | `string \| number` | **必填** | 两端节点 id,节点不存在时整条通道与回线一起不显示;两端都要落在节点上,只声明一端不行 |
|
|
12
12
|
| `circuits` | `number` | `1` | 回线数量(`createChannels` 用它展开回线) |
|
|
13
13
|
| `lineIds` | `Array<string \| number>` | 无(`createChannels` 生成的那一份就是它) | 组成这条通道的线路 id,**顺序即回线顺序**(沿骨架左法线从负到正) |
|
|
14
|
+
| `mergeInfo` | `GisViewMergeInfo \| null` | 无 | 合并后仍存在的受影响通道带轻量追溯:`{ version, targetId, sourceIds, originalIds }`;`originalIds` 是参与合并、被改端点或被并掉的原始通道 id,便于后端对账。可 JSON 序列化;保留字段,业务数据不要占用。完整快照在保留节点的 `mergeInfo` 上 |
|
|
14
15
|
| `path` | `GisViewCoordinate[]` | 无(两端直连) | 骨架的**中间拐点**(不含两端,两端由节点坐标补齐):与线路的 `path` 相反,这里只写中间 |
|
|
15
16
|
| `groups` | `GisViewChannelGroup[]` | 无(= 一个通道一组) | 分组声明:`[{ id, lineIds, path, waypointOffsets? }]`,一组一条走廊;拆分 / 合并的结果写在这里,见「分组」 |
|
|
16
17
|
| `width` / `offsetMode` / `inset` / `tangentInset` | `number` / `'tangent' \| 'inset'` / `number` / `number \| null` | 分别回落到 `options.channelWidth`(`0.02`)/ `'tangent'` / `options.channelInset`(`0`)/ `options.channelTangentInset`(`null` = 按回线线宽收) | 通道外观:宽度(`tangent` 下是最外侧两条回线的中心距)、偏移方式、内收比例(负数为外收)、两端切点内收 |
|
|
@@ -19,6 +20,8 @@
|
|
|
19
20
|
| `lineProps` / `linePropsByMember` | `Partial<GisViewLine>` / 数组 | 无 | 回线上透传的业务字段(`lineProps` 全体共用、`linePropsByMember[i]` 只作用第 i 回,后者优先) |
|
|
20
21
|
| `channelProps` | `Partial<GisViewChannel>` | 无 | 通道上额外透传的字段(原样带到通道声明里) |
|
|
21
22
|
|
|
23
|
+
`channelSimplify` 是视图级渲染选项(`options.channelSimplify`),不是通道数据字段:它可以让分组在回线数超过阈值时只画一条代表线,但不写入 `channels`、不改 `lineIds` / `groups`,也不会出现在 `exportData()` 的通道字段里。
|
|
24
|
+
|
|
22
25
|
### 通道分组(拐点分组 / parallel_groups)
|
|
23
26
|
|
|
24
27
|
- **一组**(默认):`lineIds` 是全部成员、`path` 是这一组的拐点;`getChannelGroups(id)` 返回一组。
|