vis.js is a dynamic, browser-based visualization library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

214 lines
8.8 KiB

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <script>(function (i, s, o, g, r, a, m) {
  5. i['GoogleAnalyticsObject'] = r;
  6. i[r] = i[r] || function () {
  7. (i[r].q = i[r].q || []).push(arguments)
  8. }, i[r].l = 1 * new Date();
  9. a = s.createElement(o), m = s.getElementsByTagName(o)[0];
  10. a.async = 1;
  11. a.src = g;
  12. m.parentNode.insertBefore(a, m)
  13. })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
  14. ga('create', 'UA-61231638-1', 'auto');
  15. ga('send', 'pageview');</script>
  16. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  17. <meta charset="utf-8">
  18. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  19. <meta name="viewport" content="width=device-width, initial-scale=1">
  20. <meta name="description" content="">
  21. <meta name="author" content="">
  22. <link rel="icon" HREF="favicon.ico">
  23. <title>vis.js - A dynamic, browser based visualization library.</title>
  24. <!-- Bootstrap core CSS -->
  25. <link href="../css/bootstrap.css" rel="stylesheet">
  26. <link href="../css/newdocs.css" rel="stylesheet">
  27. <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  28. <!--[if lt IE 9]>
  29. <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  30. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  31. <![endif]-->
  32. <script src="../js/smooth-scroll.min.js"></script>
  33. <script language="JavaScript">
  34. smoothScroll.init();
  35. </script>
  36. <style>
  37. </style>
  38. </head>
  39. <!-- NAVBAR
  40. ================================================== -->
  41. <body>
  42. <div class="navbar-wrapper">
  43. <div class="container">
  44. <nav class="navbar navbar-inverse navbar-static-top" role="navigation">
  45. <div class="container">
  46. <div class="navbar-header">
  47. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"
  48. aria-expanded="false" aria-controls="navbar">
  49. <span class="sr-only">Toggle navigation</span>
  50. <span class="icon-bar"></span>
  51. <span class="icon-bar"></span>
  52. <span class="icon-bar"></span>
  53. </button>
  54. <a class="navbar-brand hidden-sm" href="./index.html">vis.js</a>
  55. </div>
  56. <div id="navbar" class="navbar-collapse collapse">
  57. <ul class="nav navbar-nav">
  58. <li><a href="../index.html#modules">Modules</a></li>
  59. <li class="active"><a href="./docs/index.html" target="_blank">Documentation <img class="icon"
  60. src="../img/external-link-icons/external-link-icon-white.png"></a>
  61. </li>
  62. <li><a href="../blog.html">Blog</a></li>
  63. <li><a href="../index.html#download_install">Download</a></li>
  64. <li><a href="../showcase/index.html">Showcase</a></li>
  65. <li><a href="../index.html#contribute">Contribute</a></li>
  66. <li><a href="../featureRequests.html">Feature requests</a></li>
  67. <li><a href="../index.html#licenses">License</a></li>
  68. </ul>
  69. </div>
  70. </div>
  71. </nav>
  72. </div>
  73. </div>
  74. <a href="https://github.com/almende/vis" class="hidden-xs hidden-sm hidden-md"><img
  75. style="position: absolute; top: 0; right: 0; border: 0;"
  76. src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67"
  77. alt="Fork me on GitHub"
  78. data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a>
  79. <div class="container full">
  80. <h1>Network</h1>
  81. <p>As of 4.0, the network consists of individual modules which handle specific parts of the network. These modules
  82. have their own docs, options, methods and events which you can access
  83. by clicking on the modules in the list below.</p>
  84. <h3>Modules</h3>
  85. <table class="moduleTable">
  86. <tr>
  87. <td width="120px" class="gren"><a href="./canvas.html">canvas</a></td>
  88. <td>Handles the HTML part of the network.</td>
  89. </tr>
  90. <tr>
  91. <td><a href="./clustering.html">clustering</a></td>
  92. <td>Provides the clustering api, giving users full control over the formed clusters.</td>
  93. </tr>
  94. <tr>
  95. <td><a href="./configure.html">configure</a></td>
  96. <td>Generates an interactive option editor with filtering.</td>
  97. </tr>
  98. <tr>
  99. <td><a href="./edges.html">edges</a></td>
  100. <td>Handles the creation and deletion of edges and contains the global edge options and styles.</td>
  101. </tr>
  102. <tr>
  103. <td><a href="./groups.html">groups</a></td>
  104. <td>Contains the groups and some options on how to handle nodes with non-existing groups.</td>
  105. </tr>
  106. <tr>
  107. <td><a href="./interaction.html">interaction</a></td>
  108. <td>Used for all user interaction with the network. Handles mouse and touch events as well as the navigation
  109. buttons and the popups.
  110. </td>
  111. </tr>
  112. <tr>
  113. <td><a href="./layout.html">layout</a></td>
  114. <td>Governs the initial and hierarchical positioning.</td>
  115. </tr>
  116. <tr>
  117. <td><a href="./manipulation.html">manipulation</a></td>
  118. <td>Supplies an API and optional GUI to alter the data in the network.</td>
  119. </tr>
  120. <tr>
  121. <td><a href="./nodes.html">nodes</a></td>
  122. <td>Handles the creation and deletion of nodes and contains the global node options and styles.</td>
  123. </tr>
  124. <tr>
  125. <td><a href="./physics.html">physics</a></td>
  126. <td>Does all the simulation moving the nodes and edges to their final positions, also governs
  127. stabilization.
  128. </td>
  129. </tr>
  130. <tr>
  131. <td><a href="./rendering.html">rendering</a></td>
  132. <td>Handles the rendering aspect of vis. It governs the render loop, it draws the nodes and edges and
  133. provides events to allow users to hook into the drawing.
  134. </td>
  135. </tr>
  136. <tr>
  137. <td><a href="./selection.html">selection</a></td>
  138. <td>Handles the selection of nodes and edges.</td>
  139. </tr>
  140. <tr>
  141. <td><a href="./view.html">view</a></td>
  142. <td>Acts as the camera that looks on the canvas. Does the animation, zooming and focusing.</td>
  143. </tr>
  144. </table>
  145. <h3>All Methods</h3>
  146. <p>This is a list of all the methods in the public API. They are collected here from all individual modules.</p>
  147. <table class="moduleTable">
  148. <tr class="header">
  149. <td class="methodName">name</td>
  150. <td>returns</td>
  151. <td>description</td>
  152. </tr>
  153. <tr>
  154. <td>destroy()</td>
  155. <td class="mid">none</td>
  156. <td>Remove the network from the DOM and remove all Hammer bindings and references.</td>
  157. </tr>
  158. <tr>
  159. <td>setData({<br><code><i>nodes: vis DataSet/Array</i></code>,<br><code><i>edges: vis
  160. DataSet/Arary</i></code><br>})
  161. </td>
  162. <td class="mid">none</td>
  163. <td>Override all the data in the network. If stabilization is enabled in the <a href="physics.html">physics
  164. module</a>, the network will stabilize again. This method is also performed when first initializing the
  165. network.
  166. </td>
  167. </tr>
  168. <tr>
  169. <td>setOptions(<code>Object options</code>)</td>
  170. <td class="mid">none</td>
  171. <td>Set the options. All available options can be found in the modules above. Each module requires it's own
  172. container with the module name to contain its options.
  173. </td>
  174. </tr>
  175. </table>
  176. <h3>All Events</h3>
  177. <p>This is a list of all the events in the public API. They are collected here from all individual modules.</p>
  178. <br>
  179. <br>
  180. <br>
  181. <br>
  182. <br>
  183. <br>
  184. <br>
  185. <br>
  186. <br>
  187. <br>
  188. </div>
  189. <!-- Bootstrap core JavaScript
  190. ================================================== -->
  191. <!-- Placed at the end of the document so the pages load faster -->
  192. <script src="../js/jquery.min.js"></script>
  193. <script src="../js/bootstrap.min.js"></script>
  194. <!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
  195. <script src="../js/ie10-viewport-bug-workaround.js"></script>