# 节点 Node

LogicFlow 的内置了一些基础节点,开发者在实际应用场景中,可以基于这些基础节点,定义符合自己业务逻辑的节点。

# 认识LogicFlow的基础节点

LogicFlow是基于svg做的流程图编辑框架,所以我们的节点和连线都是svg基本形状,对LogicFlow节点样式的修改,也就是对svg基本形状的修改。LogicFlow内部存在7种基础节点,分别为:

下面我们看看把基础节点渲染到画布效果

# 基于继承的自定义节点

LogicFlow的基础节点是比较简单的,但是在业务中对节点外观要求可能有各种情况。LogicFlow提供了非常强大的自定义节点功能,可以支持开发者自定义各种节点。

注意

LogicFlow推荐在实际应用场景中,所有的节点都使用自定义节点,将节点的type定义为符合项目业务意义的名称。而不是使用圆形、矩形这种仅表示外观的节点。

LogicFlow是基于继承来实现自定义节点、边。开发者可以继承LogicFlow内置的节点,然后利用面向对象的重写 (opens new window)机制。重写节点样式相关的方法,来达到自定义节点样式的效果。

logicflow-1.0-2.png

此图也是用LogicFlow画出来的。见作图工具

# 选择自定义节点继承的基础节点

LogicFlow内部存在7种基础节点, 自定义节点的时候可以基于需要选择任一一种来继承, 然后取一个符合自己业务意义的名字。

// 矩形
import { RectNode, RectNodeModel } from "@logicflow/core";
// 圆形
import { CircleNode, CircleNodeModel } from "@logicflow/core";
// 椭圆
import { EllipseNode, EllipseNodeModel } from "@logicflow/core";
// 多边形
import { PolygonNode, PolygonNodeModel } from "@logicflow/core";
// 菱形
import { DiamondNode, DiamondNodeModel } from "@logicflow/core";
// 文本
import { TextNode, TextNodeModel } from "@logicflow/core";
// HTML
import { HtmlNode, HtmlNodeModel } from "@logicflow/core";

# 二次自定义

由于基于继承的自定义机制,LogicFlow还支持基于自定义节点的基础上,进行二次自定义。以@logicflow/extension中提供的可缩放节点为例。

LogicFlow基础节点不支持节点缩放,于是LogicFlow在extension包中,基于基础节点,封装了对节点缩放的逻辑,然后发布出去。这样开发者可以直接基于extension中的可缩放节点进行自定义。

import { RectResize } from '@logicflow/extension'
class CustomNodeModel extends RectResize.model {}
class CustomNode extends RectResize.view {}

# 自定义一个业务节点

我们以定义一个如下图所示的用户任务节点为例,来实现一个基于内置矩形节点的自定义节点。

# 步骤1: 定义节点并注册

// UserTaskNode.js
import { RectNode, RectNodeModel } from "@logicflow/core";

class UserTaskModel extends RectNodeModel {}

class UserTaskView extends RectNode {}

export default {
  type: "UserTask",
  view: UserTaskView,
  model: UserTaskModel
};

// main.js
import UserTask from './UserTaskNode.js'

const lf = new LogicFlow({
  container: document.querySelector('#container')
});
lf.register(UserTask);

lf.render({
  nodes: [
    {
      type: 'UserTask',
      x: 100,
      y: 100
    }
  ]
})

# modelview

从上面的代码,可以看到,在自定义一个节点的时候,我们需要定义节点的modelview。这是因为由于LogicFlow基于MVVM模式,所有自定义节点和连线的时候,我们需要自定义viewmodel。大多数情况下,需要通过重写定义model上获取样式相关的方法和重写view上的getShape来定义更复杂的节点外观。

TIP

LogicFlow为了开发的时候将开发体验和现在前端流行的开发体验对齐,也为了在代码层面更好的理解,让更多的人可以参与进来,我们基于preact、mobx以MVVM模式进行开发。如果大家熟悉react开发的话,可以直接阅读我们的源码,你们可以发现整个项目阅读起来难度和你自己开发的项目差不多。我们欢迎大家一起参与进来。

# 步骤2: 自定义节点model

LogicFlow把自定义节点外观分为了自定义节点样式属性自定义节点形状属性两种方式。更多详细定义方法,请查看NodeModelApi

# 自定义节点的样式属性

在LogicFlow中,外观属性表示控制着节点边框颜色这类偏外观的属性。这些属性是可以直接通过主题配置来控制。自定义节点样式可以看做在主题的基础上基于当前节点的类型进行再次定义。例如在主题中对所有rect节点都定义其边框颜色为红色stroke: red。 那么可以在自定义节点UserTask的时候,重新定义UserTask边框为蓝色stroke: blue

更细粒度的节点样式控制方法,详情见API 样式属性

class UserTaskModel extends RectNodeModel {
  getNodeStyle() {
    const style = super.getNodeStyle();
    style.stroke = 'blue';
    style.strokeDasharray = '3 3';
    return style;
  }
}

# 自定义节点的形状属性

在LogicFlow中,形状属性表示节点的宽width、高height,矩形的圆角radius, 圆形的半径r, 多边形的顶点points等这些控制着节点最终形状的属性。因为LogicFlow在计算节点的锚点、连线的起点终点的时候,会基于形状属性进行计算。对于形状属性的自定义,需要在setAttributes方法或initNodeData方法中进行。

LogicFlow对于不同的基础节点,存在一些各基础节点自己特有的形状属性。详情见API 形状属性

class customRectModel extends RectNodeModel {
  initNodeData(data) {
    super.initNodeData(data);
    this.width = 200;
    this.height = 80;
    this.radius = 50;
  }
}

注意

如果不在model中设置形状属性,而是直接在view中直接定义生成图形的宽高这种形状属性,会出现锚点位置、outline大小不正确的情况。同时,连线的位置也可能会出现错乱。

# 基于properties属性自定义节点样式

在实际业务中,存在这样的情况,例如在审批场景中,自定义的审批节点存在3种状态:

一种是流程还没有走到这个节点的默认状态,一种是流程审批通过状态,一种是审批不通过的驳回状态。在外观上我们需要对不同的状态显示不同的颜色。LogicFlow的图数据中提到,不论是节点还是边,LogicFlow都保留了properties字段,用于给开发者存放自己的业务属性。示例如下,propertiesstatu属性就是一个自定义的业务属性,开发者在自定义节点样式的时候,可以基于properties中的属性来控制节点显示不同的样式。

class UserTaskModel extends RectNodeModel {
  initNodeData(data) {
    super.initNodeData(data);
    this.width = 80;
    this.height = 60;
    this.radius = 5;
  }
  getNodeStyle() {
    const style = super.getNodeStyle();
    const properties = this.properties;
    if (properties.statu === 'pass') {
      style.stroke = "green";
    } else if (properties.statu === 'reject') {
      style.stroke = "red";
    } else {
      style.stroke = "rgb(24, 125, 255)";
    }
    return style;
  }
}

提示

如果不了解为什么this.properties打印出来是一个Proxy对象, 无法看到属性。请查看issue https://github.com/didi/LogicFlow/issues/530 (opens new window)

# 步骤3: 自定义节点view

LogicFlow在自定义节点的model时,可以定义节点的基础形状、样式等属性。但是当开发者需要一个更加复杂的节点时,可以使用LogicFlow提供的自定义节点view的方式。

class UserTaskView extends RectNode {
  private getLabelShape() {
    const { model } = this.props;
    const { x, y, width, height } = model;
    const style = model.getNodeStyle();
    return h(
      "svg",
      {
        x: x - width / 2 + 5,
        y: y - height / 2 + 5,
        width: 25,
        height: 25,
        viewBox: "0 0 1274 1024"
      },
      h("path", {
        fill: style.stroke,
        d:
          "M655.807326 287.35973m-223.989415 0a218.879 218.879 0 1 0 447.978829 0 218.879 218.879 0 1 0-447.978829 0ZM1039.955839 895.482975c-0.490184-212.177424-172.287821-384.030443-384.148513-384.030443-211.862739 0-383.660376 171.85302-384.15056 384.030443L1039.955839 895.482975z"
      })
    );
  }
  /**
   * 完全自定义节点外观方法
   */
  getShape() {
    const { model, graphModel } = this.props;
    const { x, y, width, height, radius } = model;
    const style = model.getNodeStyle();
    return h("g", {}, [
      h("rect", {
        ...style,
        x: x - width / 2,
        y: y - height / 2,
        rx: radius,
        ry: radius,
        width,
        height
      }),
      this.getLabelShape()
    ]);
  }
}

# h函数

h方法是LogicFlow对外暴露的渲染函数,其用法与reactvuecreateElement (opens new window)一致。但是这里我们需要创建的是svg标签,所以需要有一定的svg基础知识。但是大多数情况下,我们不会涉及太复杂的知识,只是简单的矩形、圆形、多边形这种。

h(nodeName, attributes, [...children])

// <text x="100" y="100">文本内容</text>
h('text', { x: 100, y: 100 }, ['文本内容'])

/**
 * <g>
 *   <rect x="100" y="100" stroke="#000000" strokeDasharray="3 3"></rect>
 *   <text x="100" y="100">文本内容</text>
 * </g>
 */ 

h('g',{}, [
  h('rect', { x: 100, y: 100, stroke: "#000000", strokeDasharray="3 3"}),
  h('text', { x: 100, y: 100 }, ['文本内容'])
])

# getShape

此方法作用就是定义最终渲染的图形, LogicFlow内部会将其返回的内容插入到svg DOM上。开发者不是一定需要重写此方法,只有在期望改变最终渲染图形svg DOM的时候才使用此方法。以上面是例子来说,rect节点最终渲染的svg DOM只是一个矩形。但是当我们想要在上面加一个图标的时候,那边必定需要修改到最终渲染图形的svg DOM了,这个时候就需要通过重写getShape来实现了。

LogicFlow定义一个节点的外观有三种方式,分别为主题自定义节点model自定义节点view。这三种方式优先级为主题 < 自定义节点model < 自定义节点view。他们的差异是:

  • 主题:定义所有此基础类型节点的通用样式,例如定义所有rect节点的边框颜色、宽度等。
  • 自定义节点model:定义此注册类型节点的样式。
  • 自定义节点view: 定义此注册类型节点svg dom。

注意

虽然自定义节点view优先级最高,功能也最完善,理论上我们可以完全通过自定义节点view实现任何我们想要的效果,但是此方式还是存在一些限制。

  1. 自定义节点view最终生成的图形的形状属性必须和model中形状属性的一致,因为节点的锚点、外边框都是基于节点model中的widthheight生成。
  2. 自定义节点view最终生成的图形整体轮廓必须和继承的基础图形一致,不能继承的rect而在getShape的时候返回的最终图形轮廓变成了圆形。因为LogicFlow对于节点上的连线调整、锚点生成等会基于基础图形进行计算。

# 为什么rectx,y不是直接从model中获取的x, y?

在LogicFlow所有的基础节点中,model里面的x,y都是统一表示中心点。但是getShape方法给我们提供直接生成svg dom的方式,在svg中, 对图形位置的控制则存在差异:

  • rect: 通过x, y表示图形的位置,但是表示是图形左上角坐标。 所以一般通过中心点,然后减去节点的宽高的一半计算出左上角坐标。
const { x, y, width, height, radius } = this.props.model;
// svg dom <rect x="100" y="100" width="100" height="80">
h("rect", {
  ...style,
  x: x - width / 2, 
  y: y - height / 2,
  rx: radius, // 注意这里是rx而不是radius
  ry: radius,
  width,
  height
}),
  • circleellipse: 通过cx, cy表示图形的位置,含义为中心点的坐标。
const { x, y, r } = this.props.model;
// svg dom <circle cx="100", cy="100", r="20">
h("circle", {
  ...style,
  r, // 半径保持不变
  cx: x, 
  cy: y,
})

// 椭圆
const { x, y, rx, ry } = this.props.model;
// svg dom <ellipse cx="100", cy="100", rx="20" ry="10">
h("ellipse", {
  ...style,
  cx: x, 
  cy: y,
  rx,
  ry
})
  • polygon: 所有的顶点坐标已包含位置
const { x, y, points } = this.props.model;
const pointStr = points.map((point) => {
    return `${point[0] + x}, ${point[1] + y}`
  }).join(" ");
// svg dom <polygon points="100,10 250,150 200,110" >
h("polygon", {
  ...style,
  r, // 半径保持不变
  points: pointStr, // 
})

自定义矩形的view时radius设置

model中,radius是矩形节点的形状属性。但是在自定义view时需要注意,svg里面设置矩形的圆角并不是用radius,而是使用rx (opens new window), ry。所以在自定义view的矩形时,需要将model中radius的赋值给rxry,否则圆角将不生效。

# props

LogicFlow是基于preact开发的,我们自定义节点view的时候,可以通过this.props获取父组件传递过来的数据。this.props对象包含两个属性,分别为:

  • model: 表示自定义节点的model
  • graphModel: 表示logicflow整个图的model

# 图标的path如何获取

一般情况下,图标我们可以找UI或者去iconfont.cn (opens new window)获得一个svg格式的文件。然后再IDE中以文本的方式打开,然后格式化,就可以看到代码。

代码中一般是最外层一个svg标签,里面是一个或者多个path。这个时候,我们使用前面提到的h方法来实现svg文件中的代码即可。

svg标签一般包括如下属性:

  • viewBox: viewBox (opens new window)属性允许指定一个给定的一组图形伸展以适应特定的容器元素。一般把svg标签上的viewBox属性值复制过来就行。
  • widthheight: 这个不需要使用svg标签上的widthheight, 直接写成你期望的宽高就行。

path标签属性:

  • d: 该属性定义了一个路径。直接复制svg代码过来即可, 不需要去关系d具体内容表示的含义。
  • fill: 路径的填充颜色, 一般和节点的边框颜色一致,但是也可以按照业务需求自定义。

# 自定义连接规则校验

在某些时候,我们可能需要控制边的连接方式,比如开始节点不能被其它节点连接、结束节点不能连接其他节点、用户节点后面必须是判断节点等,要想达到这种效果,我们需要为节点设置以下两个属性。

  • sourceRules - 当节点作为边的起始节点(source)时的校验规则
  • targetRules - 当节点作为边的目标节点(target)时的校验规则

以正方形(square)为例,在边时我们希望它的下一节点只能是圆形节点(circle),那么我们应该给square添加作为source节点的校验规则。

import { RectNode, RectNodeModel } from '@logicflow/core';
class SquareModel extends RectNodeModel {
  setAttributes() {
    const size = 80;
    const circleOnlyAsTarget = {
      message: "正方形节点下一个节点只能是圆形节点",
      validate: (sourceNode, targetNode, sourceAnchor, targetAnchor) => {
        return targetNode.type === "circle";
      },
    };

    this.width = size;
    this.height = size;
    this.sourceRules.push(circleOnlyAsTarget);
  }
}

在上例中,我们为modelsourceRules属性添加了一条校验规则,校验规则是一个对象,我们需要为其提供messgagevalidate属性。

message属性是当不满足校验规则时所抛出的错误信息,validate则是传入规则检验的回调函数。validate方法有两个参数,分别为边的起始节点(source)和目标节点(target),我们可以根据参数信息来决定是否通过校验,其返回值是一个布尔值。

当我们在面板上进行边操作的时候,Logic Flow 会校验每一条规则,只有全部通过后才能连接。

在边时,当鼠标松开后如果没有通过自定义规则(validate方法返回值为false),Logic Flow 会对外抛出事件connection:not-allowed

lf.on('connection:not-allowed', (msg) => {
  console.log(msg)
});

设置不同状态下节点的样式

在节点model中,有个state属性,当节点连接规则校验不通过时,state属性值为5。我们可以通过这个属性来实现连线是节点的提示效果。

# 限制节点移动

有些时候,我们需要更加细粒度的控制节点什么时候可以移动,什么时候不可以移动,比如在实现分组插件时,需要控制分组节点子节点不允许移动出分组。

和连线规则类似,我们可以给节点的moveRules添加规则函数。

class MovableNodeModel extends RectNodeModel {
  initNodeData(data) {
    super.initNodeData(data);
    this.moveRules.push((model, deltaX, deltaY) => {
      // 不允许移动到坐标为负值的地方
      if (
        model.x + deltaX - this.width / 2 < 0 ||
        model.y + deltaY - this.height / 2 < 0
      ) {
        return false;
      }
      return true;
    });
  }
}

graphModel中支持添加全局移动规则,例如在移动A节点的时候,期望把B节点也一起移动了。

lf.graphModel.addNodeMoveRules((model, deltaX, deltaY) => {
  // 如果移动的是分组,那么分组的子节点也跟着移动。
  if (model.isGroup && model.children) {
    lf.graphModel.moveNodes(model.children, deltaX, deltaY, true);
  }
  return true;
});

# 自定义节点的锚点

对于各种基础类型节点,我们都内置了默认锚点。LogicFlow支持通过重写获取锚点的方法来实现自定义节点的锚点。

import { RectNode, RectNodeModel } from '@logicflow/core';

class SquareModel extends RectNodeModel {
  setAttribute() {
    const rule = {
      message: "只允许从右边的锚点连出",
      validate: (sourceNode, targetNode, sourceAnchor, targetAnchor) => {
        return sourceAnchor.name === "right";
      }
    };
    this.sourceRules.push(rule);
  }
  getAnchorStyle(anchorInfo) {
    const style = super.getAnchorStyle(anchorInfo);
    if (anchorInfo.type === 'left') {
      style.fill = 'red'
      style.hover.fill = 'transparent'
      style.hover.stroke = 'transpanrent'
      style.className = 'lf-hide-default'
    } else {
      style.fill = 'green'
    }
    return style;
  }
  getDefaultAnchor() {
    const { width, height, x, y, id } = this; 
    return [
      {
        x: x - width / 2,
        y,
        type: 'left',
        edgeAddable: false, // 控制锚点是否可以从此锚点手动创建连线。默认为true。
        id: `${id}_0`
      },
      {
        x: x + width / 2,
        y,
        type: 'right',
        id: `${id}_1`
      },
    ]
  }
}

上面的示例中,我们自定义锚点的时候,不仅可以定义锚点的数量和位置,还可以给锚点加上任意属性。有了这些属性,我们可以再做很多额外的事情。例如,我们增加一个校验规则,只允许节点从右边连出,从左边连入;或者加个id, 在获取数据的时候保存当前连线从那个锚点连接到那个锚点。

注意

一定要确保锚点id唯一,否则可能会出现在连线规则校验不准确的问题。

提示

在实际开发中,存在隐藏锚点的需求,可以参考github issue 如何隐藏锚点? (opens new window),可以查看code sandbox 示例 (opens new window)

# 自定义节点文本

LogicFlow支持自定义节点文本的外观和编辑状态。参考nodeModel API中的textObject

class CustomNodeModel extends RectNodeModel {
  initNodeData(data) {
    super.initNodeData(data)
    this.text.draggable = false; // 不允许文本被拖动
    this.text.editable = false; // 不允许文本被编辑
  }
  getTextStyle() {
    const style = super.getTextStyle();
    style.fontSize = 16;
    style.color = 'red';
    return style;
  }
}

# 自定义HTML节点

LogicFlow内置了基础的HTML节点和其他基础节点不一样,我们可以利用LogicFlow的自定义机制,实现各种形态的HTML节点,而且HTML节点内部可以使用任意框架进行渲染。

class UmlModel extends HtmlNodeModel {
  setAttributes() {
    this.text.editable = false; // 禁止节点文本编辑
    // 设置节点宽高和锚点
    const width = 200;
    const height = 130;
    this.width = width;
    this.height = height;
    this.anchorsOffset = [
      [width / 2, 0],
      [0, height / 2],
      [-width / 2, 0],
      [0, -height/2],
    ]
  }
}
class UmlNode extends HtmlNode {
  currrentProperties: string;
  setHtml(rootEl: HTMLElement) {
    const { properties } = this.props.model;
  
    const el = document.createElement('div');
    el.className = 'uml-wrapper';
    const html = `
      <div>
        <div class="uml-head">Head</div>
        <div class="uml-body">
          <div>+ ${properties.name}</div>
          <div>+ ${properties.body}</div>
        </div>
        <div class="uml-footer">
          <div>+ setHead(Head $head)</div>
          <div>+ setBody(Body $body)</div>
        </div>
      </div>
    `
    el.innerHTML = html;
    // 需要先把之前渲染的子节点清除掉。
    rootEl.innerHTML = '';
    rootEl.appendChild(el);
  }
}

# 使用react编写html节点

以为自定义html节点对外暴露的是一个DOM节点,所以你可以使用框架现有的能力来渲染节点。在react中,我们利用reactDomrender方法,将react组件渲染到dom节点上。

import { HtmlNodeModel, HtmlNode } from '@logicflow/core';
import React from 'react';
import ReactDOM from 'react-dom';
import './uml.css';

function Hello(props) {
  return (
    <>
      <h1 className="box-title">title</h1>
      <div className="box-content">
        <p>{props.name}</p>
        <p>{props.body}</p>
        <p>content3</p>
      </div>
    </>
  )
}

class BoxxModel extends HtmlNodeModel {
  setAttributes() {
    this.text.editable = false;
    const width = 200;
    const height = 116;
    this.width = width;
    this.height = height;
    this.anchorsOffset = [
      [width / 2, 0],
      [0, height / 2],
      [-width / 2, 0],
      [0, -height/2],
    ]
  }
}
class BoxxNode extends HtmlNode {
  setHtml(rootEl: HTMLElement) {
    const { properties } = this.props.model;
    ReactDOM.render(<Hello name={properties.name} body={properties.body}/>, rootEl);
  }
}

const boxx = {
  type: 'boxx',
  view: BoxxNode,
  model: BoxxModel
}

export default boxx;


// page.jsx

import box from './box.tsx';
export default function PageIndex() {
  useEffect(() => {
    const lf = new LogicFlow({
      ...config,
      container: document.querySelector('#graph_html') as HTMLElement
    });
    lf.register(box);
    lf.render({
      nodes: [
        {
          id: 11,
          type: 'boxx',
          x: 350,
          y: 100,
          properties: {
            name: 'turbo',
            body: 'hello'
          }
        },
      ]
    });
    lf.on('node:click', ({ data}) => {
      lf.setProperties(data.id, {
        name: 'turbo',
        body: Math.random()
      })
    });
  }, []);

  return (
    <>
      <div id="graph_html" className="viewport" />
    </>
  )
}

# 自定义HTML节点示例