create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
343 lines (307 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="All predefined GoJS Shape figures, displayed as Nodes with a name underneath." />
<meta itemprop="description" content="All predefined GoJS Shape figures, displayed as Nodes with a name underneath." />
<meta property="og:description" content="All predefined GoJS Shape figures, displayed as Nodes with a name underneath." />
<meta name="twitter:description" content="All predefined GoJS Shape figures, displayed as Nodes with a name underneath." />
<link rel="preconnect" href="https://rsms.me/">
<link rel="stylesheet" href="../assets/css/style.css">
<!-- Copyright 1998-2025 by Northwoods Software Corporation. -->
<meta itemprop="name" content="Parameterized Shape Figures, both Built-in and Extensions" />
<meta property="og:title" content="Parameterized Shape Figures, both Built-in and Extensions" />
<meta name="twitter:title" content="Parameterized Shape Figures, both Built-in and Extensions" />
<meta property="og:image" content="https://gojs.net/latest/assets/images/screenshots/shapes.png" />
<meta itemprop="image" content="https://gojs.net/latest/assets/images/screenshots/shapes.png" />
<meta name="twitter:image" content="https://gojs.net/latest/assets/images/screenshots/shapes.png" />
<meta property="og:url" content="https://gojs.net/latest/samples/shapes.html" />
<meta property="twitter:url" content="https://gojs.net/latest/samples/shapes.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
Parameterized Shape Figures, both Built-in and Extensions | GoJS Diagramming Library
</title>
</head>
<body>
<!-- This top nav is not part of the sample code -->
<nav id="navTop" class=" w-full h-[var(--topnav-h)] z-30 bg-white border-b border-b-gray-200">
<div class="max-w-screen-xl mx-auto flex flex-wrap items-start justify-between px-4">
<a class="text-white bg-nwoods-primary font-bold !leading-[calc(var(--topnav-h)_-_1px)] my-0 px-2 text-4xl lg:text-5xl logo"
href="../">
GoJS
</a>
<div class="relative">
<button id="topnavButton" class="h-[calc(var(--topnav-h)_-_1px)] px-2 m-0 text-gray-900 bg-inherit shadow-none md:hidden hover:!bg-inherit hover:!text-nwoods-accent hover:!shadow-none" aria-label="Navigation">
<svg class="h-7 w-7 block" aria-hidden="true" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24">
<path d="M3.75 6.75h16.5M3.75 12h16.5m-16.5 5.25h16.5" stroke-linecap="round" stroke-linejoin="round"/>
</svg>
</button>
<div id="topnavList" class="hidden md:block">
<div class="absolute right-0 z-30 flex flex-col items-end rounded border border-gray-200 p-4 pl-12 shadow bg-white text-gray-900 font-semibold
md:flex-row md:space-x-4 md:items-start md:border-0 md:p-0 md:shadow-none md:bg-inherit">
<a href="../learn/">Learn</a>
<a href="../samples/">Samples</a>
<a href="../intro/">Intro</a>
<a href="../api/">API</a>
<a href="../download.html">Download</a>
<a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a>
<a id="tc" href="https://nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/contact.html', 'contact');">Contact</a>
<a id="tb" href="https://nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/sales/index.html', 'buy');">Buy</a>
</div>
</div>
</div>
</div>
</nav>
<script>
window.addEventListener("DOMContentLoaded", function () {
// topnav
var topButton = document.getElementById("topnavButton");
var topnavList = document.getElementById("topnavList");
if (topButton && topnavList) {
topButton.addEventListener("click", function (e) {
topnavList
.classList
.toggle("hidden");
e.stopPropagation();
});
document.addEventListener("click", function (e) {
// if the clicked element isn't the list, close the list
if (!topnavList.classList.contains("hidden") && !e.target.closest("#topnavList")) {
topButton.click();
}
});
// set active <a> element
var url = window
.location
.href
.toLowerCase();
var aTags = topnavList.getElementsByTagName('a');
for (var i = 0; i < aTags.length; i++) {
var lowerhref = aTags[i]
.href
.toLowerCase();
if (lowerhref.endsWith('.html'))
lowerhref = lowerhref.slice(0, -5);
if (url.startsWith(lowerhref)) {
aTags[i]
.classList
.add('active');
break;
}
}
}
});
</script>
<div class="flex flex-col prose">
<div class="w-full max-w-screen-xl mx-auto">
<!-- * * * * * * * * * * * * * -->
<!-- Start of GoJS sample code -->
<script src="https://cdn.jsdelivr.net/npm/gojs@3.1.0"></script>
<div id="allSampleContent" class="p-4 w-full">
<script src="../extensions/Figures.js"></script>
<script id="code">
function init() {
myDiagram = new go.Diagram('myDiagramDiv', {
layout: new go.GridLayout({
cellSize: new go.Size(1, 1),
sorting: go.GridSorting.Forwards
}), // use a GridLayout
padding: new go.Margin(5, 5, 25, 5) // to see the names of shapes on the bottom row
});
// Names of the built in shapes, which we will color green instead of pink.
// The pink shapes are instead defined in the "../extensions/Figures.js" file.
var builtIn = [
'Rectangle',
'Square',
'RoundedRectangle',
'RoundedTopRectangle',
'RoundedBottomRectangle',
'RoundedLeftRectangle',
'RoundedRightRectangle',
'Border',
'Ellipse',
'Circle',
'TriangleRight',
'TriangleDown',
'TriangleLeft',
'TriangleUp',
'Triangle',
'Diamond',
'LineH',
'LineV',
'None',
'BarH',
'BarV',
'MinusLine',
'PlusLine',
'XLine',
'LineRight',
'LineDown',
'LineLeft',
'LineUp',
'Capsule',
'Borders'
];
function isBuiltIn(shapeName) {
return builtIn.indexOf(shapeName) >= 0;
}
myDiagram.nodeTemplate =
new go.Node('Vertical', {
mouseEnter: (e, node) => (node.isHighlighted = true),
mouseLeave: (e, node) => (node.isHighlighted = false),
locationSpot: go.Spot.Center, // the location is the center of the Shape
locationObjectName: 'SHAPE',
selectionAdorned: false, // no selection handle when selected
resizable: true,
resizeObjectName: 'SHAPE', // user can resize the Shape
rotatable: true,
rotateObjectName: 'SHAPE', // rotate the Shape without rotating the label
// don't re-layout when node changes size
layoutConditions: go.LayoutConditions.Standard & ~go.LayoutConditions.NodeSized
})
.bindObject('layerName', 'isHighlighted', h => h ? 'Foreground' : '')
.add(
new go.Shape({
name: 'SHAPE', // named so that the above properties can refer to this GraphObject
width: 70,
height: 70,
strokeWidth: 3
})
// Color the built in shapes green, and the figures.js shapes Pink
.bind('fill', 'key', k => isBuiltIn(k) ? 'palegreen' : 'lightpink')
.bind('stroke', 'key', k => isBuiltIn(k) ? 'darkgreen' : '#C2185B')
// bind the Shape.figure to the figure name, which automatically gives the Shape a Geometry
.bind('figure', 'key'),
new go.TextBlock({ // the label
margin: 4,
font: 'bold 18px sans-serif',
background: 'white'
})
.bindObject('visible', 'isHighlighted')
.bind('text', 'key')
);
// initialize the model
myDiagram.model.nodeDataArray = go.Shape.getFigureGenerators().toArray();
myDiagram2 = new go.Diagram('myDiagramDiv2', {
layout: new go.GridLayout({ sorting: go.GridSorting.Forwards }) // use a GridLayout
});
myDiagram2.nodeTemplate =
new go.Node('Vertical')
.add(
new go.Shape('RoundedRectangle', {
width: 50,
height: 50,
strokeWidth: 2,
fill: 'palegreen',
stroke: 'darkgreen',
parameter1: 30
})
.bind('parameter1')
.bind('parameter2')
)
.add(
new go.TextBlock({ margin: 12, font: 'bold 12px monospace' })
.bind('text', 'text', val => 'parameter2: ' + val)
);
myDiagram2.model.nodeDataArray = [
{ parameter2: 1 | 2, text: '1 | 2' },
{ parameter2: 4 | 8, text: '4 | 8' },
{ parameter2: 2 | 4, text: '2 | 4' },
{ parameter2: 1 | 8, text: '1 | 8' }
];
}
window.addEventListener('DOMContentLoaded', init);
</script>
<div id="sample">
<div id="myDiagramDiv" style="height: 600px;background-color: #ffffff;" class="border border-black border-solid"></div>
<p>
This sample showcases all predefined <b>GoJS</b> figures. This sample also makes use of
<a href="../intro/highlighting.html">GoJS Highlighting</a> data bindings: Mouse-hover over a
shape to see its name.
</p>
<p>
You can specify a predefined geometry for a <a>Shape</a> by setting its <a>Shape.figure</a>.
</p>
<p>
In order to reduce the size of the GoJS library, most predefined figures are in the
<a href="../extensions/Figures.js" target="_blank">Figures.js</a> file. You can load this file
or simply load only those figures that you want to use by copying their definitions into your
code.
</p>
<p>
A number of very common figures are predefined in go.js:
<code
>"Rectangle", "Square", "RoundedRectangle", "RoundedTopRectangle", "RoundedBottomRectangle",
"RoundedLeftRectangle", "RoundedRightRectangle", "Border", "Ellipse", "Circle",
"TriangleRight", "TriangleDown", "TriangleLeft", "TriangleUp", "Triangle", "Diamond", "LineH",
"LineV", "None", "BarH", "BarV", "MinusLine", "PlusLine", "XLine", "LineRight", "LineDown",
"LineLeft", "LineUp", "Capsule"</code
>. These figures are filled green above, instead of pink.
</p>
<p>
With GoJS you can also define your own custom shapes with SVG-like path syntax, see the
<a href="icons.html">SVG icons</a> sample for examples or the
<a href="../intro/geometry.html">Geometry Path Strings intro page</a> to learn more.
</p>
<p>For predefined arrowheads, see the <a href="arrowheads.html">Arrowheads</a> sample.</p>
<p>
For the "RoundedRectangle" figure, you can set the <a>Shape.parameter1</a> and
<a>Shape.parameter2</a>
values to modify the corner radius and which corners are rounded, respectively.
</p>
<p>
<code>parameter2</code> is a number that is specified by four bit flags (1, 2, 4, 8), describing
the top-left, top-right, bottom-right, and bottom-left corners respectively. The flags can be
defined to specify which corners to round:
</p>
<div id="myDiagramDiv2" style="border: solid 1px black; height: 130px"></div>
</div>
</div>
<!-- * * * * * * * * * * * * * -->
<!-- End of GoJS sample code -->
</div>
<div id="allTagDescriptions" class="p-4 w-full max-w-screen-xl mx-auto">
<hr/>
<h3 class="text-xl">GoJS Features in this sample</h3>
<!-- blacklist tags that do not correspond to a specific GoJS feature -->
<h4>Grid Layouts</h4>
<p>
This predefined layout is used for placing Nodes in a grid-like arrangement.
Nodes can be ordered, spaced apart, and wrapped as needed. This Layout ignores any Links connecting the nodes being laid out.
More information can be found in the <a href="../intro/layouts.html#GridLayout">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#gridlayout">Related samples</a>
</p>
<hr>
<!-- blacklist tags that do not correspond to a specific GoJS feature -->
<h4>Geometry Path Strings</h4>
<p>
The <b>GoJS</b> <a href="../api/symbols/Geometry.html" target="api">Geometry</a> class controls the "shape" of a <a href="../api/symbols/Shape.html" target="api">Shape</a>,
whereas the <a href="../api/symbols/Shape.html#fill" target="api">Shape.fill</a> and <a href="../api/symbols/Shape.html#stroke" target="api">Shape.stroke</a> and other shape properties control the colors and appearance of the shape.
For common shape figures, there are predefined geometries that can be used by setting <a href="../api/symbols/Shape.html#figure" target="api">Shape.figure</a>.
However one can also define custom geometries.
</p>
<p>
One can construct any Geometry by allocating and initializing a <a href="../api/symbols/Geometry.html" target="api">Geometry</a> of at least one <a href="../api/symbols/PathFigure.html" target="api">PathFigure</a> holding some <a href="../api/symbols/PathSegment.html" target="api">PathSegment</a>s.
But you may find that using the string representation of a Geometry is easier to write and save in a database.
Use the static method <a href="../api/symbols/Geometry.html#parse" target="api">Geometry.parse</a> or the <a href="../api/symbols/Shape.html#geometryString" target="api">Shape.geometryString</a> property to transform a geometry path string into a <a href="../api/symbols/Geometry.html" target="api">Geometry</a> object.
</p>
<p>
More information can be found in the <a href="../intro/geometry.html">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#geometries">Related samples</a>
</p>
<hr>
</div>
</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>