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.

870 lines
27 KiB

  1. <!DOCTYPE html>
  2. <html lang="en"><head>
  3. <meta charset="utf-8">
  4. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="description" content="">
  7. <meta name="author" content="">
  8. <link rel="icon" HREF="favicon.ico">
  9. <title>graph3d - vis.js - A dynamic, browser based visualization library.</title>
  10. <!-- Bootstrap core CSS -->
  11. <link href="../css/bootstrap.css" rel="stylesheet">
  12. <!-- Tipue vendor css -->
  13. <link href="../css/tipuesearch.css" rel="stylesheet">
  14. <link href="../css/style.css" rel="stylesheet">
  15. <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  16. <!--[if lt IE 9]>
  17. <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  18. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  19. <![endif]-->
  20. <link href="../css/prettify.css" type="text/css" rel="stylesheet"/>
  21. <script type="text/javascript" src="../js/googleAnalytics.js"></script>
  22. <script type="text/javascript" src="../js/prettify/prettify.js"></script>
  23. <script src="../js/smooth-scroll.min.js"></script>
  24. <script language="JavaScript">
  25. smoothScroll.init();
  26. </script>
  27. <script type="text/javascript" src="../js/toggleTable.js"></script>
  28. </head>
  29. <body onload="prettyPrint();">
  30. <div class="navbar-wrapper">
  31. <div class="container">
  32. <nav class="navbar navbar-inverse navbar-static-top" role="navigation">
  33. <div class="container">
  34. <div class="navbar-header">
  35. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"
  36. aria-expanded="false" aria-controls="navbar">
  37. <span class="sr-only">Toggle navigation</span>
  38. <span class="icon-bar"></span>
  39. <span class="icon-bar"></span>
  40. <span class="icon-bar"></span>
  41. </button>
  42. <a class="navbar-brand hidden-sm" href="./index.html">vis.js</a>
  43. </div>
  44. <div id="navbar" class="navbar-collapse collapse">
  45. <ul class="nav navbar-nav">
  46. <li><a href="http://www.visjs.org/index.html#modules">Modules</a></li>
  47. <li><a href="http://www.visjs.org/blog.html">Blog</a></li>
  48. <li><a href="http://www.visjs.org/index.html#download_install">Download</a></li>
  49. <li><a href="http://www.visjs.org/showcase/index.html">Showcase</a></li>
  50. <li><a href="http://www.visjs.org/index.html#contribute">Contribute</a></li>
  51. <li><a href="http://www.visjs.org/featureRequests.html">Feature requests</a></li>
  52. <li><a href="http://www.visjs.org/index.html#licenses">License</a></li>
  53. </ul>
  54. <form class="navbar-form navbar-right" role="search">
  55. <input name="q" id="tipue_search_input" autocomplete="off" type="text" class="form-control" placeholder="Enter keywords">
  56. <button type="submit" class="btn btn-default">Go!</button>
  57. </form>
  58. <div id="search-results-wrapper" class="panel panel-default">
  59. <div class="panel-body">
  60. <div id="tipue_search_content"></div>
  61. </div>
  62. </div>
  63. <div id="keyword-info" class="panel panel-success">
  64. <div class="panel-body">
  65. Found <span id="keyword-count"></span> results. Click <a id="keyword-jumper-button" href="">here</a> to jump to the first keyword occurence!
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. </nav>
  71. </div>
  72. </div>
  73. <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>
  74. <div class="container full">
  75. <h1>Graph3d</h1>
  76. <h2 id="Overview">Overview</h2>
  77. <p>
  78. Graph3d is an interactive visualization chart to draw data in a three dimensional
  79. graph. You can freely move and zoom in the graph by dragging and scrolling in the
  80. window. Graph3d also supports animation of a graph.
  81. </p>
  82. <p>
  83. Graph3d uses <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Canvas">HTML canvas</a>
  84. to render graphs, and can render up to a few thousands of data points smoothly.
  85. </p>
  86. <h2 id="Contents">Contents</h2>
  87. <ul>
  88. <li><a href="#Overview">Overview</a></li>
  89. <li><a href="#Loading">Loading</a></li>
  90. <li><a href="#Data_Format">Data Format</a></li>
  91. <li><a href="#Configuration_Options">Configuration Options</a></li>
  92. <li><a href="#Methods">Methods</a></li>
  93. <li><a href="#Events">Events</a></li>
  94. <li><a href="#Data_Policy">Data Policy</a></li>
  95. </ul>
  96. <h2 id="Example">Example</h2>
  97. <p>
  98. The following code shows how to create a Graph3d and provide it with data.
  99. More examples can be found in the <a href="../examples">examples</a> directory.
  100. </p>
  101. <pre class="prettyprint lang-html">
  102. &lt;!DOCTYPE HTML&gt;
  103. &lt;html&gt;
  104. &lt;head&gt;
  105. &lt;title&gt;Graph 3D demo&lt;/title&gt;
  106. &lt;style&gt;
  107. body {font: 10pt arial;}
  108. &lt;/style&gt;
  109. &lt;script type="text/javascript" src="../../dist/vis.js"&gt;&lt;/script&gt;
  110. &lt;script type="text/javascript"&gt;
  111. var data = null;
  112. var graph = null;
  113. function custom(x, y) {
  114. return (Math.sin(x/50) * Math.cos(y/50) * 50 + 50);
  115. }
  116. // Called when the Visualization API is loaded.
  117. function drawVisualization() {
  118. // Create and populate a data table.
  119. var data = new vis.DataSet();
  120. // create some nice looking data with sin/cos
  121. var steps = 50; // number of datapoints will be steps*steps
  122. var axisMax = 314;
  123. var axisStep = axisMax / steps;
  124. for (var x = 0; x &lt; axisMax; x+=axisStep) {
  125. for (var y = 0; y &lt; axisMax; y+=axisStep) {
  126. var value = custom(x, y);
  127. data.add({
  128. x: x,
  129. y: y,
  130. z: value,
  131. style: value
  132. });
  133. }
  134. }
  135. // specify options
  136. var options = {
  137. width: '600px',
  138. height: '600px',
  139. style: 'surface',
  140. showPerspective: true,
  141. showGrid: true,
  142. showShadow: false,
  143. keepAspectRatio: true,
  144. verticalRatio: 0.5
  145. };
  146. // create a graph3d
  147. var container = document.getElementById('mygraph');
  148. graph3d = new vis.Graph3d(container, data, options);
  149. }
  150. &lt;/script&gt;
  151. &lt;/head&gt;
  152. &lt;body onload="drawVisualization();"&gt;
  153. &lt;div id="mygraph"&gt;&lt;/div&gt;
  154. &lt;/body&gt;
  155. &lt;/html&gt;
  156. </pre>
  157. <h2 id="Loading">Loading</h2>
  158. <p>
  159. The class name of the Graph3d is <code>vis.Graph3d</code>.
  160. When constructing a Graph3d, an HTML DOM container must be provided to attach
  161. the graph to. Optionally, data and options can be provided.
  162. Data is a vis <code>DataSet</code> or an <code>Array</code>, described in
  163. section <a href="#Data_Format">Data Format</a>.
  164. Options is a name-value map in the JSON format. The available options
  165. are described in section <a href="#Configuration_Options">Configuration Options</a>.
  166. </p>
  167. <pre class="prettyprint lang-js">var graph = new vis.Graph3d(container [, data] [, options]);</pre>
  168. <p>
  169. Data and options can be set or changed later on using the functions
  170. <code>Graph3d.setData(data)</code> and <code>Graph3d.setOptions(options)</code>.
  171. </p>
  172. <h2 id="Data_Format">Data Format</h2>
  173. <p>
  174. Graph3d can load data from an <code>Array</code>, a <code>DataSet</code> (offering 2 way data binding), or a <code>DataView</code> (offering 1 way data binding).
  175. JSON objects are added to this DataSet by using the <code>add()</code> function.
  176. Data points must have properties <code>x</code>, <code>y</code>, and <code>z</code>,
  177. and can optionally have a property <code>style</code> and <code>filter</code>.
  178. <h3>Definition</h3>
  179. <p>
  180. The DataSet JSON objects are defined as:
  181. </p>
  182. <table class="properties">
  183. <tr>
  184. <th>Name</th>
  185. <th>Type</th>
  186. <th>Required</th>
  187. <th>Description</th>
  188. </tr>
  189. <tr>
  190. <td>x</td>
  191. <td>number</td>
  192. <td>yes</td>
  193. <td>Location on the x-axis.</td>
  194. </tr>
  195. <tr>
  196. <td>y</td>
  197. <td>number</td>
  198. <td>yes</td>
  199. <td>Location on the y-axis.</td>
  200. </tr>
  201. <tr>
  202. <td>z</td>
  203. <td>number</td>
  204. <td>yes</td>
  205. <td>Location on the z-axis.</td>
  206. </tr>
  207. <tr>
  208. <td>style</td>
  209. <td>number</td>
  210. <td>no</td>
  211. <td>The data value, required for graph styles <code>dot-color</code> and
  212. <code>dot-size</code>.
  213. </td>
  214. </tr>
  215. <tr>
  216. <td>filter</td>
  217. <td>*</td>
  218. <td>no</td>
  219. <td>Filter values used for the animation.
  220. This column may have any type, such as a number, string, or Date.</td>
  221. </tr>
  222. </table>
  223. <h2 id="Configuration_Options">Configuration Options</h2>
  224. <p>
  225. Options can be used to customize the graph. Options are defined as a JSON object.
  226. All options are optional.
  227. </p>
  228. <pre class="prettyprint lang-js">
  229. var options = {
  230. width: '100%',
  231. height: '400px',
  232. style: 'surface'
  233. };
  234. </pre>
  235. <p>
  236. The following options are available.
  237. </p>
  238. <table class="options">
  239. <tr>
  240. <th>Name</th>
  241. <th>Type</th>
  242. <th>Default</th>
  243. <th>Description</th>
  244. </tr>
  245. <tr>
  246. <td>animationInterval</td>
  247. <td>number</td>
  248. <td>1000</td>
  249. <td>The animation interval in milliseconds. This determines how fast
  250. the animation runs.</td>
  251. </tr>
  252. <tr>
  253. <td>animationPreload</td>
  254. <td>boolean</td>
  255. <td>false</td>
  256. <td>If false, the animation frames are loaded as soon as they are requested.
  257. if <code>animationPreload</code> is true, the graph will automatically load
  258. all frames in the background, resulting in a smoother animation as soon as
  259. all frames are loaded. The load progress is shown on screen.</td>
  260. </tr>
  261. <tr>
  262. <td>animationAutoStart</td>
  263. <td>boolean</td>
  264. <td>false</td>
  265. <td>If true, the animation starts playing automatically after the graph
  266. is created.</td>
  267. </tr>
  268. <tr>
  269. <td>axisColor</td>
  270. <td>string</td>
  271. <td>'#4D4D4D'</td>
  272. <td>The color of the axis lines and the text along the axis.</td>
  273. </tr>
  274. <tr>
  275. <td>backgroundColor</td>
  276. <td>string or Object</td>
  277. <td>{fill:&nbsp;'white', stroke:&nbsp;'gray', strokeWidth:&nbsp;1}</td>
  278. <td>The background color for the main area of the chart.
  279. Can be either a simple HTML color string, for example: 'red' or '#00cc00',
  280. or an object with the following properties.</td>
  281. </tr>
  282. <tr>
  283. <td>backgroundColor.fill</td>
  284. <td>string</td>
  285. <td>'white'</td>
  286. <td>The chart fill color, as an HTML color string.</td>
  287. </tr>
  288. <tr>
  289. <td>backgroundColor.stroke</td>
  290. <td>string</td>
  291. <td>'gray'</td>
  292. <td>The color of the chart border, as an HTML color string.</td>
  293. </tr>
  294. <tr>
  295. <td>backgroundColor.strokeWidth</td>
  296. <td>number</td>
  297. <td>1</td>
  298. <td>The border width, in pixels.</td>
  299. </tr>
  300. <tr>
  301. <td>cameraPosition</td>
  302. <td>Object</td>
  303. <td>{horizontal:&nbsp;1.0, vertical:&nbsp;0.5, distance:&nbsp;1.7}</td>
  304. <td>Set the initial rotation and position of the camera.
  305. The object <code>cameraPosition</code> contains three parameters:
  306. <code>horizontal</code>, <code>vertical</code>, and <code>distance</code>.
  307. Parameter <code>horizontal</code> is a value in radians and can have any
  308. value (but normally in the range of 0 and 2*Pi).
  309. Parameter <code>vertical</code> is a value in radians between 0 and 0.5*Pi.
  310. Parameter <code>distance</code> is the (normalized) distance from the
  311. camera to the center of the graph, in the range of 0.71 to 5.0. A
  312. larger distance puts the graph further away, making it smaller.
  313. All parameters are optional.
  314. </tr>
  315. <tr>
  316. <td>dataColor</td>
  317. <td>string or object</td>
  318. <td>{fill:&nbsp;'#7DC1FF', stroke:&nbsp;'#3267D2', strokeWidth:&nbsp;1}</td>
  319. <td>When <code>dataColor</code> is a string, it will set the color for both border and fill color of dots and bars. Applicable for styles <code>dot-size</code>, <code>bar-size</code>, and <code>line</code>. When an object, it can contain the properties descibed below.</td>
  320. </tr>
  321. <tr>
  322. <td>dataColor.fill</td>
  323. <td>string</td>
  324. <td>'#7DC1FF'</td>
  325. <td>The fill color of the dots or bars. Applicable when using styles <code>dot-size</code>, <code>bar-size</code>, or <code>line</code>.</td>
  326. </tr>
  327. <tr>
  328. <td>dataColor.stroke</td>
  329. <td>string</td>
  330. <td>'#3267D2'</td>
  331. <td>The border color of the dots or bars. Applicable when using styles <code>dot-size</code> or <code>bar-size</code>.</td>
  332. </tr>
  333. <tr>
  334. <td>dataColor.strokeWidth</td>
  335. <td>number</td>
  336. <td>1</td>
  337. <td>The line width of dots, bars and lines. Applicable for all styles.</td>
  338. </tr>
  339. <tr>
  340. <td>dotSizeRatio</td>
  341. <td>number</td>
  342. <td>0.02</td>
  343. <td>Ratio of the size of the dots with respect to the width of the graph.</td>
  344. </tr>
  345. <tr>
  346. <td>gridColor</td>
  347. <td>string</td>
  348. <td>'#D3D3D3'</td>
  349. <td>The color of the grid lines.</td>
  350. </tr>
  351. <tr>
  352. <td>height</td>
  353. <td>string</td>
  354. <td>'400px'</td>
  355. <td>The height of the graph in pixels or as a percentage.</td>
  356. </tr>
  357. <tr>
  358. <td>keepAspectRatio</td>
  359. <td>boolean</td>
  360. <td>true</td>
  361. <td>If <code>keepAspectRatio</code> is true, the x-axis and the y-axis
  362. keep their aspect ratio. If false, the axes are scaled such that they
  363. both have the same, maximum with.</td>
  364. </tr>
  365. <tr>
  366. <td>showAnimationControls</td>
  367. <td>boolean</td>
  368. <td>true</td>
  369. <td>If true, animation controls are created at the bottom of the Graph.
  370. The animation controls consists of buttons previous, start/stop, next,
  371. and a slider showing the current frame.
  372. Only applicable when the provided data contains an animation.</td>
  373. </tr>
  374. <tr>
  375. <td>showGrid</td>
  376. <td>boolean</td>
  377. <td>true</td>
  378. <td>If true, grid lines are drawn in the x-y surface (the bottom of the 3d
  379. graph).</td>
  380. </tr>
  381. <tr>
  382. <td>showXAxis</td>
  383. <td>boolean</td>
  384. <td>true</td>
  385. <td>If true, X axis and X axis labels are drawn.</td>
  386. </tr>
  387. <tr>
  388. <td>showYAxis</td>
  389. <td>boolean</td>
  390. <td>true</td>
  391. <td>If true, Y axis and Y axis labels are drawn.</td>
  392. </tr>
  393. <tr>
  394. <td>showZAxis</td>
  395. <td>boolean</td>
  396. <td>true</td>
  397. <td>If true, Z axis and Z axis labels are drawn.</td>
  398. </tr>
  399. <tr>
  400. <td>showPerspective</td>
  401. <td>boolean</td>
  402. <td>true</td>
  403. <td>If true, the graph is drawn in perspective: points and lines which
  404. are further away are drawn smaller.
  405. Note that the graph currently does not support a gray colored bottom side
  406. when drawn in perspective.
  407. </td>
  408. </tr>
  409. <tr>
  410. <td>showLegend</td>
  411. <td>boolean</td>
  412. <td>none</td>
  413. <td>If true, a legend is drawn for the graph (if the graph type supports it).
  414. By default a legend is drawn for dot and dot-color style graphs.
  415. </td>
  416. </tr>
  417. <tr>
  418. <td>showShadow</td>
  419. <td>boolean</td>
  420. <td>false</td>
  421. <td>Show shadow on the graph.</td>
  422. </tr>
  423. <tr>
  424. <td>style</td>
  425. <td>string</td>
  426. <td>'dot'</td>
  427. <td>The style of the 3d graph. Available styles:
  428. <code>bar</code>,
  429. <code>bar-color</code>,
  430. <code>bar-size</code>,
  431. <code>dot</code>,
  432. <code>dot-line</code>,
  433. <code>dot-color</code>,
  434. <code>dot-size</code>,
  435. <code>line</code>,
  436. <code>grid</code>,
  437. or <code>surface</code></td>
  438. </tr>
  439. <tr>
  440. <td>tooltip</td>
  441. <td>boolean | function</td>
  442. <td>false</td>
  443. <td>Show a tooltip showing the values of the hovered data point.
  444. The contents of the tooltip can be customized by providing a callback
  445. function as <code>tooltip</code>. In this case the function is called
  446. with an object containing parameters <code>x</code>,
  447. <code>y</code>, <code>z</code>, and <code>data</code>
  448. (the source JS object for the point) as an argument,
  449. and must return a string which may contain HTML.
  450. </td>
  451. </tr>
  452. <tr>
  453. <td>tooltipStyle</td>
  454. <td>Object</td>
  455. <td>
  456. <pre class="prettyprint lang-js">
  457. {
  458. content: {
  459. padding: '10px',
  460. border: '1px solid #4d4d4d',
  461. color: '#1a1a1a',
  462. background: 'rgba(255,255,255,0.7)',
  463. borderRadius: '2px',
  464. boxShadow: '5px 5px 10px rgba(128,128,128,0.5)'
  465. },
  466. line: {
  467. height: '40px',
  468. width: '0',
  469. borderLeft: '1px solid #4d4d4d'
  470. },
  471. dot: {
  472. height: '0',
  473. width: '0',
  474. border: '5px solid #4d4d4d',
  475. borderRadius: '5px'
  476. }
  477. }</pre>
  478. </td>
  479. <td>Tooltip style properties.
  480. Provided properties will be merged with the default object.
  481. </td>
  482. </tr>
  483. <tr>
  484. <td>valueMax</td>
  485. <td>number</td>
  486. <td>none</td>
  487. <td>The maximum value for the value-axis. Only available in combination
  488. with the styles <code>dot-color</code> and <code>dot-size</code>.</td>
  489. </tr>
  490. <tr>
  491. <td>valueMin</td>
  492. <td>number</td>
  493. <td>none</td>
  494. <td>The minimum value for the value-axis. Only available in combination
  495. with the styles <code>dot-color</code> and <code>dot-size</code>.</td>
  496. </tr>
  497. <tr>
  498. <td>verticalRatio</td>
  499. <td>number</td>
  500. <td>0.5</td>
  501. <td>A value between 0.1 and 1.0. This scales the vertical size of the graph
  502. When keepAspectRatio is set to false, and verticalRatio is set to 1.0,
  503. the graph will be a cube.</td>
  504. </tr>
  505. <tr>
  506. <td>width</td>
  507. <td>string</td>
  508. <td>'400px'</td>
  509. <td>The width of the graph in pixels or as a percentage.</td>
  510. </tr>
  511. <tr>
  512. <td>xBarWidth</td>
  513. <td>number</td>
  514. <td>none</td>
  515. <td>The width of bars in x direction. By default, the width is equal to the smallest distance
  516. between the data points.
  517. Only applicable for styles <code>'bar'</code> and <code>'bar-color'</code>.</td>
  518. </tr>
  519. <tr>
  520. <td>xCenter</td>
  521. <td>string</td>
  522. <td>'55%'</td>
  523. <td>The horizontal center position of the graph, as a percentage or in
  524. pixels.</td>
  525. </tr>
  526. <tr>
  527. <td>xMax</td>
  528. <td>number</td>
  529. <td>from data</td>
  530. <td>The maximum value for the x-axis.
  531. If not set, the largest value for x in the data set is used.
  532. </td>
  533. </tr>
  534. <tr>
  535. <td>xMin</td>
  536. <td>number</td>
  537. <td>from data</td>
  538. <td>The minimum value for the x-axis.
  539. If not set, the smallest value for x in the data set is used.
  540. </td>
  541. </tr>
  542. <tr>
  543. <td>xStep</td>
  544. <td>number</td>
  545. <td>none</td>
  546. <td>Step size for the grid on the x-axis.</td>
  547. </tr>
  548. <tr>
  549. <td>xValueLabel</td>
  550. <td>function</td>
  551. <td>none</td>
  552. <td>A function for custom formatting of the labels along the x-axis,
  553. for example <code>function (x) {return (x * 100) + '%'}</code>.
  554. </td>
  555. </tr>
  556. <tr>
  557. <td>yBarWidth</td>
  558. <td>number</td>
  559. <td>none</td>
  560. <td>The width of bars in y direction. By default, the width is equal to the smallest distance
  561. between the data points.
  562. Only applicable for styles <code>'bar'</code> and <code>'bar-color'</code>.</td>
  563. </tr>
  564. <tr>
  565. <td>yCenter</td>
  566. <td>string</td>
  567. <td>'45%'</td>
  568. <td>The vertical center position of the graph, as a percentage or in
  569. pixels.</td>
  570. </tr>
  571. <tr>
  572. <td>yMax</td>
  573. <td>number</td>
  574. <td>from data</td>
  575. <td>The maximum value for the y-axis.
  576. If not set, the largest value for y in the data set is used.
  577. </td>
  578. </tr>
  579. <tr>
  580. <td>yMin</td>
  581. <td>number</td>
  582. <td>from data</td>
  583. <td>The minimum value for the y-axis.
  584. If not set, the smallest value for y in the data set is used.
  585. </td>
  586. </tr>
  587. <tr>
  588. <td>yStep</td>
  589. <td>number</td>
  590. <td>none</td>
  591. <td>Step size for the grid on the y-axis.</td>
  592. </tr>
  593. <tr>
  594. <td>yValueLabel</td>
  595. <td>function</td>
  596. <td>none</td>
  597. <td>A function for custom formatting of the labels along the y-axis,
  598. for example <code>function (y) {return (y * 100) + '%'}</code>.
  599. </td>
  600. </tr>
  601. <tr>
  602. <td>zMax</td>
  603. <td>number</td>
  604. <td>from data</td>
  605. <td>The maximum value for the z-axis.
  606. If not set, the largest value for z in the data set is used.
  607. </td>
  608. </tr>
  609. <tr>
  610. <td>zMin</td>
  611. <td>number</td>
  612. <td>from data</td>
  613. <td>The minimum value for the z-axis.
  614. If not set, the smallest value for z in the data set is used.
  615. </td>
  616. </tr>
  617. <tr>
  618. <td>zStep</td>
  619. <td>number</td>
  620. <td>none</td>
  621. <td>Step size for the grid on the z-axis.</td>
  622. </tr>
  623. <tr>
  624. <td>zValueLabel</td>
  625. <td>function</td>
  626. <td>none</td>
  627. <td>A function for custom formatting of the labels along the z-axis,
  628. for example <code>function (z) {return (z * 100) + '%'}</code>.
  629. </td>
  630. </tr>
  631. <tr>
  632. <td>xLabel</td>
  633. <td>String</td>
  634. <td>x</td>
  635. <td>Label on the X axis.</td>
  636. </tr>
  637. <tr>
  638. <td>yLabel</td>
  639. <td>String</td>
  640. <td>y</td>
  641. <td>Label on the Y axis.</td>
  642. </tr>
  643. <tr>
  644. <td>zLabel</td>
  645. <td>String</td>
  646. <td>z</td>
  647. <td>Label on the Z axis.</td>
  648. </tr>
  649. <tr>
  650. <td>filterLabel</td>
  651. <td>String</td>
  652. <td>time</td>
  653. <td>Label for the filter column.</td>
  654. </tr>
  655. <tr>
  656. <td>legendLabel</td>
  657. <td>String</td>
  658. <td>value</td>
  659. <td>Label for the style description.</td>
  660. </tr>
  661. </table>
  662. <h2 id="Methods">Methods</h2>
  663. <p>
  664. Graph3d supports the following methods.
  665. </p>
  666. <table class="methods">
  667. <tr>
  668. <th>Method</th>
  669. <th>Return Type</th>
  670. <th>Description</th>
  671. </tr>
  672. <tr>
  673. <td>animationStart()</td>
  674. <td>none</td>
  675. <td>Start playing the animation.
  676. Only applicable when animation data is available.</td>
  677. </tr>
  678. <tr>
  679. <td>animationStop()</td>
  680. <td>none</td>
  681. <td>Stop playing the animation.
  682. Only applicable when animation data is available.</td>
  683. </tr>
  684. <tr>
  685. <td>getCameraPosition()</td>
  686. <td>An object with parameters <code>horizontal</code>,
  687. <code>vertical</code> and <code>distance</code></td>
  688. <td>Returns an object with parameters <code>horizontal</code>,
  689. <code>vertical</code> and <code>distance</code>,
  690. which each one of them is a number, representing the rotation and position
  691. of the camera.</td>
  692. </tr>
  693. <tr>
  694. <td>redraw()</td>
  695. <td>none</td>
  696. <td>Redraw the graph. Useful after the camera position is changed externally,
  697. when data is changed, or when the layout of the webpage changed.</td>
  698. </tr>
  699. <tr>
  700. <td>setData(data)</td>
  701. <td>none</td>
  702. <td>Replace the data in the Graph3d.</td>
  703. </tr>
  704. <tr>
  705. <td>setOptions(options)</td>
  706. <td>none</td>
  707. <td>Update options of Graph3d.
  708. The provided options will be merged with current options.</td>
  709. </tr>
  710. <tr>
  711. <td>setSize(width, height)</td>
  712. <td>none</td>
  713. <td>Parameters <code>width</code> and <code>height</code> are strings,
  714. containing a new size for the graph. Size can be provided in pixels
  715. or in percentages.</td>
  716. </tr>
  717. <tr>
  718. <td>setCameraPosition (pos)</td>
  719. <td>{horizontal:&nbsp;1.0, vertical:&nbsp;0.5, distance:&nbsp;1.7}</td>
  720. <td>Set the rotation and position of the camera. Parameter <code>pos</code>
  721. is an object which contains three parameters: <code>horizontal</code>,
  722. <code>vertical</code>, and <code>distance</code>.
  723. Parameter <code>horizontal</code> is a value in radians and can have any
  724. value (but normally in the range of 0 and 2*Pi).
  725. Parameter <code>vertical</code> is a value in radians between 0 and 0.5*Pi.
  726. Parameter <code>distance</code> is the (normalized) distance from the
  727. camera to the center of the graph, in the range of 0.71 to 5.0. A
  728. larger distance puts the graph further away, making it smaller.
  729. All parameters are optional.
  730. </td>
  731. </tr>
  732. </table>
  733. <h2 id="Events">Events</h2>
  734. <p>
  735. Graph3d fires events after the camera position has been changed.
  736. The event can be catched by creating a listener.
  737. Here an example on how to catch a <code>cameraPositionChange</code> event.
  738. </p>
  739. <pre class="prettyprint lang-js">
  740. function onCameraPositionChange(event) {
  741. alert('The camera position changed to:\n' +
  742. 'Horizontal: ' + event.horizontal + '\n' +
  743. 'Vertical: ' + event.vertical + '\n' +
  744. 'Distance: ' + event.distance);
  745. }
  746. // assuming var graph3d = new vis.Graph3d(document.getElementById('mygraph'));
  747. graph3d.on('cameraPositionChange', onCameraPositionChange);
  748. </pre>
  749. <p>
  750. The following events are available.
  751. </p>
  752. <table class="events">
  753. <tr>
  754. <th>name</th>
  755. <th>Properties</th>
  756. <th>Description</th>
  757. </tr>
  758. <tr>
  759. <td>cameraPositionChange</td>
  760. <td>
  761. <ul>
  762. <li><code>horizontal</code>: Number. The horizontal angle of the camera.</li>
  763. <li><code>vertical</code>: Number. The vertical angle of the camera.</li>
  764. <li><code>distance</code>: Number. The distance of the camera to the center of the graph.</li>
  765. </ul>
  766. </td>
  767. <td>The camera position changed. Fired after the user modified the camera position
  768. by moving (dragging) the graph, or by zooming (scrolling),
  769. but not after a call to <code>setCameraPosition</code> method.
  770. The new camera position can be retrieved by calling the method
  771. <code>getCameraPosition</code>.</td>
  772. </tr>
  773. </table>
  774. <h2 id="Data_Policy">Data Policy</h2>
  775. <p>
  776. All code and data are processed and rendered in the browser. No data is sent to any server.
  777. </p>
  778. </div>
  779. <!-- Bootstrap core JavaScript
  780. ================================================== -->
  781. <!-- Placed at the end of the document so the pages load faster -->
  782. <script src="../js/jquery.min.js"></script>
  783. <script src="../js/bootstrap.min.js"></script>
  784. <!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
  785. <script src="../js/ie10-viewport-bug-workaround.js"></script>
  786. <!-- jquery extensions -->
  787. <script src="../js/jquery.highlight.js"></script>
  788. <script src="../js/jquery.url.min.js"></script>
  789. <!-- Tipue vendor js -->
  790. <script src="../js/tipuesearch.config.js"></script>
  791. <script src="../js/tipuesearch.js"></script>
  792. <!-- controller -->
  793. <script src="../js/main.js"></script>