Events

There are three basic kinds of events that GoJS deals with: DiagramEvents, InputEvents, and ChangedEvents. This page discusses the first two; see Changed Events for the last kind of event.

Diagram Events

DiagramEvents represent general user-initiated changes to a diagram. You can register one or more diagram event handlers by calling Diagram.addDiagramListener. You can also register a diagram event handler in Diagram initialization when calling GraphObject.make. Each kind of diagram event is distinguished by its name.

Currently defined diagram event names include:

DiagramEvents do not necessarily correspond to mouse events or keyboard events or touch events. Nor do they necessarily correspond to changes to the diagram's model -- for tracking such changes, use Model.addChangedListener or Diagram.addModelChangedListener. DiagramEvents only occur because the user did something, perhaps indirectly.

In addition to the DiagramEvent listeners there are also circumstances where detecting such changes is common enough to warrant having properties that are event handlers. Because these events do not necessarily correspond to any particular input or diagram event, these event handlers have custom arguments that are specific to the situation.

One very common such event property is GraphObject.click, which if non-null is a function that is called whenever the user clicks on that object. This is most commonly used to specify behavior for "Button"s, but it and the other "click" event properties, "doubleClick" and "contextClick", can be useful on any GraphObject.

Another common event property is Part.selectionChanged, which (if non-null) is called whenever Part.isSelected changes. In this case the event handler function is passed a single argument, the Part. There is no need for additional arguments because the function can check the current value of Part.isSelected to decide what to do.

Model ChangedEvents are more complete and reliable than depending on DiagramEvents. For example, the "LinkDrawn" DiagramEvent is not raised when code adds a link to a diagram. That DiagramEvent is only raised when the user draws a new link using the LinkingTool. Furthermore the link has not yet been routed, so Link.points will not have been computed. In fact, creating a new link may invalidate a Layout, so all of the nodes may be moved in the near future.

Sometimes you want to update a database as the user makes changes to a diagram. Usually you will want to implement a Model ChangedEvent listener, by calling Model.addChangedListener or Diagram.addModelChangedListener, that notices the changes to the model and decides what to record in the database. See the discussion of Changed Events and the Update Demo.

This example demonstrates handling several diagram events: "ObjectSingleClicked", "BackgroundDoubleClicked", and "ClipboardPasted". 


  function showMessage(s) {
    document.getElementById("diagramEventsMsg").textContent = s;
  }

  diagram.addDiagramListener("ObjectSingleClicked",
      e => {
        var part = e.subject.part;
        if (!(part instanceof go.Link)) showMessage("Clicked on " + part.data.key);
      });

  diagram.addDiagramListener("BackgroundDoubleClicked",
      e => showMessage("Double-clicked at " + e.diagram.lastInput.documentPoint));

  diagram.addDiagramListener("ClipboardPasted",
      e => showMessage("Pasted " + e.diagram.selection.count + " parts"));

  var nodeDataArray = [
    { key: "Alpha" },
    { key: "Beta", group: "Omega" },
    { key: "Gamma", group: "Omega" },
    { key: "Omega", isGroup: true },
    { key: "Delta" }
  ];
  var linkDataArray = [
    { from: "Alpha", to: "Beta" },  // from outside the Group to inside it
    { from: "Beta", to: "Gamma" },  // this link is a member of the Group
    { from: "Omega", to: "Delta" }  // from the Group to a Node
  ];
  diagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
(message)

Input Events

When a low-level HTML DOM event occurs, GoJS canonicalizes the keyboard/mouse/touch event information into a new InputEvent that can be passed to various event-handling methods and saved for later examination.

An InputEvent keeps the InputEvent.key for keyboard events, the InputEvent.button for mouse events, the InputEvent.viewPoint for mouse and touch events, and InputEvent.modifiers for keyboard and mouse events.

The diagram's event handlers also record the InputEvent.documentPoint, which is the InputEvent.viewPoint in document coordinates at the time of the mouse event, and the InputEvent.timestamp, which records the time that the event occurred in milliseconds.

The InputEvent class also provides many handy properties for particular kinds of events. Examples include InputEvent.control (if the control key had been pressed) and InputEvent.left (if the left/primary mouse button was pressed).

Some tools find the "current" GraphObject at the mouse point. This is remembered as the InputEvent.targetObject.

Higher-level input events

Some tools detect a sequence of input events to compose somewhat more abstract user events. Examples include "click" (mouse-down-and-up very close to each other) and "hover" (motionless mouse for some time). The tools will call an event handler (if there is any) for the current GraphObject at the mouse point. The event handler is held as the value of a property on the object. It then also "bubbles" the event up the chain of GraphObject.panels until it ends with a Part. This allows a "click" event handler to be declared on a Panel and have it apply even if the click actually happens on an element deep inside the panel. If there is no object at the mouse point, the event occurs on the diagram.

Click-like event properties include GraphObject.click, GraphObject.doubleClick, and GraphObject.contextClick. They also occur when there is no GraphObject -- the event happened in the diagram's background: Diagram.click, Diagram.doubleClick, and Diagram.contextClick. These are all properties that you can set to a function that is the event handler. These events are caused by both mouse events and touch events.

Mouse-over-like event properties include GraphObject.mouseEnter, GraphObject.mouseOver, and GraphObject.mouseLeave. But only Diagram.mouseOver applies to the diagram.

Hover-like event properties include GraphObject.mouseHover and GraphObject.mouseHold. The equivalent diagram properties are Diagram.mouseHover and Diagram.mouseHold.

There are also event properties for dragging operations: GraphObject.mouseDragEnter, GraphObject.mouseDragLeave, and GraphObject.mouseDrop. These apply to stationary objects, not the objects being dragged. And they also occur when dragging by touch events, not just mouse events.

This example demonstrates handling three higher-level input events: clicking on nodes and entering/leaving groups. 


  function showMessage(s) {
    document.getElementById("inputEventsMsg").textContent = s;
  }

  diagram.nodeTemplate =
    $(go.Node, "Auto",
      $(go.Shape, "Ellipse", { fill: "white" }),
      $(go.TextBlock,
        new go.Binding("text", "key")),
      { click: (e, obj) => showMessage("Clicked on " + obj.part.data.key) }
    );

  diagram.groupTemplate =
    $(go.Group, "Vertical",
      $(go.TextBlock,
        { alignment: go.Spot.Left, font: "Bold 12pt Sans-Serif" },
        new go.Binding("text", "key")),
      $(go.Panel, "Auto",
        $(go.Shape, "RoundedRectangle",
          { name: "SHAPE",
            parameter1: 14,
            fill: "rgba(128,128,128,0.33)" }),
        $(go.Placeholder, { padding: 5 })
      ),
      { mouseEnter: (e, obj, prev) => {  // change group's background brush
            var shape = obj.part.findObject("SHAPE");
            if (shape) shape.fill = "red";
          },
        mouseLeave: (e, obj, next) => {  // restore to original brush
            var shape = obj.part.findObject("SHAPE");
            if (shape) shape.fill = "rgba(128,128,128,0.33)";
          } });

  var nodeDataArray = [
    { key: "Alpha" },
    { key: "Beta", group: "Omega" },
    { key: "Gamma", group: "Omega" },
    { key: "Omega", isGroup: true },
    { key: "Delta" }
  ];
  var linkDataArray = [
    { from: "Alpha", to: "Beta" },  // from outside the Group to inside it
    { from: "Beta", to: "Gamma" },  // this link is a member of the Group
    { from: "Omega", to: "Delta" }  // from the Group to a Node
  ];
  diagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
(message)

Clicking and Selecting

This example demonstrates both the "click" and the "selectionChanged" events: 


  function showMessage(s) {
    document.getElementById("changeMethodsMsg").textContent = s;
  }

  diagram.nodeTemplate =
    $(go.Node, "Auto",
      { selectionAdorned: false },
      $(go.Shape, "Ellipse", { fill: "white" }),
      $(go.TextBlock,
        new go.Binding("text", "key")),
      {
        click: (e, obj) => showMessage("Clicked on " + obj.part.data.key),
        selectionChanged: part => {
            var shape = part.elt(0);
            shape.fill = part.isSelected ? "red" : "white";
          }
      }
    );

  var nodeDataArray = [
    { key: "Alpha" }, { key: "Beta" }, { key: "Gamma" }
  ];
  var linkDataArray = [
    { from: "Alpha", to: "Beta" },
    { from: "Beta", to: "Gamma" }
  ];
  diagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
(message)

Try Ctrl-A to select everything. Note the distinction between the GraphObject.click event property and the Part.selectionChanged event property. Both are methods that get called when something has happened to the node. The GraphObject.click occurs when the user clicks on the node, which happens to select the node. But the Part.selectionChanged occurs even when there is no click event or even any mouse event -- it was due to a property change to the node.