gojs
Version:
Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams
224 lines (205 loc) • 10.7 kB
HTML
<html>
<head>
<meta charset="UTF-8">
<title>Data Inspector</title>
<meta name="description" content="An HTML panel that displays the properties of some model data and allows the user to edit their values." />
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- Copyright 1998-2020 by Northwoods Software Corporation. -->
<script src="../release/go.js"></script>
<script src="../assets/js/goSamples.js"></script> <!-- this is only for the GoJS Samples framework -->
<link rel='stylesheet' href='DataInspector.css' />
<script src="DataInspector.js"></script>
<script id="code">
function init() {
if (window.goSamples) goSamples(); // init for these samples -- you don't need to call this
var $ = go.GraphObject.make; // for conciseness in defining templates
myDiagram =
$(go.Diagram, "myDiagramDiv", // create a Diagram for the DIV HTML element
{
"animationManager.isEnabled": false,
// allow double-click in background to create a new node
"clickCreatingTool.archetypeNodeData": { text: "Node", color: "white" },
// allow Ctrl-G to call groupSelection()
"commandHandler.archetypeGroupData": { text: "Group", isGroup: true, color: "blue" },
// enable undo & redo
"undoManager.isEnabled": true,
// automatically show the state of the diagram's model on the page
"ModelChanged": function(e) {
if (e.isTransactionFinished) {
document.getElementById("savedModel").textContent = myDiagram.model.toJson();
}
}
});
// These nodes have text surrounded by a rounded rectangle
// whose fill color is bound to the node data.
// The user can drag a node by dragging its TextBlock label.
// Dragging from the Shape will start drawing a new link.
myDiagram.nodeTemplate =
$(go.Node, "Auto",
{ locationSpot: go.Spot.Center },
new go.Binding("location", "loc", go.Point.parse).makeTwoWay(go.Point.stringify),
$(go.Shape, "Rectangle",
{
stroke: null, strokeWidth: 0,
fill: "white", // the default fill, if there is no data-binding
portId: "", cursor: "pointer", // the Shape is the port, not the whole Node
// allow all kinds of links from and to this port
fromLinkable: true, fromLinkableSelfNode: true, fromLinkableDuplicates: true,
toLinkable: true, toLinkableSelfNode: true, toLinkableDuplicates: true
},
new go.Binding("fill", "color")),
$(go.TextBlock,
{
font: "bold 18px sans-serif",
stroke: '#111',
margin: 8, // make some extra space for the shape around the text
isMultiline: false, // don't allow newlines in text
editable: true // allow in-place editing by user
},
new go.Binding("text", "text").makeTwoWay())
);
// The link shape and arrowhead have their stroke brush data bound to the "color" property
myDiagram.linkTemplate =
$(go.Link,
{ toShortLength: 3, relinkableFrom: true, relinkableTo: true }, // allow the user to relink existing links
$(go.Shape,
{ strokeWidth: 2 },
new go.Binding("stroke", "color")),
$(go.Shape,
{ toArrow: "Standard", stroke: null },
new go.Binding("fill", "color"))
);
// Groups consist of a title in the color given by the group node data
// above a translucent gray rectangle surrounding the member parts
myDiagram.groupTemplate =
$(go.Group, "Vertical",
{
selectionObjectName: "PANEL", // selection handle goes around shape, not label
ungroupable: true
}, // enable Ctrl-Shift-G to ungroup a selected Group
$(go.TextBlock,
{
font: "bold 19px sans-serif",
isMultiline: false, // don't allow newlines in text
editable: true // allow in-place editing by user
},
new go.Binding("text", "text").makeTwoWay(),
new go.Binding("stroke", "color")),
$(go.Panel, "Auto",
{ name: "PANEL" },
$(go.Shape, "Rectangle", // the rectangular shape around the members
{ fill: "rgba(128,128,128,0.2)", stroke: "gray", strokeWidth: 3 }),
$(go.Placeholder, { padding: 10 }) // represents where the members are
)
);
// Create the Diagram's Model:
var nodeDataArray = [
{ key: 1, text: "Alpha", color: "#B2DFDB", state: "one" },
{ key: 2, text: "Beta", color: "#B2B2DB", state: "two", password: "1234" },
{ key: 3, text: "Gamma", color: "#1DE9B6", state: 2, group: 5, flag: false, choices: [1, 2, 3, 4, 5] },
{ key: 4, text: "Delta", color: "#00BFA5", state: "three", group: 5, flag: true },
{ key: 5, text: "Epsilon", color: "#00BFA5", isGroup: true }
];
var linkDataArray = [
{ from: 1, to: 2, color: "#5E35B1" },
{ from: 2, to: 2, color: "#5E35B1" },
{ from: 3, to: 4, color: "#6200EA" },
{ from: 3, to: 1, color: "#6200EA" }
];
myDiagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
// some shared model data
myDiagram.model.modelData = { test: true, hello: "world", version: 42 };
// select a Node, so that the first Inspector shows something
myDiagram.select(myDiagram.nodes.first());
// Declare which properties to show and how.
// By default, all properties on the model data objects are shown unless the inspector option "includesOwnProperties" is set to false.
// Show the primary selection's data, or blanks if no Part is selected:
var inspector = new Inspector('myInspectorDiv', myDiagram,
{
// allows for multiple nodes to be inspected at once
multipleSelection: true,
// max number of node properties will be shown when multiple selection is true
showSize: 4,
// when multipleSelection is true, when showAllProperties is true it takes the union of properties
// otherwise it takes the intersection of properties
showAllProperties: true,
// uncomment this line to only inspect the named properties below instead of all properties on each object:
// includesOwnProperties: false,
properties: {
"text": {},
// key would be automatically added for nodes, but we want to declare it read-only also:
"key": { readOnly: true, show: Inspector.showIfPresent },
// color would be automatically added for nodes, but we want to declare it a color also:
"color": { show: Inspector.showIfPresent, type: 'color' },
// Comments and LinkComments are not in any node or link data (yet), so we add them here:
"Comments": { show: Inspector.showIfNode },
"LinkComments": { show: Inspector.showIfLink },
"isGroup": { readOnly: true, show: Inspector.showIfPresent },
"flag": { show: Inspector.showIfNode, type: 'checkbox' },
"state": {
show: Inspector.showIfNode,
type: "select",
choices: function(node, propName) {
if (Array.isArray(node.data.choices)) return node.data.choices;
return ["one", "two", "three", "four", "five"];
}
},
"choices": { show: false }, // must not be shown at all
// an example of specifying the <input> type
"password": { show: Inspector.showIfPresent, type: 'password' }
}
});
// Always show the first Node:
var inspector2 = new Inspector('myInspectorDiv2', myDiagram,
{
// By default the inspector works on the Diagram selection.
// This property lets us inspect a specific object by calling Inspector.inspectObject.
inspectSelection: false,
properties: {
"text": {},
// This property we want to declare as a color, to show a color-picker:
"color": { type: 'color' },
// key would be automatically added for node data, but we want to declare it read-only also:
"key": { readOnly: true, show: Inspector.showIfPresent }
}
});
// If not inspecting a selection, you can programatically decide what to inspect (a Part, or a JavaScript object)
inspector2.inspectObject(myDiagram.nodes.first().data);
// Always show the model.modelData:
var inspector3 = new Inspector('myInspectorDiv3', myDiagram,
{
inspectSelection: false
});
inspector3.inspectObject(myDiagram.model.modelData);
}
</script>
</head>
<body onload="init()">
<div id="sample">
<span style="display: inline-block; vertical-align: top;">
<div style="margin-left: 10px;">
<div id="myDiagramDiv" style="border: solid 1px black; width:400px; height:400px;"></div>
</div>
</span>
<span style="display: inline-block; vertical-align: top;">
Selected Part:<br/>
<div id="myInspectorDiv" class="inspector"> </div><br/>
First Node's data:<br />
<div id="myInspectorDiv2" class="inspector"> </div><br />
Model.modelData:<br />
<div id="myInspectorDiv3" class="inspector"> </div><br />
</span>
<div>
<p>An HTML-based inspector that displays and allows editing of data for the selected Part (if any),
or for a particular JavaScript object, or for the shared <a>Model.modelData</a> object,
which exists even if there are no nodes or links.
<p>The inspector code lies in <a href="DataInspector.js">DataInspector.js</a> and <a href="DataInspector.css">DataInspector.css</a>. This code is meant to be a starting point for making your own model data inspector.
<p>On browsers that support it, color types display a color picker. There are various plugins and polyfills for this functionaltiy if you wish to extend the data inspector.
<p>
This shows the contents of the model after each transaction:
<pre id="savedModel" />
</div>
</div>
</body>
</html>