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
|
@@ -613,13 +613,12 @@ onPointMerge: async payload => {
|
|
|
613
613
|
|
|
614
614
|
接口调用不做确认,直接按规则合并:`view.mergePoints('a', 'b')`(来源、目标收 id、下标或 `{ id }` / `{ index }`)。合并的数据规则是:
|
|
615
615
|
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
-
|
|
619
|
-
-
|
|
620
|
-
-
|
|
621
|
-
-
|
|
622
|
-
- 合并后两端落在同一个节点上的自环线路、缩成一个点的零长度线路,以及两端因此相同的通道(成员回线跟着一起)直接删掉;
|
|
616
|
+
- **缺省以保留节点为底**:名称、图标类型、颜色、业务属性等普通字段都取保留节点;拖动合并缺省保留碰撞目标,`keep: 'source'` 时保留拖动的来源节点。只有 `merge.maxKeys` 列出的字段取双方最高值:数组或逗号分隔字符串,缺省空表(一个都不取);每个键把双方能解析成有限数字的值收集起来取 `Math.max`,空串、`null`、非数字当没给,只有一方有效就用那一方,两边都无效时保持保留节点的原值。例如 `merge: { maxKeys: ['vn_kv', 'value'] }` 只把电压与 `value` 保留最高值,其余字段仍取保留端。
|
|
617
|
+
- **图标大小取双方解析后样式的最大值**:高电压往低电压合,图标跟着变大(结果写成节点自己的 `size`,`sizeScale` 归 1);**图标类型只用保留节点**,保留端没配图标不会回落到来源端的业务字段。
|
|
618
|
+
- 想自己决定业务字段就用 `merge.createItem(source, target, context)`,`context` 里带双方的 `sourceStyle` / `targetStyle`(`{ index, size, symbol, zIndex }`,样式链定下来的那一份,不含状态样式与热力倍率);最终 `id`、坐标与 `mergeInfo` 始终由组件按保留节点维护,`merge.createItem` / `options.item` 改不了这三样。
|
|
619
|
+
- 绑在被并入节点 id 上的线路(`from` / `to`)改绑到保留节点,端点 / 顶点坐标与被并入端重合的也一并改到保留端坐标;id 比较会把数字和同值字符串当成同一个(`1` 与 `'1'`)。
|
|
620
|
+
- **通道端点也跟着改**:通道的 `from` / `to` 指向被并入节点时改到保留节点;改完两端相同的通道整条删掉,成员回线跟着删除。
|
|
621
|
+
- 合并后两端落在同一个节点上的自环线路、缩成一个点的零长度线路一起删掉;
|
|
623
622
|
- **两端因此撞成同一条的通道合成一条**:`merge.channelGroups` 决定回线怎么分组 —— `'keep'`(默认)各自保留自己的分组,`'merge'` 合成一个分组(回线取并集);
|
|
624
623
|
- 结果里带 `linesChanged`、`removedLines`、`removedChannels`、`mergedChannels`、`channelsChanged` 五个读数;自己接管数据落地时用 `commitPointMerge()` / `revertPointMerge()` 收尾。
|
|
625
624
|
|
|
@@ -633,7 +632,7 @@ onPointMerge: async payload => {
|
|
|
633
632
|
返回值就是收尾那条 `phase: 'mergeSelected'` 的载荷:`{ ok, reason, target, merged, sourcesMerged, skipped, linesChanged, removedLines, removedChannels, mergedChannels, channelsChanged }` ——
|
|
634
633
|
`merged` 逐对列出(每项与 `mergePoints` 的返回同形),没选中 / 不够两个 / 都并不了时 `ok: false` 且 `reason` 说明原因(不抛异常)。
|
|
635
634
|
|
|
636
|
-
**指定保留谁、改写最终节点**:`target`
|
|
635
|
+
**指定保留谁、改写最终节点**:`target` 就是最后留下的那个节点(坐标、id 与 `mergeInfo` 都按它保留,不指定才自动挑)。`options.item` 可以给一份最终节点补丁,或者给 `(context) => 补丁` 按每一对现算 —— `context` 里有 `item` / `merged`(缺省合并结果)、`source` / `target`、`sourceIndex` / `targetIndex`、`merge`(与 `merge.createItem` 同一份上下文)与 `view`;返回 `undefined` 表示沿用缺省结果。坐标、id 与 `mergeInfo` 不会被补丁改掉。
|
|
637
636
|
|
|
638
637
|
```js
|
|
639
638
|
view.mergeSelectedPoints({
|
|
@@ -648,11 +647,48 @@ view.resolvePointMerge(true) // 确认
|
|
|
648
647
|
view.resolvePointMerge(false) // 取消:拖动的节点回原位,数据不动
|
|
649
648
|
```
|
|
650
649
|
|
|
650
|
+
### 合并追溯(mergeInfo)
|
|
651
|
+
|
|
652
|
+
`mergePoints` / `mergeSelectedPoints` 落地时会给保留节点写一份可序列化的 `mergeInfo`(格式版本 `version: 1`),用来回答「这个节点并过谁、合并前长什么样」,也是 `splitPoint(source)` 自动解除合并的输入。完整字段是:
|
|
653
|
+
|
|
654
|
+
| 字段 | 说明 |
|
|
655
|
+
| --- | --- |
|
|
656
|
+
| `version` | 追溯格式版本,当前固定为 `1`;不认这个版本的同名字段不会当快照使用 |
|
|
657
|
+
| `targetId` | 保留节点的 id(通道上的同一字段表示合并到的目标节点) |
|
|
658
|
+
| `targetIndex` | 第一次合并时保留节点在原 `points` 里的下标,仅作恢复时没有 id 的兜底 |
|
|
659
|
+
| `targetPoint` | 保留节点第一次合并前的完整快照(不含上一份 `mergeInfo`) |
|
|
660
|
+
| `sourceIds` | 依次并进来的来源节点 id,按发生顺序追加 |
|
|
661
|
+
| `points` | 来源节点快照:每项 `{ index, id, item }`,`item` 是来源合并前的数据;恢复时按 `index` 顺序放回 |
|
|
662
|
+
| `lines` | 受影响线路第一次合并前的快照:每项 `{ index, id, item }`,用来恢复改绑、几何与删除 |
|
|
663
|
+
| `channels` | 受影响通道第一次合并前的快照:每项 `{ index, id, item }`,用来恢复端点、分组与回线归属 |
|
|
664
|
+
|
|
665
|
+
同一个保留节点连续并多个来源时,`sourceIds` 与 `points` 继续累加,`targetPoint` 仍是第一次合并前的数据;`lines` / `channels` 只保留第一次遇到的那份快照,避免后面的快照覆盖真正的合并前状态。合并后仍然存在的受影响通道另写一份轻量 `mergeInfo`:`{ version, targetId, sourceIds, originalIds }`,`originalIds` 是参与这次合并、被改端点或被并掉的原始通道 id,便于后端按原通道对账;它不承担单独恢复节点的职责。
|
|
666
|
+
|
|
667
|
+
`mergeInfo` 会随 `getData()` / `exportData()` 的 `points` / `channels` 一起导出,JSON 序列化后可直接回灌。它是组件的保留字段,业务数据不要占用;合并结果里的 `id`、坐标与这个字段都由组件维护。
|
|
668
|
+
|
|
651
669
|
删节点用 `view.removePoints('a')` / `view.removePoints({ index: 2 })` / 数组:绑在它上面的线路一并删掉,声明了它当端点的整条通道(含成员回线)跟着删。
|
|
652
670
|
|
|
653
671
|
## 节点拆分(splitPoint)
|
|
654
672
|
|
|
655
|
-
`splitPoint` 是 `mergePoints`
|
|
673
|
+
`splitPoint` 是 `mergePoints` 的逆操作,有两条路:`splitPoint(source)` 按 `mergeInfo` 自动恢复;传 `parts` 时则把一个节点按业务需要手工拆成两份或更多,原来连在它身上的线路与通道两端按分配重新挂到新节点上。它不弹对话框,直接按规则落地;整次调用只记一条历史、只发一条 `splitPoint` 数据变更。
|
|
674
|
+
|
|
675
|
+
**自动解除合并**:`splitPoint(source)` 省略 `parts`(或显式传 `null` / `[]`)时读取保留节点的 `mergeInfo`,恢复第一次合并前的保留节点与全部来源节点,再按快照恢复线路和通道。完整字段见上面「合并追溯(mergeInfo)」;不需要自己再写每个节点的坐标与线路归属。
|
|
676
|
+
|
|
677
|
+
```js
|
|
678
|
+
const restored = view.splitPoint('hub') // 等价于 splitPoint('hub', null) / splitPoint('hub', [])
|
|
679
|
+
if (!restored.ok) console.warn(restored.reason)
|
|
680
|
+
console.log(restored.autoRestored, restored.mergeSourceIds) // true / ['a', 'b', ...]
|
|
681
|
+
console.log(restored.changes) // 可直接提交后端事务
|
|
682
|
+
// 默认不选中恢复结果;需要选中全部结果时:splitPoint('hub', null, { select: true })
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
恢复范围与边界:
|
|
686
|
+
|
|
687
|
+
- 保留节点在原下标恢复成 `targetPoint`,`mergeInfo` 一并移除;来源节点按快照追加到 `points` 末尾。
|
|
688
|
+
- 线路 / 通道先按 id 找当前位置并替换,合并时被删掉的按快照追加回来;合并之后用户新建、且不在这份快照里的节点 / 线路 / 通道不会被删掉。
|
|
689
|
+
- 来源节点 id 如果已经被后来手工新建的节点占用,整次调用返回 `ok: false`,`reason` 说明冲突 id,数据与历史都不动。
|
|
690
|
+
- 自动解除是一步历史:`view.undo()` 一步回到合并后的状态,`view.redo()` 一步恢复解除结果;返回 `autoRestored: true` 与 `mergeSourceIds`,手工拆分时 `autoRestored` 为 `false`、`mergeSourceIds` 为空数组。
|
|
691
|
+
- 没有 `mergeInfo` 或追溯信息不完整时不会猜测拆法,返回 `ok: false`;要手工拆就继续传两份以上 `parts`。
|
|
656
692
|
|
|
657
693
|
```js
|
|
658
694
|
const split = view.splitPoint('hub', [
|
|
@@ -685,10 +721,11 @@ if (split.ok) {
|
|
|
685
721
|
- **通道端点默认跟第一条被分配过的成员回线**:例如通道里唯一一条回线分给了第二份,通道的 `from` 会自动改到第二份节点,而不是留在第一份;成员都没显式分配时才回落到第一份。显式写了 `channels` / `channelFrom` / `channelTo` 的按显式分配来。
|
|
686
722
|
- **几何一起改**:线路的 `from` / `to` 改到对应新节点;没有 id 绑定、但 `start` / `end` / `path` 顶点与来源坐标重合的端点 / 顶点也改到新坐标。通道端点按新声明重新锚定,成员回线由通道骨架推导,不用逐条改。
|
|
687
723
|
- **拆完清理退化数据**:两端落到同一份、变自环或零长度的线路删掉;两端因此相同的通道删掉;成员回线全被删空的通道也删掉。删除项分别进 `removedLineIds` / `removedLineIndexes` 与 `removedChannelIds`。
|
|
688
|
-
-
|
|
724
|
+
- **结果默认不选中**:`options.select` 缺省 `false`,只把来源节点本身从当前选中集里摘掉,不选中恢复 / 拆分出来的节点,也不动其它无关的线路 / 通道选中;写 `select: true` 时改为选中全部结果节点(替换当前选中集)。自动解除与手工拆分共用这一条。
|
|
725
|
+
- **返回的 `channelsChanged` 只数端点被改写的通道**;被删掉的通道单列在 `removedChannels` / `removedChannelIds`。`autoLines` 是本次采用的口径,`autoAssignedLines` 只数自动分配(没在 `parts[].lines` 里显式写)的线路,`lineAssignments` 按份给出 `{ index, pointId, lineIds, lineCount }`,含显式与自动分配后的最终结果。手工拆分时 `autoRestored` 为 `false`、`mergeSourceIds` 是空数组;自动解除时反过来。`changes` 给 `{ removedPoint, points, lines, removedLines, channels, removedChannels }`:`points` 是拆分后的全部节点,`lines` / `channels` 是仍存在且端点被改写的线路 / 通道,删除项单列;可直接作为后端事务输入。`skipped` 说明哪些线路 / 通道引用没认出来。
|
|
689
726
|
- **撤销**:不用逐条回滚,`view.undo()` 一步回到拆分前;重做一步恢复拆分结果。
|
|
690
727
|
|
|
691
|
-
`CopyMergeDemo.vue`
|
|
728
|
+
`CopyMergeDemo.vue` 的「解除合并」一节可以直接点按钮看效果:优先调用 `splitPoint(source.id, null, { label: '解除合并(自动恢复)', select: splitSelect })`,`splitSelect` 缺省 `false`(不选中恢复结果,读数会写清),勾选后才传 `true`;读数还会列出 `autoRestored`、恢复的来源 id、每个节点恢复后的电压以及改线 / 改通道数。选中项没有 `mergeInfo` 时,Demo 自动退回 `splitPoint(source.id, [A, B], { autoLines: 'alternate', label: '解除合并(手工拆分)', select: splitSelect })`,继续演示新节点 id、自动分线、每份线路数与通道成组结果。演示页的合并读数还会直接显示保留节点的 `mergeInfo`(保留前名称 / 电压、来源、线路与通道快照条数)。
|
|
692
729
|
|
|
693
730
|
## 删除(remove)
|
|
694
731
|
|
|
@@ -31,9 +31,9 @@ view.deselect() // 取消全部
|
|
|
31
31
|
|
|
32
32
|
## 选中 / 拖动的层级(selectionOnTop)
|
|
33
33
|
|
|
34
|
-
`selectionOnTop`(默认 `true
|
|
34
|
+
`selectionOnTop`(默认 `true`)把「选中的节点、拖动中的整组、待确认合并的目标节点」以及「选中线路所在的整条通道」抬到普通节点之上,与 `zIndex` 无关。线路 / 通道的层级高过除两端节点之外的所有节点;两端节点会再抬一层压回线路之上,所以选中一条跨过多层节点的线时,线身可见、接头也不会被线盖住。写 `selectionOnTop: false` 就完全按 `zIndex` 与数据顺序绘制。抬层只在选中 / 拖动 / 合并状态变化时整份重排一次,悬停这类高频路径不参与,十万级数据下不会拖慢交互。
|
|
35
35
|
|
|
36
|
-
落地方式分两条:**节点**的抬层层号写在布局里(`raiseLayer = pointLayerCount + 1`,压在装饰与所有 `zIndex`
|
|
36
|
+
落地方式分两条:**节点**的抬层层号写在布局里(`raiseLayer = pointLayerCount + 1`,压在装饰与所有 `zIndex` 层之上),**线路**的先后写在批次顺序里(抬层的线路排在普通节点之后、抬层节点之前;`snapshotScene()` 另给 `raisedLines`,矢量导出按同一份次序绘制)。因此有三处必须跟着动,缺一处就会出现「被电压等级和原有层级限制」的观感:
|
|
37
37
|
|
|
38
38
|
- 抬层**线路**集合一变就要重铺线路批次(`syncRaiseSets()` 里标 `lineBatchDirty`)—— 否则选中的线路 / 通道不抬层,取消选中也不还原;
|
|
39
39
|
- **拖动中的整组**(`markDragMoved` → `setRaiseExtraPoints`)在起步那一帧先补线路几何、再整份重排一次(`applyDragCoordinate`),此后每帧回到「只按槽位改坐标」的快路径 —— 否则同层拖拽、拖到更高电压等级的节点上都不抬层;
|
|
@@ -59,7 +59,7 @@ createGisView(container, {
|
|
|
59
59
|
})
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
拖动期间选框实时跟随,但事件只在松手时派发一次,不会拖动一帧报一次。**框选默认只收节点**,保持旧口径;写 `selectionKinds`
|
|
62
|
+
拖动期间选框实时跟随,但事件只在松手时派发一次,不会拖动一帧报一次。**框选默认只收节点**,保持旧口径;写 `selectionKinds` 后可以把通道外的线路与通道回线一起纳入(三类任意组合),也可以改用端点口径,只收两端节点都框住的线路 / 通道,见下节。选中结果用 `getSelections()` / `getSelectionData().ids` 读回。用代码框选等价于调用 `selectInBox({ x, y, width, height })`,矩形同样是画布 CSS 像素;第二段还能临时覆盖类型过滤。框选命中的节点套用框选样式(`options.pointBoxSelectStyle`,节点自己的 `boxSelectStyle` 优先),缺省与选中样式完全一致;框选出来的线路走普通的 `lineSelectStyle`(线路没有单独的框选样式)。
|
|
63
63
|
|
|
64
64
|
不想拖动时也可以用 Ctrl(macOS 为 Cmd)逐个点击节点累加选中,命中已选中的节点会把它取消掉;两种方式得到的选中集合一样,之后按住组内任意一个节点拖动就是整组移动。不想按修饰键就把多选开关打开(`options.multiSelect: true`,运行时用 `updateOptions({ multiSelect })` 切):普通单击即取反累加,线路也认(受 `channelSelectMode` 的整组 / 整条摊开约束);单击触发模式下双击的第二次点击不再取反,`onDblClick` 照常派发。多选命中的节点走多选样式(`options.pointMultiSelectStyle`,节点自己的 `multiSelectStyle` 优先),框选命中的走框选样式(`options.pointBoxSelectStyle`,节点自己的 `boxSelectStyle` 优先),两者缺省都与选中样式完全一致。注意框选样式只给节点;选中线路 / 通道回线时仍按 `lineSelectStyle` / `lineMultiSelectStyle` 上色。
|
|
65
65
|
|
|
@@ -85,7 +85,9 @@ view.updateOptions({ selectTrigger: 'click' }) // 运行时切回单击选中
|
|
|
85
85
|
|
|
86
86
|
### 选择类型过滤(selectionKinds)
|
|
87
87
|
|
|
88
|
-
`selectionKinds` 决定**框选与 Ctrl(⌘)/ `multiSelect` 点击**能收哪几类要素。`'point'` 是节点,`'line'` 是通道外的独立线路,`'channel'` 是通道回线;写数组就是任意组合,`'all'` / `true`
|
|
88
|
+
`selectionKinds` 决定**框选与 Ctrl(⌘)/ `multiSelect` 点击**能收哪几类要素。`'point'` 是节点,`'line'` 是通道外的独立线路,`'channel'` 是通道回线;写数组就是任意组合,`'all'` / `true` 五档全开,`false` / `null` 全关。通道回线只受 `channel` 管,通道外的线路只受 `line` 管,所以「只选线路」和「只选通道」可以分开:只开 `line` 时通道回线不会被框到或 Ctrl 选中,只开 `channel` 时独立线路也不会进来。通道回线选上之后仍按 `channelSelectMode` 摊开成一条 / 一组 / 整条通道。
|
|
89
|
+
|
|
90
|
+
另外两档是**框选专用**的端点模式:`'lineEndpoints'` 只收两端节点都在框内的独立线路,`'channelEndpoints'` 只收两端节点都在框内的通道(整条通道命中的是通道本身,不要求回线几何沾框)。纯 `path` 线路、没有真实端点、自环(`from === to`)和端点节点被筛选 / 隐藏的都不会命中;判断只用框内可见节点集合,不要求同时开 `point`,命中后也不会自动把两端节点选进来。它们与旧 `line` / `channel` 可以写在同一数组里,结果是并集;点击多选没有“两端”这个输入,所以端点档不参与 Ctrl / `multiSelect` 点击。
|
|
89
91
|
|
|
90
92
|
```js
|
|
91
93
|
const view = createGisView(container, {
|
|
@@ -99,9 +101,11 @@ view.updateOptions({ selectionKinds: ['point'] }) // 只让框选 /
|
|
|
99
101
|
view.updateOptions({ selectionKinds: 'line' }) // 只收通道外线路
|
|
100
102
|
view.updateOptions({ selectionKinds: ['point', 'channel'] }) // 节点 + 通道,不要独立线路
|
|
101
103
|
view.updateOptions({ selectionKinds: false }) // 两类入口都不再改选中集
|
|
104
|
+
view.updateOptions({ selectionKinds: ['lineEndpoints', 'channelEndpoints'] }) // 只收两端都在框内的线路 / 通道
|
|
102
105
|
|
|
103
106
|
// 接口框选可以只针对这一次临时换过滤,不改全局配置
|
|
104
107
|
view.selectInBox({ x: 40, y: 40, width: 320, height: 200 }, { selectionKinds: ['channel'] })
|
|
108
|
+
view.selectInBox({ x: 40, y: 40, width: 320, height: 200 }, { selectionKinds: ['channelEndpoints'] })
|
|
105
109
|
```
|
|
106
110
|
|
|
107
111
|
**不写 `selectionKinds` 时保留旧行为**:框选只收节点,Ctrl / 多选点击仍收节点与线路(通道回线按 `channelSelectMode` 摊开)。显式写了之后,框选与 Ctrl / 多选点击统一按这一份过滤;普通单选、`selectFeatures` 这些接口入口不受它限制。运行中用 `updateOptions({ selectionKinds })` 切换即可,不需要重排场景。
|
package/docs/manual/09-/351/200/232/351/201/223/344/270/216/345/244/232/345/233/236/347/272/277.md
CHANGED
|
@@ -87,6 +87,63 @@ view.updateOptions({ channelWaypointDragMode: 'vertex' }) // 下一次拖动生
|
|
|
87
87
|
- **不会自动清空**:切回 `'parallel'` 或再次 `updateOptions` 只换后续拖动的行为,已有 `waypointOffsets` 仍按数据继续生效。要把一组恢复成普通平行骨架,可把该组偏移拖回零,或重写分组声明(例如 `updateChannel(channelId, { groups })`,组项不写 `waypointOffsets` / 写空对象)后重新落数据。
|
|
88
88
|
- **读数与导出**:`getChannelGroups()` / `getChannelGroupWaypoints()` / `getChannels()` 都带 `waypointOffsets`;`getParallelGroups()` 与 `exportData({ format: 'test' | 'view', parts: ['waypoint'] })` 的 `group_route` 已经把偏移叠到骨架上,导出的是实际路由,不是旧 `path`。
|
|
89
89
|
|
|
90
|
+
### 通道简略(channelSimplify)
|
|
91
|
+
|
|
92
|
+
回线很多时,可以在不删数据的前提下把每组收成一条代表线:
|
|
93
|
+
|
|
94
|
+
```js
|
|
95
|
+
createGisView(container, {
|
|
96
|
+
channelSimplify: {
|
|
97
|
+
enabled: true,
|
|
98
|
+
threshold: 4,
|
|
99
|
+
style: { color: '#ff6b35', width: 3, dash: [8, 4] }
|
|
100
|
+
}
|
|
101
|
+
})
|
|
102
|
+
|
|
103
|
+
view.updateOptions({ channelSimplify: true }) // 直接开:缺省阈值 4、沿用线路原样式
|
|
104
|
+
view.updateOptions({ channelSimplify: false }) // 关闭:全部回线原样恢复
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
| 写法 | 行为 |
|
|
108
|
+
| --- | --- |
|
|
109
|
+
| `false` / 不写 | 关闭,所有回线照常按车道绘制 |
|
|
110
|
+
| `true` | 使用缺省阈值 `4`,代表线沿用原线路样式 |
|
|
111
|
+
| `{ enabled, threshold, style }` | 对象本身即开启;写 `enabled: false` 才关闭。`threshold` 向下取整、最小 `1`,缺省 `4` |
|
|
112
|
+
|
|
113
|
+
- **按分组判断**:每组按自己的成员数比较,分组回线数**严格大于** `threshold` 才折叠(等于阈值不折)。没有 `groups` 的通道按一整组处理,成员取顶层 `lineIds`;只写 `groups` 的通道也照常逐组判断。
|
|
114
|
+
- **只画一条**:折叠组只保留第一条 `visible !== false` 的成员回线,其它成员不绘制、不参与拾取;这条代表线压在分组骨架中线,不占原车道。代表线仍可从 `getLineStyle()` 读到解析后的样式,折叠成员则返回 `null`。
|
|
115
|
+
- **样式只改展示**:`style` 接受 `GisViewLineStyle`,在代表线的样式链中覆盖颜色、线宽、线型、透明度等展示字段,不会写回线路数据。未配 `style` 时代表线沿用第一条成员自己的样式。
|
|
116
|
+
- **数据一个字节都不动**:`getData()`、`getChannelGroups()` 的 `lineIds` / 行数 / 分组数、`getChannels()` 与 `exportData()` 都仍是原始全部回线;`getChannels()` 还给每条成员回线补齐完整路径与各自车道,不会因为隐藏槽没参与绘制而返回空数组。简略只作用于画布、拾取和 `getLineStyle()`。关闭(或把阈值调大)后按原分组与车道恢复,不需要重新下发数据。
|
|
117
|
+
- **运行时切换**:`updateOptions({ channelSimplify })` 会重新解析通道;只改样式也会按新样式刷新代表线。整份对象与原值等价时不会做无谓重建。
|
|
118
|
+
|
|
119
|
+
`ChannelDemo.vue` 的「通道简略」面板可以现场开关、改阈值与代表线颜色 / 线宽 / 线型,读数同时列出原始回线总数与画布上实际显示条数。
|
|
120
|
+
|
|
121
|
+
### 查询节点之间的直接连接(getDirectConnections)
|
|
122
|
+
|
|
123
|
+
传一组节点 id,只找出**这组节点内部**已经直接连上的通道与线路;不会从一个节点沿线路走到第三个节点,也不会把只连着集合外节点的边带回来:
|
|
124
|
+
|
|
125
|
+
```js
|
|
126
|
+
const direct = view.getDirectConnections(['a', 'b', 'c'])
|
|
127
|
+
|
|
128
|
+
for (const connection of direct) {
|
|
129
|
+
if (connection.type === 'channel') {
|
|
130
|
+
console.log('通道', connection.channelId, connection.from.id, connection.to.id, connection.lineIds)
|
|
131
|
+
}
|
|
132
|
+
else {
|
|
133
|
+
console.log('线路', connection.lineId, connection.from.id, connection.to.id)
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
view.getDirectConnections(['a', 'not-exist']) // []:只有一个真实节点,凑不成一条边
|
|
138
|
+
view.getDirectConnections([]) // []
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
- **两端必须存在且都在集合里**:节点 id 要能查到数据里的 `points`;只给一个有效节点、空数组、重复 id 都不会凭空产生连接。
|
|
142
|
+
- **只认直接绑定**:线路看自己的 `from` / `to`;通道看声明的两端,没声明 `from` / `to` 时按第一条成员回线继承。没有端点绑定的纯 `path` 线路、自环和认不出端点的通道都跳过。
|
|
143
|
+
- **通道与回线可以同时返回**:通道本身是一条连接,通道里的成员回线也是有 `from` / `to` 的直接线路,所以两者可能同时出现在结果里;独立线路同样返回。结果先按 `channels` 数据顺序列通道,再按 `lines` 数据顺序列线路。
|
|
144
|
+
- **只读**:不改选中、筛选、显隐或数据;被 `visible: false` / 筛选隐藏的要素只要数据里的端点成立,仍会被这个拓扑查询找到。找不到任何一条时严格返回 `[]`,不是 `{ channels: [], lines: [] }`。
|
|
145
|
+
- 每条连接都带 `from` / `to`(`{ id, index, item }`)与 `item`;通道项另有 `channelId` / `channelIndex` / `lineIds`,线路项另有 `lineId` / `lineIndex`。单条 id 和 id 数组都收。
|
|
146
|
+
|
|
90
147
|
### 由数组批量生成:createChannels
|
|
91
148
|
|
|
92
149
|
回线数量多的时候不用手写 `lines` 再手动拼 `channels`:给一份「通道声明数组」,`createChannels` 会按 `circuits` 展开回线、生成 id / 名称 / 颜色,并组装出共用同一条骨架的通道对象。回线只声明两端节点;需要中间拐点时写在通道的 `path` 上(`path` **可选**,不写就是两端直连),所以通道内多回线永远是等距平行的阶梯。
|
|
@@ -21,7 +21,10 @@ view.updateOptions({
|
|
|
21
21
|
when: { vn_kv: { gte: 500 } }, // 只给命中的节点显示,条件语言同上
|
|
22
22
|
enabled: true, // 显式 false 整体关掉
|
|
23
23
|
className: 'my-label',
|
|
24
|
-
style: { background: 'rgba(23, 36, 54, 0.86)', color: '#ffffff' }
|
|
24
|
+
style: { background: 'rgba(23, 36, 54, 0.86)', color: '#ffffff' },
|
|
25
|
+
zIndex: 20, // 显式层级优先;不写且 followNodeZIndex 打开时跟随节点
|
|
26
|
+
followNodeZIndex: false, // true = 跟随节点样式链的 zIndex,可被更高层节点盖住
|
|
27
|
+
zoomScale: 0 // 0 固定屏幕字号;1 与地图同倍率,0.5 为平方根
|
|
25
28
|
}
|
|
26
29
|
})
|
|
27
30
|
```
|
|
@@ -40,6 +43,9 @@ view.updateOptions({
|
|
|
40
43
|
| `when` | `GisViewConditionInput` | 无 | 条件语言,只给命中的节点渲染标签 |
|
|
41
44
|
| `maxCount` | `number` | `200` | 最多渲染多少个标签(按当前视口内可见点的顺序取,被避让丢掉的候选不计入),`0` 表示不限制;只在 `labelOptimize: true` 时生效(缺省强制显示档不截断) |
|
|
42
45
|
| `className` / `style` | `string` / `Record<string, string>` | 无 | 附加类名与内联样式:**不用写 HTML 也能改外观** —— `style` 是内联样式的增量合并,`background` / `color` / `fontSize: '14px'` / `fontWeight` / `borderRadius` / `padding` 这些写什么加什么(值按 CSS 写法给字符串),逐条再叠 `updateLabel` 的 `style`;不配就是样式表里的默认(白底 88% / `#1f3550` / 12px),想清掉某一项就写 `{ 那一项: null }` |
|
|
46
|
+
| `zIndex` | `number` | 无 | 标签层级:越大越靠上。显式值优先于 `followNodeZIndex`;同类标签按层级从低到高排,高层的 DOM / Canvas 标签压住低层。参与「更高层节点图标盖住标签」的判定 |
|
|
47
|
+
| `followNodeZIndex` | `boolean` | `false` | 节点标签跟随节点样式链里生效的 `zIndex`(节点自身 > 规则 > `pointStyle`)。跟随后的标签可被更高层节点图标整条让位,也可被更高层标签盖住;显式 `zIndex` 优先。线路标签忽略这一项 |
|
|
48
|
+
| `zoomScale` | `number` | `0` | 字号随地图缩放的指数:`0` 保持屏幕字号不变,`1` 与地图同倍率放大 / 缩小,`0.5` 表示地图放大 4 倍时字号放大 2 倍。基数是该项 `style.fontSize`(缺省 12px);实时交互按 0.1px 量化,停手后按真实排版校正盒子与避让 |
|
|
43
49
|
| `avoidOverlap` | `boolean` | `true` | 标签避让:和已经放下的标签重叠时按 `overlapMode` 处理;只在 `labelOptimize: true` 时生效 |
|
|
44
50
|
| `overlapGap` | `number` | `2` | 避让留白(CSS 像素),两个标签的矩形至少隔开这么多 |
|
|
45
51
|
| `overlapMode` | `'shift' \| 'hide'` | `'shift'` | 撞上别的标签之后怎么办:`shift` 主动换落点(节点换锚点 / 线路沿线挪),仍放不下才不画;`hide` 直接不显示,不做任何位置回退。逐条标签可以各自覆盖;只压到底图区域文字时仍按软冲突照画 |
|
|
@@ -50,6 +56,10 @@ view.updateOptions({
|
|
|
50
56
|
| `draggable` | `boolean` | `false` | 标签能不能拖:打开后标签自己接住指针(`pointer-events: auto`),按住挪到别处记成偏移,移动节点时偏移照旧叠在节点位移上。见「标签的拖动与编辑」 ;两个开关各管各的手势:`draggable: true` / `editable: false` 只拖不选(点一下什么都不发) |
|
|
51
57
|
| `editable` | `boolean` | `false` | 标签能不能点选:打开后点一下发一条 `labelClick`,使用方按它选中这一条、调 `updateLabel` 改内容 / 字号 / 颜色 ;`editable: true` / `draggable: false` 时标签照样接指针,但按下不拦事件(画布照常平移 / 缩放、文字照常能选),松开那一下没挪出 3 px 才补发 `labelClick`;右键与双击两个开关任开一个都算 |
|
|
52
58
|
|
|
59
|
+
**层级与字号联动。** `zIndex` 决定标签之间的先后;节点标签写 `followNodeZIndex: true` 时会取节点样式链定下来的那一层。覆盖层只对「显式分层或跟随节点」的点标签做节点遮挡判定:更高层节点图标压到标签时整条让位,避免 DOM 标签浮在节点图标上面。遮挡索引按 64px 屏幕网格惰性建立,只有确实存在非 0 节点层时才扫描视口,数据量大但没配层级时不会多付这一趟。节点层级或尺寸通过 `updatePoint` / `patchPoints` 改变时,即便被改的节点自己没有标签,其他跟随层级的标签也会重新判定。
|
|
60
|
+
|
|
61
|
+
`zoomScale` 只缩放字号,不改标签的锚点与固定像素间距:`0`(默认)在任何地图比例下都按 `style.fontSize` 显示,`1` 与地图同倍率,其他数字是指数。缩放交互期间先即时改字号,停手后重排一次,把新字号用于碰撞盒与避让;同一次排版里相同相机比例与相同指数只计算一次,连续滚轮不会逐条重复 `Math.pow`。
|
|
62
|
+
|
|
53
63
|
函数形态的 `content` 会收到 `{ index, item, x, y, screen, radius }`(`radius` 是节点画在屏幕上的半径),需要自己拼 DOM 时直接返回元素即可。`anchor: 'edge'` 时标签到节点的距离始终是「符号当前的屏幕半径 + `gap`」:节点被悬停 / 选中样式放大,标签跟着往外让,缩小跟着靠近;缩放地图时标签按新相机重新投影,间距不会跟着地图一起被放大(鹰眼图放大缩小几次之后标签也不会飘出画布)。`html: true` 时字符串按 HTML 渲染:模板串里的取值仍然会转义,自己拼标记时也要记得转义业务字段。标签只渲染当前视口内的节点,相机变化后按 `requestAnimationFrame` 合并重排,移出视口的标签 DOM 回收进池子复用;单个节点可以用 `labelVisible: false`、`labelPosition`、`labelOffset` 覆盖全局配置,也可以用 `labelVisibility: 'always' | 'hidden'` 单独指定显隐策略(`labelVisible: true` 等价于 `always`)。
|
|
54
64
|
|
|
55
65
|
`html` 是**逐条**开关:全局 `label.html: true` 时,某条数据仍可写 `labels: [{ id: 'default', content: '<b>{name}</b>', html: false }]`,这一条就显示字面的 `<b>…</b>`;反过来全局 `false`、单条写 `true` 也会按标记渲染。运行时用 `updateLabel(kind, ref, { html: true | false })` 双向切换,写 `null` 回到全局 / 声明值。只有字符串 `content` 受它控制,函数返回 `HTMLElement` 时始终按元素插入。`getLabels()` 的清单以及 `labelClick` / `labelDrag` 载荷里的 `label` 都会带 `html`;HTML 模式下 `content` 返回 `innerHTML`,编辑面板回写时不会把 `<b>` / `<span>` 洗成纯文本。导出数据会把显式 `true` / `false` 一起写进 `labels`,导出再回灌保持原语义。
|
|
@@ -94,7 +104,9 @@ view.updateOptions({
|
|
|
94
104
|
followOnInteract: true, // 没收起时,拖节点 / 拖拐点期间标签跟着线路走;false 停手后才归位
|
|
95
105
|
draggable: true, // 标签能拖走(偏移记在组件里,再移动节点时叠在节点位移上)
|
|
96
106
|
editable: true, // 点一下发 labelClick,改什么由使用方调 updateLabel 落
|
|
97
|
-
when: { vn_kv: { gte: 500 } } // 只给命中的线路显示
|
|
107
|
+
when: { vn_kv: { gte: 500 } }, // 只给命中的线路显示
|
|
108
|
+
zIndex: 10, // 线路标签之间的层级:越大越靠上
|
|
109
|
+
zoomScale: 0 // 0 固定屏幕字号;1 与地图同倍率
|
|
98
110
|
}
|
|
99
111
|
})
|
|
100
112
|
```
|
|
@@ -107,6 +119,8 @@ view.updateOptions({
|
|
|
107
119
|
|
|
108
120
|
线路标签与节点标签是两组独立配置(`lineLabel` 对 `label`),但排在同一轮、共用一张 64px 避让网格,所以两类标签不会叠在一起。扫描候选前会先按屏幕小格去重:同一小片区域只收一条线 —— 真实数据里一条通道常有成百上千条并行回线,中点几乎重合,不筛的话扫描名额全被一条走廊吃光、避让阶段又集体被丢,**整屏一条线路标签都显示不出来**;筛过之后候选摊到整个视口,`maxCount` 才有意义。`scanLimit` 限制收下的候选数,考察的线路条数另有 `max(scanLimit × 8, 2048)` 的硬上限兜底。
|
|
109
121
|
|
|
122
|
+
线路标签同样支持 `zIndex` 与 `zoomScale`:`zIndex` 越大越靠上,DOM 标签按显式层号排序,同一张 Canvas 上的标签也按层号从小到大绘制;`zoomScale` 与节点标签的公式相同,基数是这一条 `style.fontSize`(缺省 12px),`0` 固定屏幕字号、`1` 与地图同倍率、`0.5` 是平方根。线路标签不认 `followNodeZIndex`,线路本身没有「节点层」可跟;需要跨类别控制先后时,给节点与线路标签分别写显式 `zIndex`。
|
|
123
|
+
|
|
110
124
|
线路标签撞上别人(节点标签 / 别的线路标签)时默认也不直接丢掉:`overlapMode: 'shift'` 会沿线往两侧各试 2 步(`slideFallback`),每一步把这一条自己整个让开(标签宽度 + 两侧留白 + 一点余量),左右交替;找到空位当场落笔,并把位置记进这一条的状态、下一轮排版从那儿接着走,不会来回跳。写 `overlapMode: 'hide'` 则碰撞就直接不显示,不尝试滑动。底图的区域文字只算软冲突:`shift` 时沿线躲得开就躲、躲不开照画,`hide` 时也不为它隐藏。落点只取视口里的:滑出视口的那一条下一轮会被候选筛选当作「不在视口里」丢掉,看起来就是闪一下没了。
|
|
111
125
|
|
|
112
126
|
一条线自己写了 `lineLabel` / `lineLabelPosition` / `lineLabelOffset` 时(`lineLabel: false` 不算),这条线算「有自己的标签」:它不占 `scanLimit` 的扫描名额,也不参与上面那一步的屏幕小格去重,因此通道里的并行回线都能作为候选各显示各的标签——`createChannels` 的 `linePropsByMember` 一次就能给每条回线写一份自己的 `lineLabelPosition`。这类候选排两轮:每个屏幕小格先收一条(先把标签铺开),同格里剩下的排在后面补位,空出来的位置再给它们;否则通道密集时先放下的几条回线就把整片区域占满,勾上「逐条显示」反而比不勾更少。
|
|
@@ -250,7 +264,16 @@ view.resolveLabelTargets('point', 'selection') // 先看这批选中的定位到
|
|
|
250
264
|
|
|
251
265
|
**位置现给就行。** `addLabel('point', 'p-1', { content: '备注', position: 'top-left' })` —— 节点标签认八向(`top` / `bottom` / `left` / `right` 与四个斜角)加 `center`,线路标签认沿线位置(比例 0 ~ 1、百分比、绝对距离);加完再用 `updateLabel({ position })` 改同样可以,`resetLabel` 回到默认锚点。想「一开始就显示几条标签」,把这几条写进 `options.label` / `options.lineLabel` 的数组(同一个要素多条,用 `id` 区分),或者直接写进数据的 `labels`(连位置、样式、偏移一起,见「标签(labels,导入即回显)」)都行 —— 两种写法都跟着数据走,刷新 / 换一份数据之后照旧在。
|
|
252
266
|
|
|
253
|
-
|
|
267
|
+
**层级与字号也能逐条改。** `updateLabel` 的补丁认得 `zIndex` / `followNodeZIndex` / `zoomScale`:写数值当场改这一条的层级或缩放指数,写 `null` 回到配置里的默认(节点标签恢复跟随开关、层号回到样式链或 0)。`getLabels(kind, ref)` 的每一条也会给出当下生效的 `zIndex`、`followNodeZIndex` 与 `zoomScale`,面板不用重新推导样式链:
|
|
268
|
+
|
|
269
|
+
```js
|
|
270
|
+
view.updateLabel('point', 'p-1', { followNodeZIndex: true })
|
|
271
|
+
view.updateLabel('point', 'p-1', { zIndex: 30 }) // 显式层级压过跟随
|
|
272
|
+
view.updateLabel('line', 'l-1', { zIndex: 10, zoomScale: 1 })
|
|
273
|
+
view.updateLabel('point', 'p-1', { zIndex: null }) // 回到跟随节点
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
`style` 是**增量合并**:`{ fontSize: '16px' }` 只改字号,颜色 / 背景那些不受影响;某一项写 `null` 只摘掉这一项覆盖(`updateLabel('point', 'p-1', { style: { fontSize: null } })` 把字号还给配置里的那一份)。`content` / `html` / `position` / `offset` / `style` / `zIndex` / `followNodeZIndex` / `zoomScale` 都认这个约定:不写 = 保持,写 `null` = 回到默认。恢复默认时组件会把当初写上去的内联样式摘干净,不会留下一条「看着像默认、其实是覆盖」的状态。
|
|
254
277
|
|
|
255
278
|
状态按「要素 + `labelId`」记(要素按 id、没写 id 才按下标),换数据之后同 id 的标签仍带着自己那一份;`getLabelStates(kind?)` 传 `'point'` / `'line'` 只取一类。每次改动都会发一条 `labelChange`(`update` / `reset` / `resetAll` / `add` / `remove` / `restore`,载荷里带 `labelId`),面板按它回显;`setLabelStates(saved)` 能把整份状态灌回去,刷新页面 / 换一份数据之后接着用。拖动 / 点选只在标签自己身上发生,画布的框选、平移、`pointer` 那一套事件都不受影响;宿主用 CSS `zoom` 放大过时,指针位移会先除回布局像素,标签跟得住指针。三条批量的(`addLabels` / `updateLabels` / `removeLabels`)各发一条同名 `action`(`addAll` / `updateAll` / `removeAll`),载荷里带 `count` 与逐条明细;「拖得动」与「点得选」是两个开关,`editable: false` 时点一下不发 `labelClick`,`draggable: false` 的标签按下不拦事件(画布照常平移 / 缩放),松开那一下没挪出 3 px 才补发 `labelClick`。
|
|
256
279
|
|
|
@@ -245,7 +245,7 @@ const search = async keyword => {
|
|
|
245
245
|
|
|
246
246
|
## 初始视图
|
|
247
247
|
|
|
248
|
-
不配 `initialView`
|
|
248
|
+
不配 `initialView`(也没配顶层 `center` / `scale`)时,首次拿到数据会 `fitView()`:整个数据范围铺满画布。数据一多,一屏全是点线看不出重点,`initialView` 用一份配置决定首屏落在哪里:
|
|
249
249
|
|
|
250
250
|
```js
|
|
251
251
|
createGisView(container, {
|
|
@@ -254,6 +254,9 @@ createGisView(container, {
|
|
|
254
254
|
// 聚焦数据中心、比「适应视图」再放大 3 倍(最常见的一种)
|
|
255
255
|
initialView: { mode: 'center', zoom: 3 }
|
|
256
256
|
})
|
|
257
|
+
|
|
258
|
+
// 只想直接给中心点和绝对比例:可以写在顶层,不必再包一层 initialView
|
|
259
|
+
createGisView(container, { points, lines, center: [500, 300], scale: 2 })
|
|
257
260
|
```
|
|
258
261
|
|
|
259
262
|
| 字段 | 类型 | 说明 |
|
|
@@ -268,6 +271,7 @@ createGisView(container, {
|
|
|
268
271
|
几个约定:
|
|
269
272
|
|
|
270
273
|
- 只影响**首次落位**。之后拖拽 / 缩放 / `setCamera()` 都不会被它拉回来;`resetView()` 回到的是这次落位之后的相机。
|
|
274
|
+
- 顶层 `center` / `scale` 分别是 `initialView.center` / `initialView.scale` 的简写,创建时直接传即可;只要显式给出非空 `initialView` 对象,就整份以 `initialView` 为准,不再合并这两个简写。运行中 `updateOptions({ center })` / `updateOptions({ scale })` 同样只改下一次落位(首次加载或 `applyInitialView()`),要立刻移动 / 缩放用 `setCenter()` / `setScale()`。
|
|
271
275
|
- 换数据、或者改了 `initialView` 想再套用一遍,调 `applyInitialView()`(demo 切数据集走的就是它)。
|
|
272
276
|
- `fitOnInit: false` 只在**没配** `initialView` 时表示「首屏什么都不做,保持 `setCamera()` 给的位置」;配了 `initialView` 就以它为准。
|
|
273
277
|
- 容器还没尺寸(`display: none` / 0×0)时这次落位会连目标一起挂着:挂的是**请求那一刻**的 `initialView` 与数据包围盒,等容器显示出来再照它兑现 —— 中间新加的远处节点不会把这次落位带跑。
|
|
@@ -307,6 +311,34 @@ view.updateOptions({ minScale: scale / 5, maxScale: scale * 5 })
|
|
|
307
311
|
|
|
308
312
|
demo 的「初始视图与背景」面板里就有现成的入口(`docs/demos/GisViewDemo.vue`):两个输入框(最小比例 / 最大比例)直接写数字,改完走 `updateOptions({ minScale, maxScale })` **并顺手 `setCamera` 把当前相机夹回区间**(更新配置本身不会把相机拉回来,demo 里把这一步显式补上了);`以当前比例设限(÷5 ~ ×5)` 按当下比例算一对;`试一下下限` / `试一下上限` 各喂一个远超区间的比例给 `setCamera()`,读数里能看到相机停在哪;`解除限制` 回到组件缺省的 `0.002 ~ 20000`。自测页 `docs/steps/selftest-demo.html` 有 3 条断言盯着这一套(按当前比例设限并下发 / 越界喂值被夹在上下限 / 解除限制回到缺省)。
|
|
309
313
|
|
|
314
|
+
## 比例读写、画布事件与空闲检测
|
|
315
|
+
|
|
316
|
+
当前缩放比例用 `getScale()` 读,和 `getCamera().scale` 是同一份数(像素 / 世界单位);运行中改比例用 `setScale(scale, origin?)`,锚点缺省是视口中心,传 `[x, y]` 就是画布 CSS 像素里的固定点。`zoomTo()` / `zoomBy()` / `setCamera({ scale })` 也在同一条相机链上,都会受 `minScale` / `maxScale` 夹取并触发 `cameraChange`。
|
|
317
|
+
|
|
318
|
+
```js
|
|
319
|
+
const scale = view.getScale() // 当前比例
|
|
320
|
+
view.setScale(12) // 以视口中心为锚点改比例
|
|
321
|
+
view.setScale(12, [320, 180]) // 指定画布 CSS 像素锚点
|
|
322
|
+
view.on('cameraChange', camera => { // 平移 / 缩放都会发
|
|
323
|
+
console.log(camera.center, camera.scale)
|
|
324
|
+
})
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
画布平移与缩放统一看 `onCameraChange` / `on('cameraChange')`:载荷是当前的 `{ center, scale }`,用户拖拽、滚轮、双击和程序化改相机都走这一条。`viewport` 只表示**画布尺寸 / 宿主显示比例**变化,不是平移缩放事件。
|
|
328
|
+
|
|
329
|
+
用户空闲用 `idleTimeout` 打开:根节点上超过阈值没有指针 / 滚轮 / 键盘活动,就调用一次 `onIdle` 并派发 `idle`。`getIdleTime()` 随时可读当前空闲毫秒数;程序化 API 调用不算用户操作,不会把计时清零。每个空闲段只触发一次,恢复操作后重新计时。实现只保留一个定时器并复用同一份时间戳,长时间静止不会持续建监听或累积计时器;`destroy()` 会清掉它并移除根节点监听。
|
|
330
|
+
|
|
331
|
+
```js
|
|
332
|
+
const view = createGisView(container, {
|
|
333
|
+
points,
|
|
334
|
+
idleTimeout: 60000,
|
|
335
|
+
onIdle: ({ idleTime, timeout }) => console.log(idleTime, timeout)
|
|
336
|
+
})
|
|
337
|
+
view.on('idle', payload => console.log('idle', payload.idleTime))
|
|
338
|
+
view.getIdleTime() // 距创建或上一次用户操作的毫秒数
|
|
339
|
+
view.updateOptions({ idleTimeout: 0 }) // 关闭空闲回调
|
|
340
|
+
```
|
|
341
|
+
|
|
310
342
|
## 适应视图的节点间距(fitSpacing)
|
|
311
343
|
|
|
312
344
|
「两个本来一样的视图,只因为多了一个远处节点,节点就突然很大、很挤」——根因是自动适应读的是**数据包围盒**:远处节点把范围撑大,`fitView()` 只能把 `camera.scale` 压小,节点之间的距离随之变短;节点自己的屏幕尺寸不跟着缩,看起来就像放大了一样。
|
|
@@ -605,6 +637,7 @@ console.log(minimapElement?.parentElement === minimapHost) // true
|
|
|
605
637
|
| `addChannelGroups(channelId, groups, options?)` ↔ 多次 `addChannelGroupLines(channelId, lineData, groupInfo?, options?)` | 前者一次新加多组,只重排一次、只记一步历史;后者一次一组。两边的每组线路数据都写在 `lineData` / `lines`,`lineItems` 已移除 |
|
|
606
638
|
| `project(x, y)` / `unproject(x, y)` ↔ `clientToScreen(clientX, clientY)` / `screenToClient(x, y)` ↔ `clientToWorld(clientX, clientY)` / `worldToClient(x, y)` | 同一套换算链的三档入口:`project` / `unproject` 收**画布 CSS 像素**,`clientTo*` 这一对吃鼠标事件里的 `clientX` / `clientY`(自动减 canvas rect、除宿主缩放)只换到画布像素,再接一层就是世界坐标(`clientToWorld` / `worldToClient`);经纬度那一对是 `lngLatToScreen` / `screenToLngLat` |
|
|
607
639
|
| `fitView(padding?)` / `applyInitialView()` / `resetView()` / `zoomToBounds(bounds, padding?)` | 视角的四个语义:适应**数据范围**(并记下首次落位)/ 按 `options.initialView` 落位(可反复调用)/ 回到**首次落位那一刻**的相机 / 按给定的世界坐标范围适应 |
|
|
640
|
+
| `getCenter()` / `setCenter(center)` ↔ `getCamera().center` / `setCamera({ center })` | 只关心中心时用短入口:`getCenter()` 返回 `[x, y]` 的独立副本;`setCenter([x, y])` 只换中心、保留当前比例并返回实例。要同时改比例、飞行动画或恢复整份相机读数,仍用 `setCamera` / `flyToCamera` |
|
|
608
641
|
| `focusOn(ref, options?)` ↔ `zoomToBounds(bounds, padding?)` | `focusOn` 认要素(id / 下标 / 搜索命中 / 坐标 / 矩形 / 一批),缺省只按范围中心居中;写 `{ zoom: true }` 才走适应那一条,另带 `scale` / `maxZoom` / `select` 这些选项 |
|
|
609
642
|
| `flyTo(target, options?)` ↔ `focusOn(target, options?)` | 同一套目标与选项解析,区别只在落位方式:`focusOn` 立即改相机,`flyTo` 默认用 450 ms 平滑过去,并多认 `duration` / `easing`;需要随时停在当前帧用 `stopCameraAnimation()` |
|
|
610
643
|
| `pick(x, y)` ↔ `pickAt(clientX, clientY)` | 坐标口径不同:`pick` 收画布 CSS 像素,`pickAt` 直接吃鼠标事件里的客户端坐标(结果里另加 `target` 与 `lngLat`) |
|
|
@@ -125,7 +125,7 @@ view.exportData({ format: 'test', parts: ['waypoint'] })
|
|
|
125
125
|
| `scope` | 导哪一块 | 范围相关选项 |
|
|
126
126
|
| --- | --- | --- |
|
|
127
127
|
| `'all'`(缺省) | 全部数据,再按 `points` / `lines` / `channels` 收窄 | —— |
|
|
128
|
-
| `'viewport'` | 当前视口内的节点 / 线路 /
|
|
128
|
+
| `'viewport'` | 当前视口内的节点 / 线路 / 通道(通道按成员回线是否可见整条带上);`selectionKinds` 可改为按类型 / 端点口径筛 | `margin`(屏幕 CSS 像素外扩)、`rect`(直接给世界矩形)、`selectionKinds`;这一档不认 `points` / `lines` / `channels` 三个筛选 |
|
|
129
129
|
| `'selection'` | 当前选中集;`points` 可显式点名,线路取两端都在集合里的那些,通道跟成员线路 | `points` / `lines` / `channels`、`withLines: false` 可不要线路;没有节点时返回 `ok: false` + `reason`,不抛异常 |
|
|
130
130
|
|
|
131
131
|
`exportData` 的 `format: 'full'` 始终返回标准文档本身,不夹带 `scope` / `viewRect` / `counts` 这些读数;`input` 与自定义格式同样保持导出器的原始结果。所有导出都只走这一个入口:范围写 `scope`、分项写 `parts`、口径写 `format`,没有再按业务表拆出第二套实例方法。
|
|
@@ -152,11 +152,14 @@ view.exportData({ format: 'test', parts: ['waypoint'] })
|
|
|
152
152
|
|
|
153
153
|
`margin` 是**屏幕 CSS 像素**的外扩:把贴着视口边的一圈也带上(按当前 scale 换算成世界单位),`rect` 可以直接给一份世界矩形替掉视口(写法同 `getViewRect()`)。`format` / `parts` / `labels` / `box` 都照 `exportData` 写;`points` / `lines` / `channels` 这三个筛选这一档不认(范围由视口定)。`view` / `new` / `test` 业务口径会返回 `scope: 'viewport'` 与 `viewRect`(这次筛用的世界矩形)/ `margin` 三条读数;`format: 'full' | 'input' | 自定义格式` 保持导出器原始结果,不附这些读数。
|
|
154
154
|
|
|
155
|
+
`selectionKinds` 与 `options.selectionKinds` 的写法相同,只对 `scope: 'viewport'` 生效:不写时保持上面那套旧口径;写 `'line'` / `'channel'` 时仍按几何是否沾视口筛选;写 `'lineEndpoints'` / `'channelEndpoints'` 时,只有两端节点都落在视口世界矩形(含 `margin` / `rect`)内的独立线路 / 通道才会导出。端点模式不会顺带导出节点,节点要不要仍看有没有 `'point'`;纯 `path`、缺失端点、自环以及端点被筛掉 / 隐藏的都会跳过。旧模式与端点模式可以并存,结果取并集。
|
|
156
|
+
|
|
155
157
|
演示页「编辑与保存」(`?demo=backend`)把这一步和分组 / 拐点 / 场站改动的接口请求体摆在一起看,见 `docs/demos/BackendSyncDemo.vue`;两种推送策略(点保存一起传 / 改完就传的合并 + 延迟)也在这一页。
|
|
156
158
|
|
|
157
159
|
```js
|
|
158
160
|
const visible = view.exportData({ scope: 'viewport', margin: 24 })
|
|
159
161
|
// 业务口径:{ points, lines, channels, parallelGroups, counts, warnings, scope, viewRect, margin }
|
|
162
|
+
const connected = view.exportData({ scope: 'viewport', selectionKinds: ['lineEndpoints', 'channelEndpoints'] })
|
|
160
163
|
const inner = view.exportData({ scope: 'viewport', format: 'input' }) // 与创建入参同构,保持原始结果形状
|
|
161
164
|
```
|
|
162
165
|
|
|
@@ -198,7 +201,7 @@ next.importData(saved) // 已有实例上整份灌回来(顶
|
|
|
198
201
|
|
|
199
202
|
| 方法 | 出什么 | 选项(除共用项) |
|
|
200
203
|
| --- | --- | --- |
|
|
201
|
-
| `exportData(options?)` | **统一入口**:按 `scope` + `parts` + `format` 给 | `scope: 'all' \| 'viewport' \| 'selection'`(缺省 `all`,也认 `visible` / `view` / `selected`);`parts` 多选分项(见下);`format: 'view' \| 'new' \| 'test' \| 'input' \| 'full'`(缺省 `'view'`;`'input'` / `'full'` 见「五套口径」);`withLines: false`(selection 不要线路);`all`(列出全部分组);`tcFilePath` / `warningMsg`(`'new'` 口径那两列);`box: false` / `showStation: false`(`'new'` 口径不要四至范围 / 母线清单) |
|
|
204
|
+
| `exportData(options?)` | **统一入口**:按 `scope` + `parts` + `format` 给 | `scope: 'all' \| 'viewport' \| 'selection'`(缺省 `all`,也认 `visible` / `view` / `selected`);`parts` 多选分项(见下);`format: 'view' \| 'new' \| 'test' \| 'input' \| 'full'`(缺省 `'view'`;`'input'` / `'full'` 见「五套口径」);`selectionKinds`(仅 `viewport`,支持 `lineEndpoints` / `channelEndpoints`);`withLines: false`(selection 不要线路);`all`(列出全部分组);`tcFilePath` / `warningMsg`(`'new'` 口径那两列);`box: false` / `showStation: false`(`'new'` 口径不要四至范围 / 母线清单) |
|
|
202
205
|
|
|
203
206
|
`points` / `lines` / `channels` 是「只导出这几个」的筛选(`id` / 下标 / `{ id }` / `{ index }`,单个或数组;不写就是全部),`extra` 是额外挂到结果上的字段(`tc_file_path` 这类业务元数据,同名的键以它为准)。
|
|
204
207
|
|
package/docs/manual/16-/345/256/236/344/276/213/346/226/271/346/263/225/346/200/273/350/241/250.md
CHANGED
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
| `importData(input, options?)` | 整份喂回一份数据 / 一份标准文档(`exportData` 的五种格式都认,最标准的是 `format: 'full'` 那一份):顶层出哪一列就应用哪一列(`points` / `lines` / `channels` / `labelStates` / `view` / `filter`),没出的列一个都不动;只给通道(不带点线)时单独换通道声明,只给 `labelStates` 时只动标签状态(整份语义)。返回 `{ ok, reason, applied, counts, warnings }`,见「标准数据文档(full):接收 == 导出」 |
|
|
17
17
|
| `patchPoints(entries, patch?)` / `patchLines(entries, patch?)` | 批量打补丁(只动点到的这几条,不换整份数据):`patchPoints([{ id: 'a', name: 'A' }, { index: 3, x: 10 }])` 一次改几条(`id` / `index` 之外的字段就是这一条的补丁),或者 `patchPoints(['a', 'b'], { status: 1 })` 把同一份补丁盖到一批定位上(`'a'` / `{ index: 2 }` 都认)。认不出来的进 `skipped`、不影响其余条目;返回 `{ ok, reason, indexes, items, count, skipped }`,**只记一条历史、只发一条** `updatePoints` / `updateLines` 数据变更 —— 十万级批量改不必逐条付事件与历史的代价,见「批量更新(batch)」 |
|
|
18
18
|
| `getLabelStates(kind?)` | 标签的运行时状态(拖出来的偏移 + 逐条覆盖,每条带 `labelId`):`kind` 写 `'point'` / `'line'` 只取一类;做持久化 / 回显编辑面板用它,见「标签的拖动与编辑」 |
|
|
19
|
-
| `getLabels(kind, ref?)` | 一条要素上现在有哪些标签(配置里的每一条 + 数据 / 运行时多出来的,各自带内容 / 锚点 / 偏移 / 样式 /
|
|
19
|
+
| `getLabels(kind, ref?)` | 一条要素上现在有哪些标签(配置里的每一条 + 数据 / 运行时多出来的,各自带内容 / 锚点 / 偏移 / 样式 / 可见性、当下生效的 `zIndex` / `followNodeZIndex` / `zoomScale`、来源(`source`:`'config'` 配置里定义的 / `'data'` 数据里写的 / `'runtime'` 运行时加的)与运行时状态);不给 `ref` 时给「有标签的要素」清单;找不到要素返回 `null` |
|
|
20
20
|
| `setLabelContent(content, options?)` | 一键换**全局**标签内容(面板上「显示名称 / 电压等级」这类切换):`content` 与 `label.content` 同一套写法(`'{vn_kv}'` 模板串 / 函数 / `null` 回到默认),只换内容,位置 / 样式 / 显隐保持;`options.kind` 缺省 `'point'`(`'line'` / `'both'` 连线路标签一起),`options.labelId` 缺省 `'default'`(写 `'*'` 换配置里的每一条),见「节点标签」 |
|
|
21
|
-
| `updateLabel(kind, ref, patch)` | 逐条改一个标签:`patch.labelId` 指定改哪一条(缺省 `'default'`),另外认 `content` / `html` / `position` / `style` / `offset` / `visibility` / `parallel` / `hidden`,不写的保持、写 `null` 回到默认,`style` 是增量合并;改完当场重排一次并返回这一条的最新状态读数,找不到要素或这条要素上没有这一条标签时返回 `null` 并记一条 warning |
|
|
21
|
+
| `updateLabel(kind, ref, patch)` | 逐条改一个标签:`patch.labelId` 指定改哪一条(缺省 `'default'`),另外认 `content` / `html` / `position` / `style` / `offset` / `visibility` / `parallel` / `hidden` / `zIndex` / `followNodeZIndex` / `zoomScale`,不写的保持、写 `null` 回到默认,`style` 是增量合并;改完当场重排一次并返回这一条的最新状态读数,找不到要素或这条要素上没有这一条标签时返回 `null` 并记一条 warning |
|
|
22
22
|
| `addLabel(kind, ref, definition?, labelId?)` | 运行时加一条标签(不写进业务数据):`definition` 与配置里的一条同一套写法,`id` 缺省自动取 `note1` / `note2`…;同 id 已存在时按 `updateLabel` 处理 |
|
|
23
23
|
| `removeLabel(kind, ref, labelId?)` | 删一条标签:运行时加的(`addLabel`)删掉那一份;数据 / 配置里还声明着同 id 的标签时再标一条隐藏(它照样会画出来,数据是使用方的,组件只记一条覆盖)。返回 `{ removed, hidden }`,找不到返回 `null` |
|
|
24
24
|
| `addLabels(kind, refs, definition?, options?)` | 批量加同一套标签:`refs` 见「统一加 / 改 / 删一批标签」(单个 / 数组 / `'all'` / `'visible'` / `'selection'` / `{ channel }` / `{ group }`),`definition` 认一条定义、数组或 `(item, index) => 定义`,已有同 id 的缺省跳过、`options.overwrite` 覆盖;返回 `{ kind, requested, added, updated, skipped }` |
|
|
@@ -39,9 +39,11 @@
|
|
|
39
39
|
| `flyTo(target, options?)` | 平滑飞到与 `focusOn` 相同的目标:目标写法与 `zoom` / `scale` / `padding` / `maxZoom` / `select` / `mode` 完全同义,另认 `duration`(毫秒,缺省 450)与 `easing`(`linear` / `ease-in` / `ease-out` / `ease-in-out` 或 `(progress) => progress`)。中心线性插值、比例按对数插值;`duration <= 0` 或系统要求减少动态效果时立即落位。再次飞行、用户拖拽 / 滚轮或任何程序化改相机都会停在当前帧,不补跳到终点 |
|
|
40
40
|
| `search(keyword \| options)` | 按关键字搜索节点 / 线路 / 通道 / 通道分组并返回命中:`scope` 认复数的 `points` / `lines` / `channels` / `groups`,也认与 `focusOn` 一致的单数别名 `point` / `line` / `channel` / `group`;结果分 `points` / `lines` / `channels` / `groups` 四类,分组命中带 `channelIndex` / `groupId` / `groupIndex`,可直接交给 `focusOn` / `selectFeatures`。**不动视角**:要不要聚焦由调用方自己调 `focusOn`,见「搜索与定位」 |
|
|
41
41
|
| `searchAsync(keyword \| options)` | 同一份口径的异步版:数据量大时把扫描放进 Worker(10 万点 / 10 万线下同步要占主线程 40 ms 上下的那一段),返回 `Promise<GisViewSearchResult>`;结果带 `worker` 与 `stale` 两个字段,见「异步搜索」 |
|
|
42
|
-
| `setCamera(camera)` / `getCamera()` |
|
|
42
|
+
| `setCamera(camera)` / `getCamera()` / `getCenter()` / `setCenter(center)` | 读写相机 `{ center, scale }`;`getCenter()` 直接给当前中心 `[x, y]`(独立副本),`setCenter(center)` 只移动中心、保留当前比例并返回实例 |
|
|
43
|
+
| `getScale()` / `setScale(scale, origin?)` | 读写当前比例(像素 / 世界单位):`getScale()` 与 `getCamera().scale` 同一份读数;`setScale()` 立即改比例,`origin` 是画布 CSS 像素锚点(缺省视口中心),返回实例 |
|
|
43
44
|
| `flyToCamera(camera, options?)` | 直接飞到相机目标 `{ center?, scale? }`:不写的那一项沿用当前相机,不经过要素解析、也不改选中与数据;`duration` / `easing` 与 `flyTo` 同义,参数非法时保持当前相机 |
|
|
44
45
|
| `stopCameraAnimation()` / `getCameraAnimation()` | 停止当前相机飞行(停在当前帧,返回实例)/ 读当前飞行 `{ active, progress, duration, from, to }`(没有动画时 `null`) |
|
|
46
|
+
| `getIdleTime()` | 距创建或上一次指针 / 滚轮 / 键盘操作的毫秒数;程序化 API 调用不重置。配合 `idleTimeout` / `onIdle` / `idle` 做「多久没人动」的读数 |
|
|
45
47
|
| `getZoomBaseScale()` / `setZoomBaseScale(scale?)` | 读 / 重定**缩放联动的基准比例**(缺省是首次适应视图时的比例):不传参数就取当下相机的比例 —— 把现在这一屏当成「原样大小」,之后放大缩小都从它算倍数;配合 `pointZoomScale` / `lineZoomScale` 使用 |
|
|
46
48
|
| `getBounds()` | 数据范围(没有点时回退到背景 GeoJSON 的 `rawBounds`,也就是 `aspectScale` 之前的真实经纬度范围);每次返回独立副本,重复调用命中缓存 |
|
|
47
49
|
| `getViewRect()` | 当前可视范围的世界坐标矩形;自建缩略图 / 坐标读数用它换算视口框,内置鹰眼图见「鹰眼图」 |
|
|
@@ -84,7 +86,7 @@
|
|
|
84
86
|
| `isSelected(ref)` | 这个要素在不在当前选中集里:`isSelected('node-0')`(id)/ `isSelected({ type: 'line', index: 12 })`(也可以只写下标,按 id 认不出来时当下标),返回 `true` / `false`。面板上高亮「当前这一行」时不必自己比对 `getSelections()`;选中集变化时缓存一份键集合(见「接口选中」),十万级选中下这一问也是常数级 |
|
|
85
87
|
| `getSelectionData()` | 选中集一次取全:读数(`ids` / `count` / `pointCount` / `lineCount` / `channelCount`)加要素本身(`points` / `lines` / `channels`(按通道去重,与 `getData()` 同一批对象)),另有 `items`(与 `getSelections()` 同一份,通道回线不带通道字段)、`pointIndexes` / `lineIndexes` 与 `bounds`(世界包围盒,空选中时 `null`),见「接口选中(selectFeatures)与读回选中」 |
|
|
86
88
|
| `getCascadeHighlight()` | 当前点击级联高亮的读数:`{ origin, scope, points, lines, pointIndexes, lineIndexes }`;没有高亮或 `cascadeHighlight` 关着时返回 `null`。它只读、不改选中集,见「点击级联高亮」 |
|
|
87
|
-
| `selectInBox(box, options?)` | 按画布 CSS 像素矩形框选,等价于 Shift + 拖动(跟随 `shortcuts.boxSelect`);`options.selectionKinds` 可只覆盖这一次的节点 / 线路 /
|
|
89
|
+
| `selectInBox(box, options?)` | 按画布 CSS 像素矩形框选,等价于 Shift + 拖动(跟随 `shortcuts.boxSelect`);`options.selectionKinds` 可只覆盖这一次的节点 / 线路 / 通道类型过滤,也支持 `'lineEndpoints'` / `'channelEndpoints'` 要求两端节点都在框内。每次框选操作都发 `onSelect`(空框的载荷为 `null`),选中集实际变化时再发 `onSelectChange`,顺序 `onSelect → onSelectChange`(`cause: 'boxSelect'`);通道回线的分组字段与鼠标框选同一份 |
|
|
88
90
|
| `beginCopyPoint(options?)` | 开始复制一个节点:给 `id` / `index` 直接出预览(`commit: true` 出预览即落地,`follow: true` 跟随鼠标,`autoCommit: false` 停在预览态),不给来源就是「先点按钮再选节点」模式,见「节点复制」 |
|
|
89
91
|
| `commitPointCopy()` / `cancelPointCopy()` | 落地 / 取消预览中的复制(返回 `end` / `cancel` 载荷) |
|
|
90
92
|
| `updateCopyPoint(patch)` | 改预览节点的数据(等价于回调里的 `payload.update`),返回改完的节点 |
|
|
@@ -92,9 +94,9 @@
|
|
|
92
94
|
| `copyPoint(source?)` | 复制一个节点到它旁边(一步到位):来源给 id / 下标 / 一份节点数据,不给就用选中的节点(再没有用光标下的);返回新节点 `{ index, item }` |
|
|
93
95
|
| `copyPoints(sources?, options?)` / `copySelectedPoints(options?)` | **批量复制**(不经过剪贴板):不给 `sources` 时复制当前选中集(框选之后一次复制整组);默认只带选中要素 —— 选中线路复制线路、选中通道复制整条通道及回线,并自动补所需端点(`supportSources` / `supportItems` / `supportIndexes`)。显式 `sources` 时只复制这批节点;`lineIndexes` / `channelIndexes` 可再点名,`withLines: true` / `withChannels: true` 才恢复「来源内部全带」的旧口径(写 `false` 则连选中线路 / 通道也不带)。落点按 `coordinate` / `screen` 或 `copy.offset`,`select: true` 复制后选中新节点。返回 `phase: 'batch'` 载荷(`sources` / `items` / `indexes` / `selectedPointCount` / `lines` / `channels` / `count` / `revert()`),复制不了时 `ok: false` + `reason` |
|
|
94
96
|
| `copyPointToClipboard(sources?, options?)` / `copyPointsToClipboard(sources?, options?)` / `pastePoint(options?)` / `pastePoints(options?)` / `getPointClipboard()` | 剪贴板:`copyPointToClipboard` 默认收当前选中的全部节点(只有没选中才回落到光标下的那个),`copyPointsToClipboard` 只认给定 / 选中的一批;Ctrl+V 时单节点且没有内部线路 / 通道仍走原预览,多节点或带线路 / 通道走整组落地,`pastePoints` 强制整组(单节点也走批量载荷)。`getPointClipboard()` 读 `count` / `sources` / `items` / `lines` / `channels` / `anchor` 快照,见「节点复制」 |
|
|
95
|
-
| `mergePoints(source, target, options?)` | 把来源节点并进目标节点(接口调用,不做确认):来源 / 目标收 id、下标或 `{ id }` / `{ index }`,节点数据按 `merge.createItem`
|
|
97
|
+
| `mergePoints(source, target, options?)` | 把来源节点并进目标节点(接口调用,不做确认):来源 / 目标收 id、下标或 `{ id }` / `{ index }`,节点数据按 `merge.createItem` 合并(缺省以保留节点为底,名称 / 图标等业务字段取保留端,`merge.maxKeys` 列出的数值字段取双方最高、缺省不取,尺寸取双方最大、图标类型用保留端),线路 `from` / `to` 与通道 `from` / `to` 改到保留节点,删自环 / 零长线 / 自环通道、把撞成同一条的通道合成一条。保留节点写完整 `mergeInfo` 快照,受影响通道写轻量 `mergeInfo`;返回 `{ ok, item, linesChanged, removedLines, removedChannels, mergedChannels }`,并不了返回 `ok: false` 并另发一条失败事件,见「节点合并」 |
|
|
96
98
|
| `mergeSelectedPoints(options?)` | 框选 / 多选之后一步把选中的节点并到一个目标上(接口调用):`target` 不指定就自动挑**绑定线路最多**的那一个(一样多取画得大的、再取下标小的),来源默认是除目标之外的选中节点、也可以用 `sources`(id / 下标 / `{ id }` / `{ index }`,单个或数组)直接给 —— 这时不用先选中;`mergeable: false` 默认跳过(`force: true` 越过)、`label` 改这一步历史的标签。**多个来源合成一步历史**(数据变更收成一条 `batch`),返回 `{ phase: 'mergeSelected', ok, reason, target, merged, skipped, sourcesMerged, linesChanged, removedLines, removedChannels, mergedChannels, channelsChanged }`,见「节点合并」 |
|
|
97
|
-
| `splitPoint(source, parts
|
|
99
|
+
| `splitPoint(source, parts?, options?)` | `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` 说明 |
|
|
98
100
|
| `getPointMerge()` / `resolvePointMerge(confirmed?, options?)` / `commitPointMerge()` / `revertPointMerge(options?)` | 读 / 裁决 / 收尾当前待确认的合并(把一个节点拖到另一个节点上之后):`resolvePointMerge(true, { keep, item })` 推进到 `confirm` 阶段 —— `keep` 选保留碰撞目标(缺省)还是拖动的来源,`item` 改写最终节点的信息与样式,位置 / id 始终取保留端;`resolvePointMerge(false)` 让拖动的节点回原位。`pending` / `confirm` / `getPointMerge()` 的载荷带 `impact`(受影响线路条数、具体 lineIds 与通道读数;`lineCount` 按线路去重,`linesChanged` / `removedLines` 与落地结果同口径)。自己接管数据落地时用 `commitPointMerge()` 收状态、`revertPointMerge()` 还原(`silent: true` 不补发 cancel 载荷) |
|
|
99
101
|
| `removePoints(refs, options?)` | 移除节点(接口调用):`'a'` / `{ index: 2 }` / 数组都收,绑在它上面的线路一并删掉、声明了它当端点的整条通道(含成员回线)跟着删,返回 `{ ok, indexes, items, removedLines, removedChannels }` |
|
|
100
102
|
| `requestRemove(options?)` | 发起一次删除(Delete 键同一条路):把选中的拐点 / 线路 / 节点与它们的连带影响摊成一份载荷交给 `onRemove` / `'remove'`,停在 `pending` 等裁决(确认方式见 `remove.confirm`),没有可删的东西时返回 `{ phase: 'empty', ok: false, reason }`,见「删除(remove)」 |
|
|
@@ -105,8 +107,8 @@
|
|
|
105
107
|
|
|
106
108
|
| `exportImage(options?)` | 导出当前画面(含标签)为图片,返回 data URL;`scope: 'viewport'`(缺省)导当前视口、`'all'` 临时适应全部可见内容,另有 `padding` / `type` / `quality` / `scale` / `background` / `includeLabels` / `download`,见「导出图片」 |
|
|
107
109
|
| `exportSelection(options?)` | 把选中的节点(可选带上两端都在集合里的线路)单独导成图片 / 数据:`points` 不给就用选中集,`withLines` / `format` / `padding` 见「导出选中的节点」;返回 `{ ok, reason, points, lines, counts, box, pointIndexes, lineIndexes, image }`,出图时临时藏起别的要素与相机、出完还原 |
|
|
108
|
-
| `exportData(options?)` | **统一导出入口**:`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`
|
|
109
|
-
| `snapshotScene(options?)` | 当前画面的矢量快照(屏幕坐标的线 / 点 / 标签 / 背景 / 网格):`{ width, height, background, backgroundImage, grid, regions, lines, points, backgroundPoints, decorations, waypoints, raised, labels }
|
|
110
|
+
| `exportData(options?)` | **统一导出入口**:`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` 写错(或没注册)抛异常,见「导出数据」与「自定义导出格式」 |
|
|
111
|
+
| `snapshotScene(options?)` | 当前画面的矢量快照(屏幕坐标的线 / 点 / 标签 / 背景 / 网格):`{ width, height, background, backgroundImage, grid, regions, lines, raisedLines, points, backgroundPoints, decorations, waypoints, raised, labels }`;`raisedLines` 是抬层的选中线路 / 通道,导出时排在普通节点之后、`raised` 端点节点之前。`options.background: false` 丢背景、`options.backgroundColor` 只换底色、`options.labels` 原样带进去,见「导出图片」 |
|
|
110
112
|
| `addGraphic(graphic)` / `addGraphics(list)` | 新增扩展图形(SVG 路径 / 图片 / Canvas):世界坐标锚点、屏幕像素尺寸、可选 `scaleWithView`;`id` 已存在时按更新覆盖,返回归一化后的图形读数(批量返回数组)。只动图形层 DOM,不重排场景,见「扩展图形(graphic)」 |
|
|
111
113
|
| `updateGraphic(id, patch)` | 改一个扩展图形的字段(写法与创建一致,`style.width` / `style.height` 也认),返回改后的读数;id 不存在返回 `null` |
|
|
112
114
|
| `removeGraphic(id)` / `clearGraphics()` | 按 id 删一条 / 清空整层,分别返回删掉的读数与清掉的条数;节点 / 线路 / 标签 / 数据 / 历史都不受影响 |
|
|
@@ -140,6 +142,7 @@
|
|
|
140
142
|
| `commitAddChannel(input?, options?)` | 把已 `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 通道编辑与新增」。 |
|
|
141
143
|
| `getChannelAddOptions(from, to, count?, kind?)` | 两个节点之间的新增方案:新通道 / 新分组 / 并进某一组 / 无法添加;`count` 是这一次要加的回数(余量按它判),`kind: 'line'` 时方案表为空(独立线路不挑方案) |
|
|
142
144
|
| `getChannelBetween(from, to)` | 两个节点之间的通道读数(只读):有通道时 `hasChannel: true`,`channelId` / `channelIndex` / `groupCount` / `currentGroupId` 与 `groups` / `group` / `channel`(id / name / lineIds / 分组明细)都给全;没有通道时 `hasChannel: false`、`channel: null`、`groups: []`,端点认不出来返回 `null` |
|
|
145
|
+
| `getDirectConnections(pointIds)` | 一组节点之间的**直接**通道 / 线路(只读):两端都必须真实存在且都在传入的 id 集合里,只认通道端点或线路 `from` / `to`,不穿中间节点;通道先按 `channels` 顺序、线路再按 `lines` 顺序,通道与成员回线可同时命中。每项带 `type` / `from` / `to` / `item`,通道项另有 `channelId` / `channelIndex` / `lineIds`,线路项另有 `lineId` / `lineIndex`;没有结果返回 `[]` |
|
|
143
146
|
| `addChannel(spec, lineData?, group?, options?)` | 程序化**只新建**通道:第一段 `{ from, to, name?, id?, channelProps?, path?, routing?, lineData?, group? }`,第二段线路数据按每项 id 建 `lineIds`,第三段可选分组信息(`{ id?, lineIds?, path? }`)。两端已有通道时整条失败(`reason` 指路 `addChannelGroupLines` / `joinChannelGroupLines`)。`options?: { emit?, select? }`,缺省不选中新回线。 |
|
|
144
147
|
| `addChannelGroupLines(channelId, lineData?, groupInfo?, options?)` | 给已有通道**新加一组**回线:第二段按每项 id 建回线,`groupInfo`(`{ id?, groupId?, path?, ... }`)给新分组的 id 与中间拐点,缺省 `${通道 id}::N`、不带拐点;`options?: { emit?, select? }`,缺省不选中 |
|
|
145
148
|
| `addChannelGroups(channelId, groups, options?)` | 给已有通道**一次新加多组**回线:`groups` 每项 `{ id?, groupId?, path?, lineData? \| lines?, ... }`;旧 `lineItems` 会让整批明确失败且不写数据。逐组落地但只记一步历史、只发一条 `addChannelGroups` 数据变更;`options?: { emit?, label?, select? }` |
|
|
@@ -189,7 +192,7 @@
|
|
|
189
192
|
| `canUndo()` / `canRedo()` | 能不能撤销 / 重做(界面据此灰掉按钮) |
|
|
190
193
|
| `getHistoryState()` / `getHistory()` | 历史读数 `{ enabled, limit, canUndo, canRedo, undoCount, redoCount }` / 已经记下的操作(从旧到新,`{ type, label, time }`) |
|
|
191
194
|
| `clearHistory()` | 清空历史(撤销与重做两份栈一起),返回清掉的条数 |
|
|
192
|
-
| `batch(fn, options?)` |
|
|
195
|
+
| `batch(fn, options?)` | 批量增删改:回调里的连续改动(`patchPoints` / `patchLines` / `updateChannel`、`removePoints` / `removeLines` / `removeChannel`、分组拆分 / 删除 / 新增等)收成一条 `onDataChange`(`type: 'batch'`,`changes` 按调用顺序列出每一步)与一步历史,`options.label` 给这一步起名;收尾时筛选只重算一次、标签重排 / 提示框 / 鹰眼图各补一次(`onFilter` 也只发一条),可以嵌套(只有最外层收尾),见「批量更新」 |
|
|
193
196
|
| `getQuality()` / `setQuality(next)` | 读当前画质读数 `{ mode, name, level, glow, ornament, scale, budgetMs, frameMs }` / 换一档(`'high'` / `'balanced'` / `'lean'` / `'fast'` / `'auto'` 或 `{ mode, budgetMs, minScale }`),换完发一条 `onQualityChange`,见「画质」 |
|
|
194
197
|
| `updateOptions({ effects })` / `getEffects()` | 换 / 读动画效果的全局配置(`effects: false` 就是一处关掉):`getEffects()` 给 `{ enabled, respectReducedMotion, line, point }`,其中 `enabled` 是**运行时口径**(只在数据里逐条配了 `effect` 时也是 `true`),见「动画效果(effects)」 |
|
|
195
198
|
| `getLineEffects()` | 这一帧动点的读数 `{ lineIndex, slot, x, y, angle, total, size }`(世界坐标 + 朝向 + 所在线路 + 沿线总长):自建覆盖层(跟着图标走的标签 / 提示)与读数面板用它,没动的时候是空表 |
|
|
@@ -203,7 +206,7 @@
|
|
|
203
206
|
|
|
204
207
|
返回 `this` 的方法都可以链式调用;返回其它值的方法(`get*` / `list*` / `export*` / `search` / `pick*` / `add*` / `remove*` / `copy*` / `merge*` / `locate*` 这些)在下面的「参数速查」里都标了返回类型。
|
|
205
208
|
|
|
206
|
-
**怎么确认「组件到底有哪些属性和方法」**:上面那张表按功能分组介绍,下面的「参数速查」把实例的**每个成员逐个列全**(当前
|
|
209
|
+
**怎么确认「组件到底有哪些属性和方法」**:上面那张表按功能分组介绍,下面的「参数速查」把实例的**每个成员逐个列全**(当前 273 个:268 个方法 + `el` / `canvas` / `gl` / `cameraAnimating` / `dataVersion` 五个属性),`options` 表列全 100 个键,数据字段表列全 266 个字段。这三份清单不靠手抄 —— 它们直接对着源码与类型对账:
|
|
207
210
|
|
|
208
211
|
- `node docs/steps/gen-api-index.mjs`:从 `create.js` 的实例定义、本文档的两张表与 `types.d.ts` 生成 `docs/demos/api-index.js`(`API_SUMMARY` / `API_SECTIONS` / `API_OPTIONS`),demo 的「实例 API」面板读的就是它;带 `--check` 时只校验有没有过期。
|
|
209
212
|
- `node docs/steps/check-doc-coverage.mjs`:10 项双向对账 —— 实例成员 × 文档 / × 参数速查 / × 类型、参数速查与实例方法主表各自反查过期条目、类型反查过期声明、数据字段 × 文档、options 键 × 文档 / options 表反查过期字段、demo 清单是否最新。加一个实例成员、改一个 options 键而没同步文档时,这个脚本会直接报出来。
|