|
|
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <script>(function (i, s, o, g, r, a, m) {
- i['GoogleAnalyticsObject'] = r;
- i[r] = i[r] || function () {
- (i[r].q = i[r].q || []).push(arguments)
- }, i[r].l = 1 * new Date();
- a = s.createElement(o), m = s.getElementsByTagName(o)[0];
- a.async = 1;
- a.src = g;
- m.parentNode.insertBefore(a, m)
- })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
- ga('create', 'UA-61231638-1', 'auto');
- ga('send', 'pageview');</script>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <meta name="description" content="">
- <meta name="author" content="">
- <link rel="icon" HREF="favicon.ico">
- <title>vis.js - A dynamic, browser based visualization library.</title>
-
- <!-- Bootstrap core CSS -->
- <link href="../css/bootstrap.css" rel="stylesheet">
- <link href="../css/newdocs.css" rel="stylesheet">
-
- <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
- <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
- <![endif]-->
-
-
- <script src="../js/smooth-scroll.min.js"></script>
- <script language="JavaScript">
- smoothScroll.init();
- </script>
-
- <script type="text/javascript" src="../js/toggleTable.js"></script>
- </head>
- <!-- NAVBAR
- ================================================== -->
- <body>
-
- <div class="navbar-wrapper">
- <div class="container">
- <nav class="navbar navbar-inverse navbar-static-top" role="navigation">
- <div class="container">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"
- aria-expanded="false" aria-controls="navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- <a class="navbar-brand hidden-sm" href="./index.html">vis.js</a>
- </div>
- <div id="navbar" class="navbar-collapse collapse">
- <ul class="nav navbar-nav">
- <li><a href="../index.html#modules">Modules</a></li>
- <li class="active"><a href="./docs/index.html" target="_blank">Documentation <img class="icon"
- src="../img/external-link-icons/external-link-icon-white.png"></a>
- </li>
- <li><a href="../blog.html">Blog</a></li>
- <li><a href="../index.html#download_install">Download</a></li>
- <li><a href="../showcase/index.html">Showcase</a></li>
- <li><a href="../index.html#contribute">Contribute</a></li>
- <li><a href="../featureRequests.html">Feature requests</a></li>
- <li><a href="../index.html#licenses">License</a></li>
- </ul>
- </div>
- </div>
- </nav>
-
- </div>
- </div>
-
- <a href="https://github.com/almende/vis" class="hidden-xs hidden-sm hidden-md"><img
- style="position: absolute; top: 0; right: 0; border: 0;"
- src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67"
- alt="Fork me on GitHub"
- data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a>
-
- <div class="container full">
- <h1>Network - nodes</h1>
-
- <p>Handles the creation and deletion of nodes and contains the global node options and styles.</p>
-
- <h3>Options</h3>
-
- <p>This is a list of all the methods in the public API. They are collected here from all individual modules.</p>
- <table class="moduleTable" id="optionTable">
- <tr class="header">
- <td class="name">name</td>
- <td class="type">type</td>
- <td class="default">default</td>
- <td class="description">description</td>
- </tr>
- <tr>
- <td>borderWidth</td>
- <td class="mid">Number</td>
- <td class="mid"><code>1</code></td>
- <td>The width of the border of the node.</td>
- </tr>
- <tr>
- <td>borderWidthSelected</td>
- <td class="mid">Number</td>
- <td class="mid"><code>undefined</code></td>
- <td>The width of the border of the node when it is selected. When undefined, the borderWidth is used</td>
- </tr>
- <tr>
- <td>brokenImage</td>
- <td class="mid">String</td>
- <td class="mid"><code>undefined</code></td>
- <td>When the shape is set to <code>image</code> or <code>circularImage</code>, this option can be an URL to
- a backup image in case the URL supplied in the image option cannot be resolved.
- </td>
- </tr>
- <tr class='toggle collapsible' onclick="toggleTable('optionTable','color', this);">
- <td><span parent="color" class="right-caret"></span> color</td>
- <td class="mid">Object or String</td>
- <td class="mid"><code>Object</code></td>
- <td>The color object contains the color information of the node in every situation. When the node only needs
- a single color, a color value like <code>'rgba(120,32,14,1)'</code>, <code>'#ffffff'</code> or <code>'red'</code>
- can be supplied instead of an object.
- </td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent">color.border</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#2B7CE9'</code></td>
- <td>The color of the border of the node when it is not selected or hovered over <i>(assuming hover is
- enabled in the interaction module)</i>.
- </td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent">color.background</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#D2E5FF'</code></td>
- <td>The color of the background of the node when it is not selected or hovered over <i>(assuming hover is
- enabled in the interaction module)</i>.
- </td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent">color.highlight</td>
- <td class="mid">Object or String</td>
- <td class="mid"><code>Object</code></td>
- <td>The color the node when it is selected. Alternatively you can just supply a string color value.</td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent2">color.highlight.border</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#2B7CE9'</code></td>
- <td>The color of the border of the node when it is selected.</td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent2">color.highlight.background</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#D2E5FF'</code></td>
- <td>The color of the background of the node when it is selected.</td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent">color.hover</td>
- <td class="mid">Object or String</td>
- <td class="mid"><code>Object</code></td>
- <td>The color the node when the mouse hovers over it <i>(assuming hover is enabled in the interaction
- module)</i>. Shorthand like above is also supported.
- </td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent2">color.hover.border</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#2B7CE9'</code></td>
- <td>The color of the border of the node when the mouse hovers over it <i>(assuming hover is enabled in the
- interaction module)</i>.
- </td>
- </tr>
- <tr parent="color" class="hidden">
- <td class="indent2">color.hover.background</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#D2E5FF'</code></td>
- <td>The color of the background of the node when the mouse hovers over it <i>(assuming hover is enabled in
- the interaction module)</i>.
- </td>
- </tr>
-
- <tr class='toggle collapsible' onclick="toggleTable('optionTable','fixed', this);">
- <td><span parent="fixed" class="right-caret"></span> fixed</td>
- <td class="mid">Object or Boolean</td>
- <td class="mid"><code>Object</code></td>
- <td>When true, the node will not move but IS part of the physics simulation. When defined as an object,
- movement in either X or Y direction can be disabled.
- </td>
- </tr>
- <tr parent="fixed" class="hidden">
- <td class="indent">fixed.x</td>
- <td class="mid">Boolean</td>
- <td class="mid"><code>false</code></td>
- <td>When true, the node will not move in the X direction.</td>
- </tr>
- <tr parent="fixed" class="hidden">
- <td class="indent">fixed.y</td>
- <td class="mid">Boolean</td>
- <td class="mid"><code>false</code></td>
- <td>When true, the node will not move in the Y direction.</td>
- </tr>
- <tr class='toggle collapsible' onclick="toggleTable('optionTable','font', this);">
- <td><span parent="font" class="right-caret"></span> font</td>
- <td class="mid">Object or String</td>
- <td class="mid"><code>false</code></td>
- <td>This object defines the details of the label. A shorthand is also supported in the form <code>'size face
- color'</code> for example: <code>'14px arial red'</code>.
- </td>
- </tr>
- <tr parent="font" class="hidden">
- <td class="indent">font.color</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#343434'</code></td>
- <td>Color of the label text.</td>
- </tr>
- <tr parent="font" class="hidden">
- <td class="indent">font.size</td>
- <td class="mid">Number</td>
- <td class="mid"><code>14</code></td>
- <td>Size of the label text.</td>
- </tr>
- <tr parent="font" class="hidden">
- <td class="indent">font.face</td>
- <td class="mid">String</td>
- <td class="mid"><code>'arial'</code></td>
- <td>Font face (or font family) of the label text.</td>
- </tr>
- <tr parent="font" class="hidden">
- <td class="indent">font.background</td>
- <td class="mid">String</td>
- <td class="mid"><code>undefined</code></td>
- <td>When not <code>undefined</code> but a <b>color string</b>, a background rectangle will be drawn behind
- the label in the supplied color.
- </td>
- </tr>
- <tr parent="font" class="hidden">
- <td class="indent">font.stroke</td>
- <td class="mid">Number</td>
- <td class="mid"><code>0</code></td>
- <td>As an alternative to the background rectangle, a stroke can be drawn around the text. When a value
- higher than 0 is supplied, the stroke will be drawn.
- </td>
- </tr>
- <tr parent="font" class="hidden">
- <td class="indent">font.strokeColor</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#ffffff'</code></td>
- <td>This is the color of the stroke <i>assuming the value for stroke is higher than 0</i>.</td>
- </tr>
- <tr>
- <td>group</td>
- <td class="mid">String</td>
- <td class="mid"><code>undefined</code></td>
- <td>When not <code>undefined</code>, the</td>
- </tr>
- <tr>
- <td>hidden</td>
- <td class="mid">Boolean</td>
- <td class="mid"><code>false</code></td>
- <td>When true, the node will not be shown. It will still be part of the physics simulation though!</td>
- </tr>
- <tr class='toggle collapsible' onclick="toggleTable('optionTable','icon', this);">
- <td><span parent="icon" class="right-caret"></span> icon</td>
- <td class="mid">Object</td>
- <td class="mid"><code>Object</code></td>
- <td>These options are only used when the shape is set to <code>icon</code>.</td>
- </tr>
- <tr parent="icon" class="hidden">
- <td class="indent">icon.face</td>
- <td class="mid">String</td>
- <td class="mid"><code>'FontAwesome'</code></td>
- <td>These options are only used when the shape is set to <code>icon</code>. The possible options for the
- face are: <code>'FontAwesome'</code> and <code>'Ionicons'</code>.
- </td>
- </tr>
- <tr parent="icon" class="hidden">
- <td class="indent">icon.code</td>
- <td class="mid">String</td>
- <td class="mid"><code>undefined</code></td>
- <td>This is the code of the icon, for example <code>'\uf007'</code>.</td>
- </tr>
- <tr parent="icon" class="hidden">
- <td class="indent">icon.size</td>
- <td class="mid">Number</td>
- <td class="mid"><code>50</code></td>
- <td>The size of the icon.</td>
- </tr>
- <tr parent="icon" class="hidden">
- <td class="indent">icon.color</td>
- <td class="mid">String</td>
- <td class="mid"><code>'#2B7CE9'</code></td>
- <td>The color of the icon.</td>
- </tr>
- <tr>
- <td>image</td>
- <td class="mid">String</td>
- <td class="mid"><code>undefined</code></td>
- <td>When the shape is set to <code>image</code> or <code>circularImage</code>, this option should be the URL
- to an image. If the image cannot be found, the brokenImage option can be used.
- </td>
- </tr>
- <tr>
- <td>label</td>
- <td class="mid">String</td>
- <td class="mid"><code>undefined</code></td>
- <td>The label is the piece of text shown in or under the node, depending on the shape.</td>
- </tr>
- <tr>
- <td>level</td>
- <td class="mid">Number</td>
- <td class="mid"><code>undefined</code></td>
- <td>When using the hierarchical layout, the level determines where the node is going to be positioned.</td>
- </tr>
- <tr>
- <td>mass</td>
- <td class="mid">Number</td>
- <td class="mid"><code>1</code></td>
- <td>The barnesHut physics model (which is enabled by default) is based on an inverted gravity model. By
- increasing the mass of a node, you increase it's repulsion. Values lower than 1 are not recommended.
- </td>
- </tr>
- <tr>
- <td>physics</td>
- <td class="mid">Boolean</td>
- <td class="mid"><code>true</code></td>
- <td>When false, the node is not part of the physics simulation. It will not move except for from manual
- dragging.
- </td>
- </tr>
- <tr class='toggle collapsible' onclick="toggleTable('optionTable','scaling', this);">
- <td><span parent="scaling" class="right-caret"></span> scaling</td>
- <td class="mid">Object</td>
- <td class="mid"><code>Object</code></td>
- <td>If the <code>value</code> option is specified, the size of the nodes will be scaled according to the
- properties in this object. All node shapes can be scaled, but some only when label scaling is enabled as
- their size is based on the size of the label.
- Only scalable when label scaling is enabled are:
- <code>ellipse</code>, <code>circle</code>, <code>database</code>, <code>box</code>, <code>text</code>.
- Always scalable are:
- <code>image</code>, <code>circularImage</code>, <code>diamond</code>, <code>dot</code>,
- <code>star</code>, <code>triangle</code>, <code>triangleDown</code>, <code>square</code> and
- <code>icon</code>. Keep in mind that when using scaling, the <code>size</code> option is neglected.
- </td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent">scaling.min</td>
- <td class="mid">Number</td>
- <td class="mid"><code>10</code></td>
- <td>If nodes have a value, their sizes are determined by the value, the scaling function and the min max
- values. The min value is the minimum allowed value.
- </td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent">scaling.max</td>
- <td class="mid">Number</td>
- <td class="mid"><code>30</code></td>
- <td>This is the maximum allowed size when the nodes are scaled using the value option.</td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent">scaling.label</td>
- <td class="mid">Object or Boolean</td>
- <td class="mid"><code>Object</code></td>
- <td>This can be false if the label is not allowed to scale with the node. If true it will scale using
- default settigns. For further customization, you can supply an object.
- </td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent2">scaling.label.enabled</td>
- <td class="mid">Boolean</td>
- <td class="mid"><code>false</code></td>
- <td>Toggle the scaling of the label on or off. If this option is not defined, it is set to true if any of
- the properties in this object are defined.
- </td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent2">scaling.label.min</td>
- <td class="mid">Number</td>
- <td class="mid"><code>14</code></td>
- <td>The minimum font-size used for labels when scaling.</td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent2">scaling.label.max</td>
- <td class="mid">Number</td>
- <td class="mid"><code>30</code></td>
- <td>The maximum font-size used for labels when scaling.</td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent2">scaling.label.maxVisible</td>
- <td class="mid">Number</td>
- <td class="mid"><code>30</code></td>
- <td>When zooming in, the font is drawn larger as well. You can limit the perceived font size using this
- option. If set to 30, the font will never look larger than size 30 zoomed at 100%.
- </td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent2">scaling.label.drawThreshold</td>
- <td class="mid">Number</td>
- <td class="mid"><code>3</code></td>
- <td>When zooming out, the font will be drawn smaller. This defines a lower limit for when the font is drawn.
- When using font scaling, you can use this together with the maxVisible to first show labels of important
- nodes when zoomed out and only show the rest when zooming in.
- </td>
- </tr>
- <tr parent="scaling" class="hidden">
- <td class="indent">scaling.customScalingFunction</td>
- <td class="mid">Function</td>
- <td class="mid">in description</td>
- <td>If nodes have <code>value</code> fields, this function determines how the size of the nodes are scaled
- based on their values. The default function is:
- <pre>
- function (min,max,total,value) {
- if (max === min) {
- return 0.5;
- }
- else {
- var scale = 1 / (max - min);
- return Math.max(0,(value - min)*scale);
- }
- }
- </pre>
- The function receives the minimum value of the set, the maximum value, the total sum of all values and
- finally the value of the node or edge it works on. <b>It has to return a value between 0 and 1.</b> The
- nodes and edges then calculate their size as follows:
- <pre>
- var scale = customScalingFunction(min,max,total,value);
- var diff = maxSize - minSize;
- mySize = minSize + diff * scale;
- </pre>
- </td>
- </tr>
- <tr class='toggle collapsible' onclick="toggleTable('optionTable','shadow', this);">
- <td><span parent="shadow" class="right-caret"></span> shadow</td>
- <td class="mid">Object or Boolean</td>
- <td class="mid"><code>Object</code></td>
- <td>When true, the node casts a shadow using the default settings. This can be further refined by supplying
- an object.
- </td>
- </tr>
- <tr parent="shadow" class="hidden">
- <td class="indent">shadow.enabled</td>
- <td class="mid">Boolean</td>
- <td class="mid"><code>false</code></td>
- <td>Toggle the casting of shadows. If this option is not defined, it is set to true if any of the properties
- in this object are defined.
- </td>
- </tr>
- <tr parent="shadow" class="hidden">
- <td class="indent">shadow.size</td>
- <td class="mid">Number</td>
- <td class="mid"><code>10</code></td>
- <td>The blur size of the shadow.</td>
- </tr>
- <tr parent="shadow" class="hidden">
- <td class="indent">shadow.x</td>
- <td class="mid">Number</td>
- <td class="mid"><code>5</code></td>
- <td>The x offset.</td>
- </tr>
- <tr parent="shadow" class="hidden">
- <td class="indent">shadow.y</td>
- <td class="mid">Number</td>
- <td class="mid"><code>5</code></td>
- <td>The y offset.</td>
- </tr>
- <tr>
- <td>shape</td>
- <td class="mid">String</td>
- <td class="mid"><code>'ellipse'</code></td>
- <td>The shape defines what the node looks like. There are two types of nodes. One type has the label inside
- of it and the other type has the label underneath it. The types with the label inside of it are:
- <code>ellipse</code>, <code>circle</code>, <code>database</code>, <code>box</code>, <code>text</code>.
- The ones with the label outside of it are: <code>image</code>, <code>circularImage</code>,
- <code>diamond</code>, <code>dot</code>, <code>star</code>, <code>triangle</code>,
- <code>triangleDown</code>, <code>square</code> and <code>icon</code>.
- </td>
- </tr>
- <tr>
- <td>size</td>
- <td class="mid">Number</td>
- <td class="mid"><code>25</code></td>
- <td>The size is used to determine the size of node shapes that do not have the label inside of them. These
- shapes are: <code>image</code>, <code>circularImage</code>, <code>diamond</code>, <code>dot</code>,
- <code>star</code>, <code>triangle</code>, <code>triangleDown</code>, <code>square</code> and
- <code>icon</code></td>
- </tr>
- <tr>
- <td>title</td>
- <td class="mid">String or Element</td>
- <td class="mid"><code>undefined</code></td>
- <td>Title to be displayed when the user hovers over the node. The title can be an HTML element or a string
- containing plain text or HTML.
- </td>
- </tr>
- <tr>
- <td>value</td>
- <td class="mid">Number</td>
- <td class="mid"><code>undefined</code></td>
- <td>When a value is set, the nodes will be scaled using the options in the scaling object defined above.
- </td>
- </tr>
- <tr>
- <td>x</td>
- <td class="mid">Number</td>
- <td class="mid"><code>undefined</code></td>
- <td>This gives a node an initial x position. When using the hierarchical layout, either the x or y position
- is set by the layout engine depending on the type of view. The other value remains untouched. When using
- stabilization, the stabilized position may be different from the initial one. To lock the node to that
- position use the physics or fixed options.
- </td>
- </tr>
- <tr>
- <td>y</td>
- <td class="mid">Number</td>
- <td class="mid"><code>undefined</code></td>
- <td>This gives a node an initial y position. When using the hierarchical layout, either the x or y position
- is set by the layout engine depending on the type of view. The other value remains untouched. When using
- stabilization, the stabilized position may be different from the initial one. To lock the node to that
- position use the physics or fixed options.
- </td>
- </tr>
- </table>
-
- <h3>Methods</h3>
-
- <p>The nodes module has no methods.</p>
- <table class="moduleTable">
- <tr class="header">
- <td class="methodName">name</td>
- <td>returns</td>
- <td>description</td>
- </tr>
- <tr>
- <td>getPositions(<br> <code><i>[Array of nodeIds]</i></code><br>)</td>
- <td class="mid">Object</td>
- <td>Returns the x y positions in canvas space of the nodes with the supplied nodeIds as an object:
- <pre class="code">
- {
- nodeId1: {x: xValue, y:yValue},
- nodeId2: {x: xValue, y:yValue},
- ...
- }
- </pre>
- Alternative inputs are a String containing a nodeId or nothing. When a String is supplied, the position
- of the node corresponding to the ID is returned. When nothing is supplied, the positions of all nodes
- are returned.
- </td>
- </tr>
- <tr>
- <td>storePositions()</td>
- <td class="mid">none</td>
- <td>When using the vis.DataSet to load your nodes into the network, this method will put the X and Y
- positions of all nodes into that dataset. <br><br> If you're loading your nodes from a database and have
- this dynamically coupled with
- the DataSet, you can
- use this to stablize your network once, then save the positions in that database through the DataSet so
- the next
- time you load the nodes, stabilization will be near instantaneous.<br><br>
- If the nodes are still moving and you're using dynamic smooth edges (which is on by default), you can
- use the option <code>stabilization.onlyDynamicEdges</code> in the <a href="physics.html">physics
- module</a>
- to improve initialization time.
- </td>
-
-
- </tr>
- <tr>
- <td>getBoundingBox(<br> <code><i>String nodeId</i></code><br>)</td>
- <td class="mid">Object</td>
- <td> Returns a bounding box for the node including label in the format:
- <pre class="code">
- {
- top: Number,
- left: Number,
- right: Number,
- bottom: Number
- }
- </pre>
- These values are in canvas space.
- </td>
- </tr>
- <tr>
- <td>getConnectedNodes(<br> <code><i>String nodeId</i></code><br>)</td>
- <td class="mid">Array</td>
- <td>Returns an array of nodeIds of the all the nodes that are directly connected to this node.</td>
- </tr>
- <tr>
- <td>getEdges(<br> <code><i>String nodeId</i></code><br>)</td>
- <td class="mid">Array</td>
- <td>Returns an array of edgeIds of the edges connected to this node.</td>
- </tr>
-
-
- </table>
-
- <h3>Events</h3>
-
- <p>The nodes module emits no events. Click and select events are emitted from the interaction and selection
- modules.</p>
-
- <br/>
- <br/>
- <br/>
- <br/>
- <br/>
- <br/>
- <br/>
- </div>
-
- <!-- Bootstrap core JavaScript
- ================================================== -->
- <!-- Placed at the end of the document so the pages load faster -->
- <script src="../js/jquery.min.js"></script>
- <script src="../js/bootstrap.min.js"></script>
- <!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
- <script src="../js/ie10-viewport-bug-workaround.js"></script>
|
