Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow calculate distance by bbox when snap to node #4126

Merged
merged 2 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/x6/src/graph/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export namespace Options {
/**
* Snap edge to the closest node/port in the given radius on dragging.
*/
snap: boolean | { radius: number }
snap: boolean | { radius: number; snapNode: 'center' | 'bbox' }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

很棒的配置!👍 有一个小的建议,将 snapNode 名称修改为 anchor 会更好。


/**
* Specify whether connect to point on the graph is allowed.
Expand Down
6 changes: 5 additions & 1 deletion packages/x6/src/view/edge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1968,6 +1968,7 @@ export class EdgeView<
const graph = this.graph
const { snap, allowEdge } = graph.options.connecting
const radius = (typeof snap === 'object' && snap.radius) || 50
const snapNode = (typeof snap === 'object' && snap.snapNode) || 'center'

const views = graph.renderer.findViewsInArea(
{
Expand Down Expand Up @@ -2001,7 +2002,10 @@ export class EdgeView<
views.forEach((view) => {
if (view.container.getAttribute('magnet') !== 'false') {
if (view.isNodeView()) {
distance = view.cell.getBBox().getCenter().distance(pos)
distance =
snapNode === 'center'
? view.cell.getBBox().getCenter().distance(pos)
: view.cell.getBBox().getNearestPointToPoint(pos).distance(pos)
} else if (view.isEdgeView()) {
const point = view.getClosestPoint(pos)
if (point) {
Expand Down
4 changes: 3 additions & 1 deletion sites/x6-sites/docs/api/model/interaction.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const graph = new Graph({
### snap

```typescript
snap: boolean | { radius: number }
snap: boolean | { radius: number, snapNode: 'center' | 'bbox' }
```

当 `snap` 设置为 `true` 或者 `false` 代表开启和关闭连线过程中自动吸附,开启时距离目标 `50px` 是触发吸附。可以通过配置 `radius` 属性来自定义吸附半径。
Expand All @@ -48,6 +48,8 @@ const graph = new Graph({
})
```

当开启了 `allowNode` 时,判断是否吸附到节点计算distance时默认为基于节点的中心,可以通过配置 `snapNode` 为 `bbox` 改为基于节点的包围盒子计算距离。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

另外,这个文档文本可以优化一下。当开启了 allowNode 时,这个前提可以去掉。


### allowBlank

```typescript
Expand Down
Loading