gojs
Version:
Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams
328 lines (312 loc) • 14.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>
<meta name="description" content="UML Class-like nodes showing two collapsible lists of items."/>
<link rel="stylesheet" href="../assets/css/style.css"/>
<!-- Copyright 1998-2023 by Northwoods Software Corporation. -->
<title>UML Class Nodes</title>
</head>
<body>
<!-- This top nav is not part of the sample code -->
<nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary">
<div class="w-full container max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2">
<div class="md:pl-4">
<a class="text-white hover:text-white no-underline hover:no-underline
font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../">
<h1 class="my-0 p-1 ">GoJS</h1>
</a>
</div>
<button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation">
<svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
<path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>
<path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>
</svg>
</button>
<div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">
<ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">
<li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li>
</ul>
</div>
</div>
<hr class="border-b border-gray-600 opacity-50 my-0 py-0" />
</nav>
<div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">
<div id="navSide" class="flex flex-col w-full md:w-48 text-gray-700 bg-white flex-shrink-0"></div>
<!-- * * * * * * * * * * * * * -->
<!-- Start of GoJS sample code -->
<script src="../release/go.js"></script>
<div id="allSampleContent" class="p-4 w-full">
<script id="code">
function init() {
// Since 2.2 you can also author concise templates with method chaining instead of GraphObject.make
// For details, see https://gojs.net/latest/intro/buildingObjects.html
const $ = go.GraphObject.make;
myDiagram =
new go.Diagram("myDiagramDiv",
{
"undoManager.isEnabled": true,
layout: $(go.TreeLayout,
{ // this only lays out in trees nodes connected by "generalization" links
angle: 90,
path: go.TreeLayout.PathSource, // links go from child to parent
setsPortSpot: false, // keep Spot.AllSides for link connection spot
setsChildPortSpot: false, // keep Spot.AllSides
// nodes not connected by "generalization" links are laid out horizontally
arrangement: go.TreeLayout.ArrangementHorizontal
})
});
// show visibility or access as a single character at the beginning of each property or method
function convertVisibility(v) {
switch (v) {
case "public": return "+";
case "private": return "-";
case "protected": return "#";
case "package": return "~";
default: return v;
}
}
// the item template for properties
var propertyTemplate =
$(go.Panel, "Horizontal",
// property visibility/access
$(go.TextBlock,
{ isMultiline: false, editable: false, width: 12 },
new go.Binding("text", "visibility", convertVisibility)),
// property name, underlined if scope=="class" to indicate static property
$(go.TextBlock,
{ isMultiline: false, editable: true },
new go.Binding("text", "name").makeTwoWay(),
new go.Binding("isUnderline", "scope", s => s[0] === 'c')),
// property type, if known
$(go.TextBlock, "",
new go.Binding("text", "type", t => t ? ": " : "")),
$(go.TextBlock,
{ isMultiline: false, editable: true },
new go.Binding("text", "type").makeTwoWay()),
// property default value, if any
$(go.TextBlock,
{ isMultiline: false, editable: false },
new go.Binding("text", "default", s => s ? " = " + s : ""))
);
// the item template for methods
var methodTemplate =
$(go.Panel, "Horizontal",
// method visibility/access
$(go.TextBlock,
{ isMultiline: false, editable: false, width: 12 },
new go.Binding("text", "visibility", convertVisibility)),
// method name, underlined if scope=="class" to indicate static method
$(go.TextBlock,
{ isMultiline: false, editable: true },
new go.Binding("text", "name").makeTwoWay(),
new go.Binding("isUnderline", "scope", s => s[0] === 'c')),
// method parameters
$(go.TextBlock, "()",
// this does not permit adding/editing/removing of parameters via inplace edits
new go.Binding("text", "parameters", parr => {
var s = "(";
for (var i = 0; i < parr.length; i++) {
var param = parr[i];
if (i > 0) s += ", ";
s += param.name + ": " + param.type;
}
return s + ")";
})),
// method return type, if any
$(go.TextBlock, "",
new go.Binding("text", "type", t => t ? ": " : "")),
$(go.TextBlock,
{ isMultiline: false, editable: true },
new go.Binding("text", "type").makeTwoWay())
);
// this simple template does not have any buttons to permit adding or
// removing properties or methods, but it could!
myDiagram.nodeTemplate =
$(go.Node, "Auto",
{
locationSpot: go.Spot.Center,
fromSpot: go.Spot.AllSides,
toSpot: go.Spot.AllSides
},
$(go.Shape, { fill: "lightyellow" }),
$(go.Panel, "Table",
{ defaultRowSeparatorStroke: "black" },
// header
$(go.TextBlock,
{
row: 0, columnSpan: 2, margin: 3, alignment: go.Spot.Center,
font: "bold 12pt sans-serif",
isMultiline: false, editable: true
},
new go.Binding("text", "name").makeTwoWay()),
// properties
$(go.TextBlock, "Properties",
{ row: 1, font: "italic 10pt sans-serif" },
new go.Binding("visible", "visible", v => !v).ofObject("PROPERTIES")),
$(go.Panel, "Vertical", { name: "PROPERTIES" },
new go.Binding("itemArray", "properties"),
{
row: 1, margin: 3, stretch: go.GraphObject.Fill,
defaultAlignment: go.Spot.Left, background: "lightyellow",
itemTemplate: propertyTemplate
}
),
$("PanelExpanderButton", "PROPERTIES",
{ row: 1, column: 1, alignment: go.Spot.TopRight, visible: false },
new go.Binding("visible", "properties", arr => arr.length > 0)),
// methods
$(go.TextBlock, "Methods",
{ row: 2, font: "italic 10pt sans-serif" },
new go.Binding("visible", "visible", v => !v).ofObject("METHODS")),
$(go.Panel, "Vertical", { name: "METHODS" },
new go.Binding("itemArray", "methods"),
{
row: 2, margin: 3, stretch: go.GraphObject.Fill,
defaultAlignment: go.Spot.Left, background: "lightyellow",
itemTemplate: methodTemplate
}
),
$("PanelExpanderButton", "METHODS",
{ row: 2, column: 1, alignment: go.Spot.TopRight, visible: false },
new go.Binding("visible", "methods", arr => arr.length > 0))
)
);
function convertIsTreeLink(r) {
return r === "generalization";
}
function convertFromArrow(r) {
switch (r) {
case "generalization": return "";
default: return "";
}
}
function convertToArrow(r) {
switch (r) {
case "generalization": return "Triangle";
case "aggregation": return "StretchedDiamond";
default: return "";
}
}
myDiagram.linkTemplate =
$(go.Link,
{ routing: go.Link.Orthogonal },
new go.Binding("isLayoutPositioned", "relationship", convertIsTreeLink),
$(go.Shape),
$(go.Shape, { scale: 1.3, fill: "white" },
new go.Binding("fromArrow", "relationship", convertFromArrow)),
$(go.Shape, { scale: 1.3, fill: "white" },
new go.Binding("toArrow", "relationship", convertToArrow))
);
// setup a few example class nodes and relationships
var nodedata = [
{
key: 1,
name: "BankAccount",
properties: [
{ name: "owner", type: "String", visibility: "public" },
{ name: "balance", type: "Currency", visibility: "public", default: "0" }
],
methods: [
{ name: "deposit", parameters: [{ name: "amount", type: "Currency" }], visibility: "public" },
{ name: "withdraw", parameters: [{ name: "amount", type: "Currency" }], visibility: "public" }
]
},
{
key: 11,
name: "Person",
properties: [
{ name: "name", type: "String", visibility: "public" },
{ name: "birth", type: "Date", visibility: "protected" }
],
methods: [
{ name: "getCurrentAge", type: "int", visibility: "public" }
]
},
{
key: 12,
name: "Student",
properties: [
{ name: "classes", type: "List<Course>", visibility: "public" }
],
methods: [
{ name: "attend", parameters: [{ name: "class", type: "Course" }], visibility: "private" },
{ name: "sleep", visibility: "private" }
]
},
{
key: 13,
name: "Professor",
properties: [
{ name: "classes", type: "List<Course>", visibility: "public" }
],
methods: [
{ name: "teach", parameters: [{ name: "class", type: "Course" }], visibility: "private" }
]
},
{
key: 14,
name: "Course",
properties: [
{ name: "name", type: "String", visibility: "public" },
{ name: "description", type: "String", visibility: "public" },
{ name: "professor", type: "Professor", visibility: "public" },
{ name: "location", type: "String", visibility: "public" },
{ name: "times", type: "List<Time>", visibility: "public" },
{ name: "prerequisites", type: "List<Course>", visibility: "public" },
{ name: "students", type: "List<Student>", visibility: "public" }
]
}
];
var linkdata = [
{ from: 12, to: 11, relationship: "generalization" },
{ from: 13, to: 11, relationship: "generalization" },
{ from: 14, to: 13, relationship: "aggregation" }
];
myDiagram.model = new go.GraphLinksModel(
{
copiesArrays: true,
copiesArrayObjects: true,
nodeDataArray: nodedata,
linkDataArray: linkdata
});
}
window.addEventListener('DOMContentLoaded', init);
</script>
<div id="sample">
<div id="myDiagramDiv" style="border: solid 1px black; width:100%; height:600px"></div>
<p>
This sample demonstrates one way of defining a UML (Unified Modeling Language) Class Diagram.
Note the use of a separate Panel for the properties and one for the methods,
allowing for an item template for properties and a separate item template for methods. <a href="../intro/buttons.html#panelExpanderButton"
target="_blank">PanelExpanderButton</a>s are used to hide/show class properties and methods.
</p>
<p>
In this example, symbol prefixes indicate the visibility of methods and properties. The three possibilities are:
<ul>
<li>+ (Public)</li>
<li>- (Private)</li>
<li># (Protected)</li>
</ul>
Additionally, the ~ symbol is used to indicate an item is a package.
</p>
</div>
</div>
<!-- * * * * * * * * * * * * * -->
<!-- End of GoJS sample code -->
</div>
</body>
<!-- This script is part of the gojs.net website, and is not needed to run the sample -->
<script src="../assets/js/goSamples.js"></script>
</html>