You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

81 lines
20 KiB
HTML

4 years ago
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Node & Link Attributes - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Tutorials</li><li class="nav-item"><a href="tutorial-1-getting-started.html">Getting Started</a></li><li class="nav-item"><a href="tutorial-2-node-and-link-attributes.html">Node & Link Attributes</a></li><li class="nav-item"><a href="tutorial-3-included-sample-data.html">Included Sample Data</a></li><li class="nav-item"><a href="tutorial-4-example-queries.html">Example Queries</a></li><li class="nav-item"><a href="tutorial-5-special-use-cases.html">Special Use Cases</a></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-API.html">API</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.alignFixedNodesToGrid">alignFixedNodesToGrid</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.autoRefresh">autoRefresh</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.center">center</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.centerPositionGraph">centerPositionGraph</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.centerPositionViewport">centerPositionViewport</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.charge">charge</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.chargeDistance">chargeDistance</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.colorScheme">colorScheme</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.customize">customize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.data">data</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.debug">debug</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.domParentWidth">domParentWidth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.dragMode">dragMode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.forceTimeLimit">forceTimeLimit</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.friction">friction</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.gravity">gravity</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.gridSize">gridSize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.height">height</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.inspect">inspect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-API.html#.keepAspectRatioOnResize">keepAspectRatioOnResize</a></span></li><li class="nav-item"><span class
</nav>
<div id="main">
<h1 class="page-title">Node & Link Attributes</h1>
<section>
<header>
</header>
<article>
<p>Node and link attributes are case sensitive:</p>
<h2>Nodes</h2><ul>
<li><code>ID</code>: mandatory, string, alphanumeric node identifier</li>
<li><code>SIZEVALUE</code>: mandatory, number, numeric base for radius calculation</li>
<li><code>COLORVALUE</code>: mandatory, string, HTML color code or any alphanumeric string - see also <a href="./module-API.html#.colorScheme">colorScheme</a></li>
<li><code>COLORLABEL</code>: optional, string, used for legend - if not existing, colorvalue is used instead</li>
<li><code>LABEL</code>: optional, string, label for the node</li>
<li><code>LABELCIRCULAR</code>: optional, boolean, overwrites the global option <a href="./module-API.html#.labelsCircular">labelsCircular</a></li>
<li><code>INFOSTRING</code>: optional, string, this string is shown as a tooltip - see also <a href="./module-API.html#.showTooltips">showTooltips</a> and <a href="./module-API.html#.tooltipPosition">tooltipPosition</a></li>
<li><code>LINK</code>: optional, string, URL to open on configurable event - see also <a href="./module-API.html#.nodeEventToOpenLink">nodeEventToOpenLink</a></li>
<li><code>IMAGE</code>: optional, string, URL to a background image for a node instead of a fill color</li>
<li><code>fixed</code>: optional, boolean, pin status of a node</li>
<li><code>x</code>: optional, number, x position of fixed (pinned) node</li>
<li><code>y</code>: optional, number, y position of fixed (pinned) node</li>
</ul>
<p>Fixed, x and y are native D3 attributes - they must be lowercase.</p>
<h2>Links</h2><ul>
<li><code>FROMID</code>: mandatory, string, id of node, where a link starts (links are able to showing directions, see also <a href="./module-API.html#.showLinkDirection">showLinkDirection</a>)</li>
<li><code>TOID</code>: mandatory, string, id of node, where a link ends</li>
<li><code>STYLE</code>: optional, string, can be <code>solid</code> (default), <code>dotted</code> or <code>dashed</code></li>
<li><code>COLOR</code>: optional, string, must be a HTML color code like <code>green</code> or <code>#00ff00</code></li>
<li><code>LABEL</code>: optional, string, label for the link</li>
<li><code>INFOSTRING</code>: optional, string, this string is shown as a tooltip - see also <a href="./module-API.html#.showTooltips">showTooltips</a> and <a href="./module-API.html#.tooltipPosition">tooltipPosition</a></li>
</ul>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Apr 28 2019 15:36:35 GMT+0200 (Mitteleuropäische Sommerzeit) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>