All files / core/misc sigma.misc.drawHovers.ts

20.75% Statements 11/53
0% Branches 0/36
20% Functions 2/10
22.92% Lines 11/48

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186                  4x             4x   4x 4x   4x                                                                                                                                                                                                                                                                         4x               4x         4x               4x         4x     4x    
import {
  Event,
  Node,
  Edge,
  SigmaLibrary,
  Renderer,
  Keyed
} from "../interfaces";
 
export default function configure(sigma: SigmaLibrary) {
  /**
   * This method listens to "overNode", "outNode", "overEdge" and "outEdge"
   * events from a renderer and renders the nodes differently on the top layer.
   * The goal is to make any node label readable with the mouse, and to
   * highlight hovered nodes and edges.
   */
  function drawHovers(this: Renderer, prefix: string) {
    //TODO: this type should be renderer
    const hoveredNodes: Keyed<Node> = {};
    const hoveredEdges: Keyed<Edge> = {};
 
    const draw = () => {
      let hoveredNode;
      let hoveredEdge;
      const c = this.contexts.hover.canvas;
      const defaultNodeType = this.settings("defaultNodeType");
      const defaultEdgeType = this.settings("defaultEdgeType");
      const nodeRenderers = sigma.canvas.hovers;
      const edgeRenderers = sigma.canvas.edgehovers;
      const extremitiesRenderers = sigma.canvas.extremities;
      const embedSettings = this.settings.embedObjects({ prefix });
      const hoverContext = this.contexts.hover! as CanvasRenderingContext2D;
 
      // Clear this.contexts.hover:
      hoverContext.clearRect(0, 0, c.width, c.height);
 
      // Node render: single hover
      if (
        embedSettings("enableHovering") &&
        embedSettings("singleHover") &&
        Object.keys(hoveredNodes).length
      ) {
        hoveredNode = hoveredNodes[Object.keys(hoveredNodes)[0]];
        (nodeRenderers[hoveredNode.type] ||
          nodeRenderers[defaultNodeType] ||
          nodeRenderers.def)(hoveredNode, hoverContext, embedSettings);
      }
 
      // Node render: multiple hover
      if (embedSettings("enableHovering") && !embedSettings("singleHover"))
        Object.keys(hoveredNodes).forEach(k => {
          (nodeRenderers[hoveredNodes[k].type] ||
            nodeRenderers[defaultNodeType] ||
            nodeRenderers.def)(hoveredNodes[k], hoverContext, embedSettings);
        });
 
      // Edge render: single hover
      if (
        embedSettings("enableEdgeHovering") &&
        embedSettings("singleHover") &&
        Object.keys(hoveredEdges).length
      ) {
        hoveredEdge = hoveredEdges[Object.keys(hoveredEdges)[0]];
        const [source, target] = this.graph.nodes(
          hoveredEdge.source,
          hoveredEdge.target
        );
 
        if (!hoveredEdge.hidden) {
          (edgeRenderers[hoveredEdge.type] ||
            edgeRenderers[defaultEdgeType] ||
            edgeRenderers.def)(
            hoveredEdge,
            source,
            target,
            hoverContext,
            embedSettings
          );
 
          if (embedSettings("edgeHoverExtremities")) {
            (extremitiesRenderers[hoveredEdge.type] ||
              extremitiesRenderers.def)(
              hoveredEdge,
              source,
              target,
              hoverContext,
              embedSettings
            );
          } else {
            // Avoid edges rendered over nodes:
            (sigma.canvas.nodes[source.type] || sigma.canvas.nodes.def)(
              source,
              hoverContext,
              embedSettings
            );
            (sigma.canvas.nodes[target.type] || sigma.canvas.nodes.def)(
              target,
              hoverContext,
              embedSettings
            );
          }
        }
      }
 
      // Edge render: multiple hover
      if (
        embedSettings("enableEdgeHovering") &&
        !embedSettings("singleHover")
      ) {
        Object.keys(hoveredEdges).forEach(k => {
          hoveredEdge = hoveredEdges[k];
          const [source, target] = this.graph.nodes(
            hoveredEdge.source,
            hoveredEdge.target
          );
 
          if (!hoveredEdge.hidden) {
            (edgeRenderers[hoveredEdge.type] ||
              edgeRenderers[defaultEdgeType] ||
              edgeRenderers.def)(
              hoveredEdge,
              source,
              target,
              hoverContext,
              embedSettings
            );
 
            if (embedSettings("edgeHoverExtremities")) {
              (extremitiesRenderers[hoveredEdge.type] ||
                extremitiesRenderers.def)(
                hoveredEdge,
                source,
                target,
                hoverContext,
                embedSettings
              );
            } else {
              // Avoid edges rendered over nodes:
              (sigma.canvas.nodes[source.type] || sigma.canvas.nodes.def)(
                source,
                hoverContext,
                embedSettings
              );
              (sigma.canvas.nodes[target.type] || sigma.canvas.nodes.def)(
                target,
                hoverContext,
                embedSettings
              );
            }
          }
        });
      }
    };
 
    this.bind("overNode", (event: Event<{ node: Node }>) => {
      const { node } = event.data;
      if (!node.hidden) {
        hoveredNodes[node.id] = node;
        draw();
      }
    });
 
    this.bind("outNode", (event: Event<{ node: Node }>) => {
      delete hoveredNodes[event.data.node.id];
      draw();
    });
 
    this.bind("overEdge", (event: Event<{ edge: Edge }>) => {
      const { edge } = event.data;
      if (!edge.hidden) {
        hoveredEdges[edge.id] = edge;
        draw();
      }
    });
 
    this.bind("outEdge", (event: Event<{ edge: Edge }>) => {
      delete hoveredEdges[event.data.edge.id];
      draw();
    });
 
    this.bind("render", () => draw());
  }
 
  sigma.register("sigma.misc.drawHovers", drawHovers);
}