jrtechs
/
jrtechs-vis
mirror of https://github.com/jrtechs/vis.git

<html>
<head>  <title>vis.js | Graph2d documentation</title>  <style>      td.greenField {          background-color: #c9ffc7;      }  </style>  <link href='css/prettify.css' type='text/css' rel='stylesheet'>  <link href='css/style.css' type='text/css' rel='stylesheet'>
  <script type="text/javascript" src="lib/prettify/prettify.js"></script></head>
<body onload="prettyPrint();"><div id="container">
<h1>Graph2d documentation</h1>
<h2 id="Overview">Overview</h2><p>  Graph2d is an interactive visualization chart to draw data in a 2D graph.  You can freely move and zoom in the graph by dragging and scrolling in the  window.</p><p>  Graph2d uses HTML DOM and SVG for rendering. This allows for flexible  customization using css styling.</p>
<h2 id="Contents">Contents</h2><ul>  <li><a href="#Overview">Overview</a></li>  <li><a href="#Loading">Loading</a></li>  <li><a href="#Data_Format">Data Format</a>    <ul>        <li><a href="#items">Items</a></li>        <li><a href="#groups">Groups</a></li>        <li><a href="#GroupOptions">Group-specific options</a></li>    </ul>  </li>  <li><a href="#Configuration_Options">Configuration Options</a>      <ul>          <li><a href="#graph2dOptions">Graph2d options</a></li>          <li><a href="#timelineOptions">Timeline options</a></li>      </ul>  </li>  <li><a href="#Methods">Methods</a></li>  <li><a href="#Events">Events</a></li>  <li><a href="#Localization">Localization</a></li>  <li><a href="#Styles">Styles</a></li>  <li><a href="#Data_Policy">Data Policy</a></li></ul>
<h2 id="Example">Example</h2><p>  The following code shows how to create a Graph2d and provide it with data.  More examples can be found in the <a href="../examples">examples</a> directory.</p>
<pre class="prettyprint lang-html">&lt;!DOCTYPE HTML&gt;&lt;html&gt;&lt;head&gt;  &lt;title&gt;Graph2d | Basic Example&lt;/title&gt;
  &lt;style type="text/css"&gt;    body, html {      font-family: sans-serif;    }  &lt;/style&gt;
  &lt;script src="../../dist/vis.js"&gt;&lt;/script&gt;  &lt;link href="../../dist/vis.css" rel="stylesheet" type="text/css" /&gt;&lt;/head&gt;&lt;body&gt;&lt;div id="visualization"&gt;&lt;/div&gt;
&lt;script type="text/javascript"&gt;  var container = document.getElementById('visualization');  var items = [      {x: '2014-06-11', y: 10},      {x: '2014-06-12', y: 25},      {x: '2014-06-13', y: 30},      {x: '2014-06-14', y: 10},      {x: '2014-06-15', y: 15},      {x: '2014-06-16', y: 30}  ];
  var dataset = new vis.DataSet(items);  var options = {      start: '2014-06-10',      end: '2014-06-18'  };  var Graph2d = new vis.Graph2d(container, dataset, options);&lt;/script&gt;&lt;/body&gt;&lt;/html&gt;
</pre>

<h2 id="Loading">Loading</h2>
<p>  The class name of the Graph2d is <code>vis.Graph2d</code>.  When constructing a Graph2d, an HTML DOM container must be provided to attach  the graph to. Optionally, data an options can be provided.  Data is a vis <code>DataSet</code> or an <code>Array</code>, described in  section <a href="#Data_Format">Data Format</a>.  Options is a name-value map in the JSON format. The available options  are described in section <a href="#Configuration_Options">Configuration Options</a>.  Groups is a vis <code>DataSet</code> containing groups. The available options and the method of construction  are described in section <a href="#Group_Options">Data Format</a>.</p><pre class="prettyprint lang-js">var graph = new vis.Graph2d(container [, data] [, options] [,groups]);</pre>
<p>  Data, options and groups can be set or changed later on using the functions  <code>Graph2d.setData(data)</code>, <code>Graph2d.setOptions(options)</code> and <code>Graph2d.setGroups(groups)</code>.</p>
<h2 id="Data_Format">Data Format</h2><p>  Graph2d can load data from an <code>Array</code>, a <code>DataSet</code> or a <code>DataView</code>.  JSON objects are added to this DataSet by using the <code>add()</code> function.  Data points must have properties <code>x</code>, <code>y</code>, and <code>z</code>,  and can optionally have a property <code>style</code> and <code>filter</code>.<p>    Graph2d can be provided with two types of data:</p><ul>    <li><a href="#items">Items</a> containing a set of points to be displayed.</li>    <li><a href="#groups">Groups</a> containing a set of groups used to group items        together. All items belonging to a group will be drawn as a single graph.</li></ul>
<h3 id="items">Items</h3>
<pre class="prettyprint lang-js">var items = [    {x: '2014-06-13', y: 30, group: 0},    {x: '2014-06-14', y: 10, group: 0},    {x: '2014-06-15', y: 15, group: 1},    {x: '2014-06-16', y: 30, group: 1},    {x: '2014-06-17', y: 10, group: 1},    {x: '2014-06-18', y: 15, group: 1}];</pre>
<table>  <tr>    <th>Name</th>    <th>Type</th>    <th>Required</th>    <th>Description</th>  </tr>  <tr>    <td>x</td>    <td>number</td>    <td>yes</td>    <td>Location on the x-axis.</td>  </tr>  <tr>    <td>y</td>    <td>number</td>    <td>yes</td>    <td>Location on the y-axis.</td>  </tr>  </tr>  <tr>    <td>group</td>    <td>number | string</td>    <td>no</td>    <td>The ID of the group this point belongs to.</td>  </tr></table>
<h3 id="groups">Groups</h3>
<p>    Like the items, groups are regular JavaScript Arrays and Objects.    Using groups, items can be grouped together.    Items are filtered per group, and displayed as individual graphs. Groups can contain the properties <code>id</code>,    <code>content</code>, <code>className</code> (optional) and  <code>options</code> (optional).</p><p>    Groups can be applied to a timeline using the method <code>setGroups</code>.    A table with groups can be created like:</p>
<pre class="prettyprint lang-js">var groups = new vis.DataSet();groups.add({    id: 1,    content: 'Group 1',    // Optional: a field 'visible'    // Optional: a field 'className'    // Optional: options  })groups.add({  // more groups...});</pre>

<p>    Groups can have the following properties:</p>
<table>    <tr>        <th>Name</th>        <th>Type</th>        <th>Required</th>        <th>Description</th>    </tr>    <tr>        <td>id</td>        <td>String | Number</td>        <td>yes</td>        <td>An id for the group. The group will display all items having a            property <code>group</code> which matches the <code>id</code>            of the group.</td>    </tr>    <tr>        <td>content</td>        <td>String</td>        <td>yes</td>        <td>The contents of the group. This can be plain text or html code.</td>    </tr>    <tr>        <td>className</td>        <td>String</td>        <td>no</td>        <td>This field is optional. A className can be used to give groups            an individual css style.        </td>    </tr>    <tr>        <td>options</td>        <td>JSON object</td>        <td>no</td>        <td>This field is optional. The options can be used to give a group a specific draw style.            Any options that are colored green in the Configuration Options can be used as options here.    </tr>    <tr>        <td>visible</td>        <td>Boolean</td>        <td>true</td>        <td>This field is optional. If false, this group will not be drawn.    </tr></table>
<h3 id="GroupOptions">Group-specific Options</h3>
The groups have some options that only apply to groups and cannot be set globally. These are listed below.
<pre class="prettyprint lang-js">var groups = new vis.DataSet();groups.add({    id: 1,    content: 'Group 1',    options: {        slots: { slot: 1, total: 3}    }});</pre>

<table>    <tr>        <th>Name</th>        <th>Type</th>        <th>Required</th>        <th>Description</th>    </tr>    <tr>        <td>slots.slot</td>        <td>Number</td>        <td></td>        <td>The slot the bar chart is plotted in. This has to be used in combination with slots.total. See <a href="../examples/Graph2d/11_barsSideBySideGroups.html">example 11</a> for more information.</td>    </tr>    <tr>        <td>slots.total</td>        <td>Number</td>        <td></td>        <td>The total amount of slots available. This has to be used in combination with slots.slot. See <a href="../examples/Graph2d/11_barsSideBySideGroups.html">example 11</a> for more information.</td>    </tr></table>
<h2 id="Configuration_Options">Configuration Options</h2>
<h3 id="graph2dOptions">Graph2d Options</h3>
Options can be used to customize the Graph2d to your purposes. These options can be passed to the Graph2d object either inthe constructor, or by the <code>setOptions</code> function.
<pre class="prettyprint lang-js">var options = {    width:  '100%',    height: '400px',    style: 'surface'};</pre>
The options colored in green can also be used as options for the groups. All options are optional.
<table>    <tr>        <th>Name</th>        <th>Type</th>        <th>Default</th>        <th>Description</th>    </tr>    <tr>        <td class="greenField">yAxisOrientation</td>        <td>String</td>        <td>'left'</td>        <td>This defines with which axis, left or right, the graph is coupled. <a href="../examples/Graph2d/05_bothAxis.html">Example 5</a> shows groups with different Y axis. If no groups are coupled        with an axis, it will not be shown.</td>    </tr>    <tr>        <td>defaultGroup</td>        <td>String</td>        <td>'default'</td>        <td>This is the label for the default, ungrouped items when shown in a legend.</td>    </tr>    <tr>        <td class="greenField">sort</td>        <td>Boolean</td>        <td>true</td>        <td>This determines if the items are sorted automatically.            They are sorted by the x value. If sort is enabled, more optimizations are possible, increasing the performance.</td>    </tr>    <tr>        <td class="greenField">sampling</td>        <td>Boolean</td>        <td>true</td>        <td>If sampling is enabled, Graph2d will automatically determine the amount of points per pixel.            If there are more than 1 point per pixel, not all points will be drawn. Disabling sampling will cause a decrease in performance.</td>    </tr>    <tr>        <td>graphHeight</td>        <td>Number | String</td>        <td>'400px'</td>        <td>This is the height of the graph SVG canvas.            If it is larger than the height of the outer frame, you can drag up and down            the vertical direction as well as the usual horizontal direction.</td>    </tr>    <tr>        <td class="greenField">shaded</td>        <td>Boolean | Object</td>        <td>false</td>        <td>Toggle a shaded area with the default settings.</td>    </tr>    <tr>        <td class="greenField">shaded.enabled</td>        <td>Boolean</td>        <td>false</td>        <td>This toggles the shading.</td>    </tr>    <tr>        <td class="greenField">shaded.orientation</td>        <td>String</td>        <td>'bottom'</td>        <td>This determines if the shaded area is at the bottom or at the top of the curve. The options are 'bottom' or 'top'.</td>    </tr>    <tr>        <td class="greenField">style</td>        <td>String</td>        <td>'line'</td>        <td>This allows the user to define if this should be a linegraph or a barchart. The options are: 'line' or 'bar'.</td>    </tr>    <tr>        <td class="greenField">barChart.width</td>        <td>Number</td>        <td>50</td>        <td>The width of the bars.</td>    </tr>    <tr>        <td class="greenField">barChart.align</td>        <td>String</td>        <td>'center'</td>        <td>The alignment of the bars with regards to the coordinate. The options are 'left', 'right' or 'center'.</td>    </tr>    <tr>        <td class="greenField">barChart.allowOverlap</td>        <td>Boolean</td>        <td>true</td>        <td>When true, bars that have the same x coordinate are plotted on top of eachother (not stacking).            See <a href="../examples/Graph2d/10_barsSideBySide.html">example 10</a> for more information.            When using groups, see <a href="../examples/Graph2d/11_barsSideBySideGroups.html">example 11</a>.        </td>    </tr>    <tr>        <td class="greenField">catmullRom</td>        <td>Boolean | Object</td>        <td>true</td>        <td>Toggle the interpolation with the default settings. For more customization use the JSON format.</td>    </tr>    <tr>        <td class="greenField">catmullRom.enabled</td>        <td>Boolean</td>        <td>true</td>        <td>Toggle the interpolation.</td>    </tr>    <tr>        <td class="greenField">catmullRom.parametrization</td>        <td>String</td>        <td>'centripetal'</td>        <td>Define the type of parametrizaion. <a href="../examples/Graph2d/07_scrollingAndSorting.html">Example 7</a> shows the different methods. The options are 'centripetal' (best results), 'chordal' and 'uniform'. Uniform is the computationally cheapest variant.            If catmullRom is disabled, linear interpolation is used.</td>    </tr>    <tr>        <td class="greenField">drawPoints</td>        <td>Boolean | Object</td>        <td>true</td>        <td>Toggle the drawing of the datapoints with the default settings.</td>    </tr>    <tr>        <td class="greenField">drawPoints.enabled</td>        <td>Boolean</td>        <td>true</td>        <td>Toggle the drawing of the datapoints.</td>    </tr>    <tr>        <td class="greenField">drawPoints.size</td>        <td>Number</td>        <td>6</td>        <td>Determine the size at which the data points are drawn.</td>    </tr>    <tr>        <td class="greenField">drawPoints.style</td>        <td>String</td>        <td>'square'</td>        <td>Determine the shape of the data points. The options are 'square' or 'circle'.</td>    </tr>    <tr>        <td>dataAxis.showMinorLabels</td>        <td>Boolean</td>        <td>true</td>        <td>Toggle the drawing of the minor labels on the Y axis.</td>    </tr>    <tr>        <td>dataAxis.showMajorLabels</td>        <td>Boolean</td>        <td>true</td>        <td>Toggle the drawing of the major labels on the Y axis.</td>    </tr>    <tr>        <td>dataAxis.icons</td>        <td>Boolean</td>        <td>false</td>        <td>Toggle the drawing of automatically generated icons the Y axis.</td>    </tr>    <tr>        <td>dataAxis.width</td>        <td>Number | String</td>        <td>'40px'</td>        <td>Set the (minimal) width of the yAxis. The axis will resize to accomodate the labels of the Y values.</td>    </tr>    <tr>        <td>dataAxis.visible</td>        <td>Boolean</td>        <td>true</td>        <td>Show or hide the data axis.</td>    </tr>    <tr>        <td>legend</td>        <td>Boolean</td>        <td>false</td>        <td>Toggle the legend with the default settings.</td>    </tr>    <tr>        <td>legend.enabled</td>        <td>Boolean</td>        <td>false</td>        <td>Toggle the legend.</td>    </tr>    <tr>        <td>legend.icons</td>        <td>Boolean</td>        <td>true</td>        <td>Show automatically generated icons on the legend.</td>    </tr>    <tr>        <td>legend.left.visible</td>        <td>Boolean</td>        <td>true</td>        <td>Both axis, left and right, have a corresponding legend. This toggles the visibility of the legend that is coupled with the left axis.</td>    </tr>    <tr>        <td>legend.left.position</td>        <td>String</td>        <td>'top-left'</td>        <td>Determine the position of the legend coupled to the left axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'.</td>    </tr>    <tr>        <td>legend.right.visible</td>        <td>Boolean</td>        <td>true</td>        <td>This toggles the visibility of the legend that is coupled with the right axis.</td>    </tr>    <tr>        <td>legend.right.position</td>        <td>String</td>        <td>'top-right'</td>        <td>Determine the position of the legend coupled to the right axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'.</td>    </tr></table>
<h3 id="timelineOptions">Timeline Options</h3>
<p>  Graph2d is built upon the framework of the Timeline. All options from the Timeline can be used with Graph2d. The options available for the Timeline are listed here:</p><p>  <a href="timeline.html#Configuration_Options">timeline.html#Configuration_options</a></p>

<h2 id="Methods">Methods</h2><p>    The Graph2d supports the following methods.</p>
<table>    <tr>        <th>Method</th>        <th>Return Type</th>        <th>Description</th>    </tr>
    <tr>        <td>clear([what])</td>        <td>none</td>        <td>            Clear the Graph2d. An object can be passed specifying which sections to clear: items, groups,            and/or options. By Default, items, groups and options are cleared, i.e. <code>what = {items: true, groups: true, options: true}</code>. Example usage:
<pre class="prettyprint lang-js">Graph2d.clear();                // clear items, groups, and optionsGraph2d.clear({options: true}); // clear options only</pre>        </td>    </tr>
    <tr>        <td>destroy()</td>        <td>none</td>        <td>Destroy the Graph2d. The Graph2d is removed from memory. all DOM elements and event listeners are cleaned up.        </td>    </tr>
    <tr>        <td>getCustomTime()</td>        <td>Date</td>        <td>Retrieve the custom time. Only applicable when the option <code>showCustomTime</code> is true.        </td>    </tr>
    <tr>        <td>setCustomTime(time)</td>        <td>none</td>        <td>Adjust the custom time bar. Only applicable when the option <code>showCustomTime</code> is true. <code>time</code> is a Date object.        </td>    </tr>
    <tr>        <td>getLegend(groupId, iconWidth, iconHeight)</td>        <td>SVGelement, String, String</td>        <td>Returns an object containing an SVG element with the icon of the group (size determined by iconWidth and iconHeight), the label of the group (content) and the yAxisOrientation of the group (left or right).        </td>    </tr>
    <tr>        <td>getWindow()</td>        <td>Object</td>        <td>Get the current visible window. Returns an object with properties <code>start: Date</code> and <code>end: Date</code>.</td>    </tr>
    <tr>        <td>getItemRange()</td>        <td>Object</td>        <td>Get the range of all the items as an object containing <code>min: Date</code> and <code>max: Date</code>.</td>    </tr>
    <tr>        <td>fit()</td>        <td>none</td>        <td>Adjust the visible window such that it fits all items.        </td>    </tr>
    <tr>        <td>on(event, callback)</td>        <td>none</td>        <td>Create an event listener. The callback function is invoked every time the event is triggered. Avialable events: <code>rangechange</code>, <code>rangechanged</code>, <code>select</code>. The callback function is invoked as <code>callback(properties)</code>, where <code>properties</code> is an object containing event specific properties. See section <a href="#Events">Events for more information</a>.</td>    </tr>
    <tr>        <td>off(event, callback)</td>        <td>none</td>        <td>Remove an event listener created before via function <code>on(event, callback)</code>. See section <a href="#Events">Events for more information</a>.</td>    </tr>
    <tr>        <td>redraw()</td>        <td>none</td>        <td>Force a redraw of the Graph2d. Can be useful to manually redraw when option autoResize=false.        </td>    </tr>
    <tr>        <td>isGroupVisible(groupId)</td>        <td>Boolean</td>        <td>This checks if the visible option of the supplied group (by ID) is true or false.        </td>    </tr>
    <tr>        <td>setGroups(groups)</td>        <td>none</td>        <td>Set a data set with groups for the Graph2d.            <code>groups</code> can be an Array with Objects,            a DataSet, or a DataView. For each of the groups, the items of the            Graph2d are filtered on the property <code>group</code>, which            must correspond with the id of the group.        </td>    </tr>
    <tr>        <td>setItems(items)</td>        <td>none</td>        <td>Set a data set with items for the Graph2d.            <code>items</code> can be an Array with Objects,            a DataSet, or a DataView.        </td>    </tr>
    <tr>        <td>setOptions(options)</td>        <td>none</td>        <td>Set or update options. It is possible to change any option of the Graph2d at any time. You can for example switch orientation on the fly.        </td>    </tr>
    <tr>        <td>setWindow(start, end)</td>        <td>none</td>        <td>Set the current visible window. The parameters <code>start</code> and <code>end</code> can be a <code>Date</code>, <code>Number</code>, or <code>String</code>. If the parameter value of <code>start</code> or <code>end</code> is null, the parameter will be left unchanged.</td>    </tr>
</table>

<h2 id="Events">Events</h2><p>    Graph2d fires events when changing the visible window by dragging, when    selecting items, and when dragging the custom time bar.</p>
<p>    Here an example on how to listen for a <code>rangeChanged</code> event.</p>
<pre class="prettyprint lang-js">Graph2d.on('select', function (properties) {  alert('selected items: ' + properties.nodes);});</pre>
<p>    A listener can be removed via the function <code>off</code>:</p>
<pre class="prettyprint lang-js">function onChange (properties) {  alert('changed!');}
// add event listenerGraph2d.on('rangechanged', onChange);
// do stuff...
// remove event listenerGraph2d.off('rangechanged', onChange);</pre>

<p>    The following events are available.</p>
<table>    <colgroup>        <col style="width: 20%;">        <col style="width: 40%;">        <col style="width: 40%;">    </colgroup>
    <tr>        <th>name</th>        <th>Description</th>        <th>Properties</th>    </tr>
    <tr>        <td>rangechange</td>        <td>Fired repeatedly when the user is dragging the Graph2d window.        </td>        <td>            <ul>                <li><code>start</code> (Number): timestamp of the current start of the window.</li>                <li><code>end</code> (Number): timestamp of the current end of the window.</li>            </ul>        </td>    </tr>
    <tr>        <td>rangechanged</td>        <td>Fired once after the user has dragged the Graph2d window.        </td>        <td>            <ul>                <li><code>start</code> (Number): timestamp of the current start of the window.</li>                <li><code>end</code> (Number): timestamp of the current end of the window.</li>            </ul>        </td>    </tr>    <tr>        <td>timechange</td>        <td>Fired repeatedly when the user is dragging the custom time bar.            Only available when the custom time bar is enabled.        </td>        <td>            <ul>                <li><code>time</code> (Date): the current time.</li>            </ul>        </td>    </tr>
    <tr>        <td>timechanged</td>        <td>Fired once after the user has dragged the custom time bar.            Only available when the custom time bar is enabled.        </td>        <td>            <ul>                <li><code>time</code> (Date): the current time.</li>            </ul>        </td>    </tr>
</table>
<h2 id="Localization">Localization</h2><p>  Graph2d can be localized. For localization, Graph2d depends largely on the localization of <a href="http://momentjs.com">moment.js</a>. Locales are not included in vis.js by default. To enable localization, moment.js must be loaded with locales. Moment.js offers a bundle named "moment-with-locales.min.js" for this and there are various alternative ways to load locales.</p>
<p>  To set a locale for the Graph2d, specify the option <code>locale</code>:</p>
<pre class="prettyprint lang-js">var options = {  locale: 'nl'};</pre>
<h3>Create a new locale</h3>
To load a locale into the Graph2d not supported by default, one can add a new locale to the option <code>locales</code>:
<pre class="prettyprint lang-js">var options = {  locales: {    // create a new locale    mylocale: {      current: 'current',      time: 'time',    }  },
  // use the new locale  locale: 'mylocale'};</pre>
<h3 id="available-locales">Available locales</h3>
Graph2d comes with support for the following locales:
<table>  <tr><th>Language</th><th>Code</th></tr>  <tr>    <td>English</td>    <td>      <code>en</code><br>      <code>en_EN</code><br>      <code>en_US</code>    </td>  </tr>  <tr>    <td>Dutch</td>    <td>      <code>nl</code><br>      <code>nl_NL</code><br>      <code>nl_BE</code>    </td>  </tr></table>
<h2 id="Styles">Styles</h2><p>    All parts of the Graph2d have a class name and a default css style just like the Graph2d.    The styles can be overwritten, which enables full customization of the layout    of the Graph2d.</p><p>    Additionally, Graph2d has 10 preset styles for graphs, which are cycled through when loading groups. These styles can be overwritten    as well, along with defining your own classes to style the graphs! <a href="../examples/Graph2d/04_rightAxis.html">Example 4</a> and    <a href="../examples/Graph2d/05_bothAxis.html">example 5</a> show the usage of custom styles.</p>
<h2 id="Data_Policy">Data Policy</h2><p>    All code and data is processed and rendered in the browser.    No data is sent to any server.</p>
</div></body></html>