total-diagram 0.9.4 → 0.9.5

package/README.md

@@ -8,7 +8,7 @@ Total Diagram
 Simple, powerful, extensible and fast JavaScript/ES8 diagram renderer for web browsers.
 </p>
 <p align="center">
-v0.9.4
+v0.9.5
 </p>
 
 [![build](https://github.com/dariuszdawidowski/total-diagram/actions/workflows/build.yml/badge.svg)](https://github.com/dariuszdawidowski/total-diagram/actions/workflows/build.yml)
@@ -20,6 +20,10 @@ v0.9.4
 A library for rendering diagrams consisting of nodes and links.
 Designed for simplicity, it can be the basis for creating a diagramming application or data representation on a website.
 
+<img src="./total-diagram-showcase.png" alt="" />
+
+# Quick Start
+
 For more details look into 'examples/' directory. You can find self-explanatory tutorials there.
 
 # Features

package/dist/total-diagram.js

@@ -0,0 +1,5 @@
+class TotalDiagramNode{constructor(t={}){this.id="id"in t?t.id:crypto.randomUUID(),this.name="name"in t?t.name:null,this.transform={x:"x"in t?t.x:0,y:"y"in t?t.y:0,border:0,zindex:"zindex"in t?t.zindex:0,ox:0,oy:0,w:0,h:0,wmin:64,hmin:64,wmax:1024,hmax:1024,clear:()=>{this.transform.x=0,this.transform.y=0,this.transform.zindex=0,this.element.style.zIndex=0}},this.links={list:[],add:t=>{this.links.list.push(t)},del:t=>{const i=this.links.list.indexOf(t);-1!==i&&this.links.list.splice(i,1)},get:t=>"*"==t?this.links.list:"string"==typeof t?this.links.list.find((i=>i.id==t)):null,update:()=>{this.links.list.forEach((t=>t.update()))}},this.element=document.createElement("div"),this.element.classList.add("total-diagram-node"),this.element.style.zIndex=this.transform.zindex,this.element.dataset.id=this.id}destructor(){}awake(){}start(){}setSize(t){this.transform.w=t.width,this.transform.h=t.height,"minWidth"in t&&(this.transform.wmin=t.minWidth),"minHeight"in t&&(this.transform.hmin=t.minHeight),"maxWidth"in t&&(this.transform.wmax=t.maxWidth),"maxHeight"in t&&(this.transform.hmax=t.maxHeight),this.transform.border="border"in t?t.border:parseInt(getComputedStyle(this.element,null).getPropertyValue("border-left-width").replace("px",""))||0,this.setOrigin(),this.element.style.width=this.transform.w+"px",this.element.style.height=this.transform.h+"px"}getSize(){return{width:this.transform.w,height:this.transform.h,minWidth:this.transform.wmin,minHeight:this.transform.hmin,maxWidth:this.transform.wmax,maxHeight:this.transform.hmax}}setOrigin(){this.transform.ox=this.transform.w/2,this.transform.oy=this.transform.h/2}setPosition(t){this.transform.x=t.x,this.transform.y=t.y}getPosition(){return{x:this.transform.x,y:this.transform.y}}addPosition(t){this.transform.x+=t.x,this.transform.y+=t.y}subPosition(t){this.transform.x-=t.x,this.transform.y-=t.y}addLink(t){this.links.add(t)}delLink(t){this.links.del(t)}setStyle(t,i=null){null!==i&&(this.element.style[t]=i)}getStyle(t=null){return null!==t?this.element.style[t]:this.element.style}transparent(t){this.element.style.opacity=100==t?null:t/100}animated(t=!0){this.element.style.transition=t?"transform 0.5s ease-in-out":null}serialize(){return{id:this.id,type:this.constructor.name,x:this.transform.x,y:this.transform.y,w:this.transform.w,h:this.transform.h,zindex:this.transform.zindex}}setSortingZ(t){this.transform.zindex=t,this.element.style.zIndex=t}update(){this.element.style.transform=`translate(${this.transform.x-this.transform.ox}px, ${this.transform.y-this.transform.oy}px)`}}
+class TotalDiagramNodesManager{constructor(){this.render=null,this.list=[]}add(t){this.list.push(t),this.render.board.append(t.element),t.awake()}del(t){if("*"!=t){let e=t.links.get("*");for(;e.length;){const t=e.pop();this.render.links.del(t)}t.destructor(),t.element.remove();const i=this.list.indexOf(t);-1!==i&&this.list.splice(i,1)}else"*"==t&&(this.list.length=0)}get(t){if("*"==t)return this.list;if(null!=t&&"object"==typeof t){let e=t;for(;e.parentNode;){if("classList"in e&&e.classList.contains("total-diagram-node"))return this.get(e.dataset.id);e=e.parentNode}}else{if("function"==typeof t)return this.list.filter((e=>e instanceof t));if("string"==typeof t)return this.list.find((e=>e.id==t))}return null}}
+class TotalDiagramLink{constructor(t){this.id="id"in t?t.id:crypto.randomUUID(),this.start=t.start,this.start.addLink(this),this.end=t.end,this.end.addLink(this),this.element=document.createElementNS("http://www.w3.org/2000/svg","svg"),this.element.classList.add("link"),this.element.dataset.id=this.id}destructor(){this.start&&this.start.delLink(this),this.end&&this.end.delLink(this)}serialize(){return{id:this.id,type:this.constructor.name,start:this.start.id,end:this.end.id}}transparent(t){this.element.style.opacity=100==t?null:t/100}update(){}}
+class TotalDiagramLinksManager{constructor(){this.render=null,this.list=[]}add(t){if(!t.start||!t.end)return null;this.list.push(t),this.render.board.append(t.element)}del(t){if("*"!=t){t.destructor(),t.element.remove();const e=this.list.indexOf(t);-1!==e&&this.list.splice(e,1)}else this.list.length=0}get(t,e=null){if("*"==t)return this.list;if(e){for(const i of t.links.get("*"))for(const t of e.links.get("*"))if(i.id==t.id)return i;return null}return"string"==typeof t?this.list.find((e=>e.element.dataset.id==t)):"function"==typeof t?this.list.filter((e=>e instanceof t)):"object"==typeof t&&"dataset"in t?this.get(t.dataset.id):null}}
+class TotalDiagramRenderHTML5{constructor(t){this.container=t.container,this.board=document.createElement("div"),this.board.id="total-diagram-attach",this.board.style.transformOrigin="0px 0px",this.board.style.width=0,this.board.style.height=0,this.board.style.overflow="visible",this.container.appendChild(this.board),this.size=this.container.getBoundingClientRect(),this.size.center={x:this.size.width/2,y:this.size.height/2},this.margin={left:this.size.left-document.documentElement.scrollLeft,top:this.size.top-document.documentElement.scrollTop},this.offset={x:0,y:0,z:1},window.addEventListener("resize",(()=>{this.size=this.container.getBoundingClientRect(),this.size.center={x:this.size.width/2,y:this.size.height/2}})),this.nodes=t.nodes,this.nodes.render=this,this.links=t.links,this.links.render=this}pan(t,s){this.offset.x+=t,this.offset.y+=s,this.update()}zoom(t,s,e,i){let h=this.offset.z;this.offset.z=(this.offset.z-e/i*this.offset.z).clamp(.1,3),h=this.offset.z/h;const o=this.board.getBoundingClientRect(),n=o.width/2+o.left-t,f=o.height/2+o.top-s;this.offset.x+=n*h-n,this.offset.y+=f*h-f,this.update()}pinchZoom(t,s,e,i,h){let o=this.offset.z;this.offset.z=(this.offset.z*h).clamp(.1,3),o=this.offset.z/o;const n=this.board.getBoundingClientRect(),f=n.width/2+n.left-(t+e)/2,r=n.height/2+n.top-(s+i)/2;this.offset.x+=f*o-f,this.offset.y+=r*o-r,this.update()}screen2World(t){return{x:Math.round((t.x-this.offset.x)/this.offset.z-this.margin.left),y:Math.round((t.y-this.offset.y)/this.offset.z-this.margin.top)}}world2Screen(t){return{x:Math.round(this.offset.x+t.x*this.offset.z-this.margin.left),y:Math.round(this.offset.y+t.y*this.offset.z-this.margin.top)}}center(t={x:0,y:0},s="none",e="hard",i=null){"smooth"==e&&(this.board.style.transition="transform 1s",setInterval((()=>{this.board.style.removeProperty("transition")}),1e3)),"reset"==s?this.offset.z=1:"focus"==s&&(this.offset.z=this.size.height/(i.height+i.margin)),this.offset.x=-t.x*this.offset.z+this.size.center.x,this.offset.y=-t.y*this.offset.z+this.size.center.y,this.update()}centerZoom(){this.offset.z=1,this.update()}clear(){this.board.innerHTML="",this.links.del("*"),this.nodes.del("*")}update(){this.board.style.transform=`translate(${this.offset.x}px, ${this.offset.y}px) scale(${this.offset.z})`}redraw(){this.container.style.display="none";this.container.offsetHeight;this.container.style.display="block"}}

package/examples/1_basic.html

@@ -33,6 +33,12 @@
                 user-select: none;
                 touch-action: none;
                 overflow: hidden;
+                font-family: Arial, sans-serif;
+            }
+
+            h3, p {
+                color: white;
+                text-align: center;
             }
 
             .node {
@@ -60,7 +66,10 @@
     </head>
     <body>
         <!-- Main diagram container -->
-        <div id="container"></div>
+        <div id="container">
+            <h3>1: Basic demo</h3>
+            <p>How to create two nodes and link them.</p>
+        </div>
 
         <!-- Total Diagram library -->
         <script type="text/javascript" src="../render-node.js"></script>

package/examples/2_node.html

@@ -0,0 +1,235 @@
+<!doctype html>
+
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>Total Diagram Demo</title>
+        <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate">
+        <meta http-equiv="Pragma" content="no-cache">
+        <meta http-equiv="Expires" content="0">
+        <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
+        <style>
+
+            html, body {
+                width: 100%;    
+                height: 100%;
+                margin: 0;
+            }
+
+            #container {
+                position: relative;
+                margin: 0 auto;
+                display: block;
+                background-color: #060531;
+                width: 100%;
+                min-width: 640px;
+                height: 100%;
+                min-height: 480px;
+                -webkit-touch-callout: none;
+                -webkit-user-select: none;
+                -khtml-user-select: none;
+                -moz-user-select: none;
+                -ms-user-select: none;
+                user-select: none;
+                touch-action: none;
+                overflow: hidden;
+                font-family: Arial, sans-serif;
+            }
+
+            h3, p {
+                color: white;
+                text-align: center;
+            }
+
+            .node {
+                display: flex;
+                flex-direction: column;
+                position: absolute;
+                background-color: white;
+                border-radius: 8px;
+                border-bottom: 10px solid #f19331;
+            }
+
+            .node .titlebar {
+                color: white;
+                background-color: #f19331;
+                width: 100%;
+                height: 35px;
+                line-height: 35px;
+                text-align: center;
+                font-size: 16px;
+                font-weight: bold;
+                border-radius: 8px 8px 0 0;
+            }
+
+            .node .header {
+                color: #222;
+                text-align: left;
+                font-size: 14px;
+                margin: 12px 16px;
+                font-weight: bold;
+            }
+
+            .node .option {
+                color: #222;
+                background-color: #fff5f5;
+                text-align: left;
+                font-size: 14px;
+                margin: 8px 16px 0 16px;
+                padding: 10px;
+                border-radius: 8px;
+            }
+
+            .link {
+                position: absolute;
+                left: 0;
+                top: 0;
+                overflow: visible;
+                z-index: -1;
+            }
+
+            .link line {
+                pointer-events: none;
+                fill: #e88f56;
+                stroke: #e88f56;
+                stroke-width: 2;
+            }
+
+        </style>
+    </head>
+    <body>
+        <!-- Main diagram container -->
+        <div id="container">
+            <h3>2: Node demo</h3>
+            <p>How to make and style custom nodes.</p>
+        </div>
+
+        <!-- Total Diagram library -->
+        <script type="text/javascript" src="../render-node.js"></script>
+        <script type="text/javascript" src="../render-link.js"></script>
+        <script type="text/javascript" src="../manager-nodes.js"></script>
+        <script type="text/javascript" src="../manager-links.js"></script>
+        <script type="text/javascript" src="../render.js"></script>
+
+        <script>
+
+            // More advanced node definition
+
+            class NodeMoreAdvanced extends TotalDiagramNode {
+
+                constructor(args) {
+                    super(args);
+
+                    // Class
+                    this.element.classList.add('node');
+
+                    // Title bar
+                    this.titlebar = document.createElement('div');
+                    this.titlebar.classList.add('titlebar');
+                    this.titlebar.innerText = args.title || 'Node';
+                    this.element.append(this.titlebar);
+
+                    // Header
+                    this.header = document.createElement('div');
+                    this.header.classList.add('header');
+                    this.header.innerText = args.header || 'Header';
+                    this.element.append(this.header);
+
+                    // Options
+                    if ('options' in args) {
+                        args.options.forEach(text => {
+                            const option = document.createElement('div');
+                            option.classList.add('option');
+                            option.innerHTML = text;
+                            this.element.append(option);
+                        });
+                    }
+
+                    // Size
+                    this.setSize({width: 200, height: 300});
+
+                    // Update
+                    this.update();
+                }
+            }
+
+            // Default link definition
+
+            class LinkLine extends TotalDiagramLink {
+
+                constructor(args) {
+                    super(args);
+
+                    // SVG DOM element
+                    this.line = document.createElementNS('http://www.w3.org/2000/svg', 'line');
+                    this.element.appendChild(this.line);
+
+                    // Update
+                    this.update();
+                }
+
+                update() {
+                    this.line.setAttribute('x1', this.start.transform.x);
+                    this.line.setAttribute('y1', this.start.transform.y);
+                    this.line.setAttribute('x2', this.end.transform.x);
+                    this.line.setAttribute('y2', this.end.transform.y);
+                }
+
+            }
+
+            // Start
+
+            window.onload = function() {
+
+                // Create managers
+                const render = new TotalDiagramRenderHTML5({
+                    container: document.getElementById('container'),
+                    nodes: new TotalDiagramNodesManager(),
+                    links: new TotalDiagramLinksManager()
+                });
+
+                // Create first node
+                const node1 = new NodeMoreAdvanced({
+                    title: 'Node #1',
+                    header: 'Options for node 1:',
+                    options: [
+                        '<b>Option 1:</b> Hello',
+                        '<b>Option 2:</b> World',
+                        '<b>Option 3:</b> Lorem',
+                        '<b>Option 4:</b> Ipsum'
+                    ],
+                    x: -200,
+                    y: -50
+                });
+                render.nodes.add(node1);
+
+                // Create second node
+                const node2 = new NodeMoreAdvanced({
+                    title: 'Node #2',
+                    header: 'Options for node 2:',
+                    options: [
+                        '<b>Option 1:</b> Hello',
+                        '<b>Option 2:</b> World',
+                        '<b>Option 3:</b> Lorem',
+                        '<b>Option 4:</b> Ipsum'
+                    ],
+                    x: 200,
+                    y: 50
+                });
+                render.nodes.add(node2);
+
+                // Create link between them
+                const link1 = new LinkLine({
+                    start: node1,
+                    end: node2
+                });
+                render.links.add(link1);
+
+                // Move to view central 0,0
+                render.center();
+
+            };
+        </script>
+
+    </body>
+</html>

package/examples/3_link.html

@@ -0,0 +1,319 @@
+<!doctype html>
+
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>Total Diagram Demo</title>
+        <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate">
+        <meta http-equiv="Pragma" content="no-cache">
+        <meta http-equiv="Expires" content="0">
+        <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
+        <style>
+
+            html, body {
+                width: 100%;    
+                height: 100%;
+                margin: 0;
+            }
+
+            #container {
+                position: relative;
+                margin: 0 auto;
+                display: block;
+                background-color: #060531;
+                width: 100%;
+                min-width: 640px;
+                height: 100%;
+                min-height: 480px;
+                -webkit-touch-callout: none;
+                -webkit-user-select: none;
+                -khtml-user-select: none;
+                -moz-user-select: none;
+                -ms-user-select: none;
+                user-select: none;
+                touch-action: none;
+                overflow: hidden;
+                font-family: Arial, sans-serif;
+            }
+
+            h3, p {
+                color: white;
+                text-align: center;
+            }
+
+            .node {
+                display: flex;
+                flex-direction: column;
+                position: absolute;
+                background-color: white;
+                border-radius: 8px;
+                border-bottom: 10px solid #f19331;
+            }
+
+            .node .titlebar {
+                color: white;
+                background-color: #f19331;
+                width: 100%;
+                height: 35px;
+                line-height: 35px;
+                text-align: center;
+                font-size: 16px;
+                font-weight: bold;
+                border-radius: 8px 8px 0 0;
+            }
+
+            .node .header {
+                color: #222;
+                text-align: left;
+                font-size: 14px;
+                margin: 12px 16px;
+                font-weight: bold;
+            }
+
+            .node .option {
+                color: #222;
+                background-color: #fff5f5;
+                text-align: left;
+                font-size: 14px;
+                margin: 8px 16px 0 16px;
+                padding: 10px;
+                border-radius: 8px;
+            }
+
+            .socket {
+                position: absolute;
+                width: 8px;
+                height: 8px;
+                background-color: #fff5f5;
+                border: 2px solid #f19331;
+                border-radius: 50%;
+            }
+
+            .link {
+                position: absolute;
+                left: 0;
+                top: 0;
+                overflow: visible;
+                z-index: -1;
+            }
+
+            .link path {
+                pointer-events: none;
+                fill: none;
+                stroke: #e88f56;
+                stroke-width: 2;
+            }
+
+        </style>
+    </head>
+    <body>
+        <!-- Main diagram container -->
+        <div id="container">
+            <h3>3: Link demo</h3>
+            <p>How to make custom and stylized link connected to node's socket.</p>
+        </div>
+
+        <!-- Total Diagram library -->
+        <script type="text/javascript" src="../render-node.js"></script>
+        <script type="text/javascript" src="../render-link.js"></script>
+        <script type="text/javascript" src="../manager-nodes.js"></script>
+        <script type="text/javascript" src="../manager-links.js"></script>
+        <script type="text/javascript" src="../render.js"></script>
+
+        <script>
+
+            // Socket definition
+
+            class SocketPoint {
+
+                constructor(args) {
+
+                    // Store parent
+                    this.parent = args.parent;
+
+                    // Main element
+                    this.element = document.createElement('div');
+                    this.element.classList.add('socket');
+                    args.parent.element.append(this.element);
+
+                    // Position
+                    this.position = args.pos;            
+                    if ('top' in args.pos) this.element.style.top = args.pos.top + 'px';
+                    if ('left' in args.pos) this.element.style.left = args.pos.left + 'px';
+                    if ('right' in args.pos) this.element.style.right = args.pos.right + 'px';
+
+                }
+
+                getWorldPosition() {
+                    let x = 0;
+                    let y = this.parent.transform.y - (this.parent.transform.h / 2) + this.position.top + 5;
+                    if ('left' in this.position) {
+                        x = this.parent.transform.x - (this.parent.transform.w / 2) + this.position.left + 5;
+                    }
+                    else if ('right' in this.position) {
+                        x = this.parent.transform.x + (this.parent.transform.w / 2) + this.position.right + 5;
+                    }
+                    return {x, y};
+                }
+
+            }
+
+            // More advanced node definition
+
+            class NodeMoreAdvanced extends TotalDiagramNode {
+
+                constructor(args) {
+                    super(args);
+
+                    // Class
+                    this.element.classList.add('node');
+
+                    // Title bar
+                    this.titlebar = document.createElement('div');
+                    this.titlebar.classList.add('titlebar');
+                    this.titlebar.innerText = args.title || 'Node';
+                    this.element.append(this.titlebar);
+
+                    // Header
+                    this.header = document.createElement('div');
+                    this.header.classList.add('header');
+                    this.header.innerText = args.header || 'Header';
+                    this.element.append(this.header);
+
+                    // Options
+                    if ('options' in args) {
+                        args.options.forEach(text => {
+                            const option = document.createElement('div');
+                            option.classList.add('option');
+                            option.innerHTML = text;
+                            this.element.append(option);
+                        });
+                    }
+
+                    // Sockets
+                    this.socketIn = new SocketPoint({
+                        parent: this,
+                        pos: {left: -5, top: 11}
+                    });
+                    this.socketOut = new SocketPoint({
+                        parent: this,
+                        pos: {right: -5, top: 11}
+                    });
+
+                    // Size
+                    this.setSize({width: 200, height: 300});
+
+                    // Update
+                    this.update();
+                }
+            }
+
+            // Bezier curve link definition
+
+            class LinkBezier extends TotalDiagramLink {
+
+                constructor(args) {
+                    super(args);
+
+                    // SVG DOM element
+                    this.path = document.createElementNS('http://www.w3.org/2000/svg', 'path');
+                    this.element.appendChild(this.path);
+
+                    // Curvature
+                    this.curvature = 0.5;
+
+                    // Update
+                    this.update();
+                }
+
+                update() {
+
+                    // Start & end position
+                    const startPos = this.start.socketOut.getWorldPosition();
+                    const endPos = this.end.socketIn.getWorldPosition();
+                    let x1 = 0;
+                    let y1 = 0;
+                    let x2 = 0;
+                    let y2 = 0;
+
+                    // Left -> right
+                    if (this.start.transform.x <= this.end.transform.x) {
+                        x1 = startPos.x;
+                        y1 = startPos.y;
+                        x2 = endPos.x;
+                        y2 = endPos.y;
+                    }
+
+                    // Right -> left
+                    else {
+                        x1 = endPos.x;
+                        y1 = endPos.y;
+                        x2 = startPos.x;
+                        y2 = startPos.y;
+                    }
+
+                    // Calculate & render
+                    const hx1 = x1 + Math.abs(x2 - x1) * this.curvature;
+                    const hx2 = x2 - Math.abs(x2 - x1) * this.curvature;
+                    const angle = Math.atan2(y2 - y1, ((x2 + hx2) / 2) - ((x1 + hx1) / 2));
+                    this.path.setAttribute('d', `M ${x1} ${y1} C ${hx1} ${y1} ${hx2} ${y2} ${x2} ${y2}`);
+                }
+
+            }
+
+            // Start
+
+            window.onload = function() {
+
+                // Create managers
+                const render = new TotalDiagramRenderHTML5({
+                    container: document.getElementById('container'),
+                    nodes: new TotalDiagramNodesManager(),
+                    links: new TotalDiagramLinksManager()
+                });
+
+                // Create first node
+                const node1 = new NodeMoreAdvanced({
+                    title: 'Node #1',
+                    header: 'Options for node 1:',
+                    options: [
+                        '<b>Option 1:</b> Hello',
+                        '<b>Option 2:</b> World',
+                        '<b>Option 3:</b> Lorem',
+                        '<b>Option 4:</b> Ipsum'
+                    ],
+                    x: -200,
+                    y: -50
+                });
+                render.nodes.add(node1);
+
+                // Create second node
+                const node2 = new NodeMoreAdvanced({
+                    title: 'Node #2',
+                    header: 'Options for node 2:',
+                    options: [
+                        '<b>Option 1:</b> Hello',
+                        '<b>Option 2:</b> World',
+                        '<b>Option 3:</b> Lorem',
+                        '<b>Option 4:</b> Ipsum'
+                    ],
+                    x: 200,
+                    y: 50
+                });
+                render.nodes.add(node2);
+
+                // Create link between them
+                const link1 = new LinkBezier({
+                    start: node1,
+                    end: node2
+                });
+                render.links.add(link1);
+
+                // Move to view central 0,0
+                render.center();
+
+            };
+        </script>
+
+    </body>
+</html>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "total-diagram",
-	"version": "0.9.4",
+	"version": "0.9.5",
 	"description": "Simple, powerful, extensible and fast JavaScript/ES8 diagram renderer for web browsers.",
 	"license": "MIT",
 	"scripts": {