拓扑图编辑器-jsplumb事件

jsPlumb支持绑定到Connections,Endpoints和Overlays上的几个不同事件,以及jsPlumb对象本身。

jsPlumb事件

要在jsPlumb本身(或jsPlumb实例)上绑定事件,请使用jsPlumb.bind(event, callback)

jsPlumb.bind("connection", function(info) {
   .. update your model in here, maybe.
});

可以在jsPlumb类上绑定的事件:

connection(info, originalEvent)- 通知连接建立

info具有的属性:

  • connection: 新连接,可以注册监听
  • sourceId: 连接的源元素id
  • targetId: 连接的目标元素id
  • source: 连接的源元素
  • target: 连接的目标元素
  • sourceEndpoint: 连接的源端点
  • targetEndpoint: 连接的目标端点

originalEvent:建立连接的原始鼠标事件。
注: jsPlumb.connect或者鼠标连线时触发此事件

connectionDetached(info,originalEvent)- 通知连接断开

info具有的属性:

  • connection: 已分离的连接
  • sourceId: 分离之前连接的源元素id
  • targetId: 分离之前连接的目标元素id
  • source: 分离之前连接的源元素
  • target: 分离之前连接的目标元素
  • sourceEndpoint: 分离之前连接的源端点
  • targetEndpoint: 分离之前连接的目标端点

连接到某个节点之前放弃新拖动的Connection时不会触发此事件,可以使用connectionAborted捕获。

originalEvent:断开连接的原始鼠标事件。

connectionMoved(info,originalEvent)- 通知已将现有连接的源或目标端点拖动到某个新位置

info具有的属性:

  • index: 源端点为0,目标端点为1
  • originalSourceId: 移动前连接的源元素id
  • newSourceId: 移动后连接的源元素id
  • originalTargetId: 移动前连接的目标元素id
  • newTargetId: 移动后连接的目标元素id
  • originalSourceEndpoint: 移动前的源端点
  • newSourceEndpoint: 移动后的源端点
  • originalTargetEndpoint: 移动前的目标端点
  • newTargetEndpoint: 移动后的目标端点
connectionAborted(connection,originalEvent)在连接到端点或目标元素之前放弃拖动连接时触发
connectionDrag(connection)- 正在拖动现有连接

注:当此事件触发时,连接的目标端点是jsPlumb用于拖动的瞬态元素,随后在建立或中止连接时将从DOM中删除。

connectionDragStop(connection)- 连接拖动结束
click(connection, originalEvent)- 单击连接
dblclick(connection, originalEvent)- 双击连接
endpointClick(connection, originalEvent)- 单击端点
endpointDblClick(connection, originalEvent)- 双击端点
contextmenu(connection, originalEvent)- 右键单击某个给定组件jsPlumb将报告对Connections和Endpoints的右键单击
beforeDrop(info)- 删除新连接或现有连接时触发此事件

info具有的属性:

  • index: 源端点为0,目标端点为1
  • sourceId: 连接的源元素id
  • targetId: 连接的目标元素id
  • scope: 连接的范围
  • connection: 实际的Connection对象。可以访问Connection中的“端点”数组,以获取连接中涉及的端点,但注意,在拖动连接时,目标端点将始终是仅在拖动的生命周期内存在的瞬态端点。要获取正在删除的连接端点,请使用dropEndpoint。
  • dropEndpoint: 这是删除连接的实际端点。可能为null,因为如果在已调用makeTarget的元素上删除Connection,则不会设置它
  • targetEndpoint: 分离之前Connection中的目标端点
beforeDetach(connection)- 断开连接时触发此事件。connection参数为刚断开的Connection。如果此拦截器返回false将会中止连接断开。
beforeDrag(connection)- 开始拖动新连接时触发此事件。
  • endpoint: 拖动连接的端点
  • source: 端点所属的源
  • sourceId: 端点所属的源ID

beforeDrag与其他拦截器的操作略有不同:从拦截器函数返回false将取消当前拖动,也可以从拦截器返回一个对象,此对象将作为data被传进新连接的构造函数中:

jsPlumbInstance.bind("beforeDrag", function(params) {
  return {
   foo:"bar"
  }
});

如果已定义参数化连接类型,此功能特别有用。使用此机制,可以使用选择的数据填充新拖动的连接。
注: 1.7.6之前的所有jsPlumb版本,新的连接拖动以及拖动现有的连接都会触发beforeDetach。从1.7.6开始,后一种行为已被移至 beforeStartDetach拦截器。

beforeStartDetach(connection)- 开始拖动现有连接时触发此事件。
  • endpoint: 拖动连接的端点
  • source: 端点所属的源
  • sourceId: 端点所属的源ID
  • connection: 即将被拖动的连接

返回false,取消拖动。

连接事件

绑定到Connection上的事件,还可以使用以下bind方法:

var connection = jsPlumb.connect({source:"d1", target:"d2"});
connection.bind("click", function(conn) {
    console.log("you clicked on ", conn);
});

这些是可以绑定到连线事件:

  • click(connection, originalEvent) - 单击连接。
  • dblclick(connection, originalEvent) - 双击连接。
  • contextmenu(connection, originalEvent) - 右键单击​​连线。
  • mouseover(connection, originalEvent) - 鼠标放在连线上。
  • mouseout(connection, originalEvent) - 鼠标移出连线。
  • mousedown(connection, originalEvent) - 连接上的鼠标按钮被按下。
  • mouseup(connection, originalEvent) - 连接上的鼠标按钮被释放。
端点事件

绑定到端点上的事件,使用以下bind方法:

var endpoint = jsPlumb.addEndpoint("d1", { someOptions } );
endpoint.bind("click", function(endpoint) {
    console.log("you clicked on ", endpoint);
});

这些是可以绑定到端点的事件:

  • click(endpoint, originalEvent) - 单击端点。
  • dblclick(endpoint, originalEvent) - 双击端点。
  • contextmenu(endpoint, originalEvent) - 右键单击​​端点。
  • mouseover(endpoint, originalEvent) - 鼠标放在端点上。
  • mouseout(endpoint, originalEvent) - 鼠标移出端点。
  • mousedown(endpoint, originalEvent) - 端点上的鼠标按钮被按下。
  • mouseup(endpoint, originalEvent) - 端点上鼠标按钮被释放。
  • maxConnections(info, originalEvent) - 在已具有最大连接数的端点上删除连接。
    info具有的属性:
    • endpoint:删除连线的端点
    • connection:删除的连接
    • maxConnections:端点的maxConnections值
覆盖事件

在Overlay上注册事件侦听器是一个稍微不同的过程 - 将它们作为Overlay构造函数的参数。

以下是在Overlay上注册点击监听器的方法:

jsPlumb.connect({
    source:"el1",
    target:"el2",
    overlays:[
      [ "Label", {
        events:{
          click:function(labelOverlay, originalEvent) { 
            console.log("click on label overlay for :" + labelOverlay.component); 
          }
        }
      }],
      [ "Diamond", {
        events:{
          dblclick:function(diamondOverlay, originalEvent) { 
            console.log("double click on diamond overlay for : " + diamondOverlay.component); 
          }
        }
      }]    
    ]
  });
解除绑定事件

在jsPlumb对象以及Connections和Endpoints上,可以使用unbind方法删除监听器。

//取消绑定事件
jsPlumb.unbind("click");

或者

//解除所有事件
var e = jsPlumb.addEndpoint("someDiv");
e.bind("click", function() { ... });
e.bind("dblclick", function() { ... });

...

e.unbind("click");

下一篇:拓扑图编辑器-实现过程

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容