Date: Wed, 27 Sep 2017 12:42:48 -0400 Subject: removed lib --- www/lib/vis/docs/network/configure.html | 193 ---- www/lib/vis/docs/network/edges.html | 712 ------------ www/lib/vis/docs/network/groups.html | 177 --- www/lib/vis/docs/network/index.html | 1644 ---------------------------- www/lib/vis/docs/network/interaction.html | 172 --- www/lib/vis/docs/network/layout.html | 169 --- www/lib/vis/docs/network/manipulation.html | 204 ---- www/lib/vis/docs/network/nodes.html | 742 ------------- www/lib/vis/docs/network/physics.html | 224 ---- 9 files changed, 4237 deletions(-) delete mode 100644 www/lib/vis/docs/network/configure.html delete mode 100644 www/lib/vis/docs/network/edges.html delete mode 100644 www/lib/vis/docs/network/groups.html delete mode 100644 www/lib/vis/docs/network/index.html delete mode 100644 www/lib/vis/docs/network/interaction.html delete mode 100644 www/lib/vis/docs/network/layout.html delete mode 100644 www/lib/vis/docs/network/manipulation.html delete mode 100644 www/lib/vis/docs/network/nodes.html delete mode 100644 www/lib/vis/docs/network/physics.html (limited to 'www/lib/vis/docs/network') diff --git a/www/lib/vis/docs/network/configure.html b/www/lib/vis/docs/network/configure.html deleted file mode 100644 index 98be9e16..00000000 --- a/www/lib/vis/docs/network/configure.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - - - - - - vis.js - Configure documentation. - - - - - - - - - - - - - - - - - - - - - - - - - -

- -

- -

Network - configure

- -

Handles the HTML part of the canvas.

Options

The options for the canvas have to be contained in an object titled 'configure'.

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  configure: {
-    enabled: true,
-    filter: 'nodes,edges',
-    container: undefined,
-    showButton: true
-  }
-}
-
-network.setOptions(options);
-

- -

-// only the options that have shorthand notations are shown.
-var options = {
-  configure: 'nodes,edges'
-}
-
-network.setOptions(options);
-

- -

As shown above, alternative to supplying an object, you can supply a String, Array, Function or - Boolean. These will do the same as the filter option described below.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
enabled	Boolean	`true`	Toggle the configuration interface on or off. This is an optional parameter. If left undefined and any of the other properties of this object are defined, this will be set to true. -
filter	String, Array, Boolean, Function	`true`	When a boolean, true gives you all options, false will not show any. If a string is supplied, any - combination of the following is allowed: nodes, edges, layout, interaction, manipulation, physics, - selection, renderer. Feel free to come up with a fun seperating character. Finally, when supplied an - array of strings, any of the previously mentioned fields are accepted. - When supplying a function, you receive two arguments. The option and the path of the option within the options object. If it returns true, the options will be shown in the configurator. Example: - -function (option, path) { - return path.indexOf('physics') !== -1; -} - This only shows the physics options. -
container	DOM element	`undefined`	This allows you to put the configure list in another HTML container than below the network.
showButton	Boolean	`true`	Show the generate options button at the bottom of the configurator.

- -

- - - - - - - - - - - - - - - diff --git a/www/lib/vis/docs/network/edges.html b/www/lib/vis/docs/network/edges.html deleted file mode 100644 index 423f9a45..00000000 --- a/www/lib/vis/docs/network/edges.html +++ /dev/null @@ -1,712 +0,0 @@ - - - - - - - - - - vis.js - Edges documentation. - - - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - edges

- -

Handles the creation and deletion of edges and contains the global edge options and styles.

Options

- -

The options for the edges have to be contained in an object titled 'edges'. All of these options can be supplied per edge as well. Obviously, 'id' should not be defined globally but per edge. Options defined - in the global edges object, are applied to all edges. If an edge has options of its own, those will be used instead of the global options.

When you have given an edge an option, you will override the global option for that property. If you then set that option to null, - it will revert back to the default value. -

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  edges:{
-    arrows: {
-      to:     {enabled: false, scaleFactor:1, type:'arrow'},
-      middle: {enabled: false, scaleFactor:1, type:'arrow'},
-      from:   {enabled: false, scaleFactor:1, type:'arrow'}
-    },
-    arrowStrikethrough: true,
-    color: {
-      color:'#848484',
-      highlight:'#848484',
-      hover: '#848484',
-      inherit: 'from',
-      opacity:1.0
-    },
-    dashes: false,
-    font: {
-      color: '#343434',
-      size: 14, // px
-      face: 'arial',
-      background: 'none',
-      strokeWidth: 2, // px
-      strokeColor: '#ffffff',
-      align:'horizontal'
-    },
-    hidden: false,
-    hoverWidth: 1.5,
-    label: undefined,
-    labelHighlightBold: true,
-    length: undefined,
-    physics: true,
-    scaling:{
-      min: 1,
-      max: 15,
-      label: {
-        enabled: true,
-        min: 14,
-        max: 30,
-        maxVisible: 30,
-        drawThreshold: 5
-      },
-      customScalingFunction: function (min,max,total,value) {
-        if (max === min) {
-          return 0.5;
-        }
-        else {
-          var scale = 1 / (max - min);
-          return Math.max(0,(value - min)*scale);
-        }
-      }
-    },
-    selectionWidth: 1,
-    selfReferenceSize:20,
-    shadow:{
-      enabled: false,
-      color: 'rgba(0,0,0,0.5)',
-      size:10,
-      x:5,
-      y:5
-    },
-    smooth: {
-      enabled: true,
-      type: "dynamic",
-      roundness: 0.5
-    },
-    title:undefined,
-    width: 1,
-    value: undefined
-  }
-}
-
-network.setOptions(options);
-

- -

-// here all options that have shorthand notations are shown.
-var options = {
-  edges:{
-    arrows: 'to, from',
-    color: 'red',
-    font: '12px arial #ff0000',
-    scaling:{
-      label: true,
-    },
-    shadow: true,
-    smooth: true,
-  }
-}
-
-network.setOptions(options);
-

- -

These options can also be set per individual edge.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
arrows	Object or String	`undefined`	To draw an arrow with default settings a string can be supplied. For example: `arrows:'to, from, - middle'` or `'to;from'`, any combination with any seperating symbol is fine. If you - want to control the size of the arrowheads, you can supply an object. -
arrows.to	Object or Boolean	`Object`	When true, an arrowhead on the 'to' side of the edge is drawn, pointing to the 'to' node with default - settings. To customize the size of the arrow, supply an object. -
arrows.to.enabled	Boolean	`false`	Toggle the arrow on or off. This option is optional, if undefined and the scaleFactor property is set, - enabled will be set to true. -
arrows.to.scaleFactor	Number	`1`	The scale factor allows you to change the size of the arrowhead.
arrows.to.type	String	`arrow`	The type of endpoint. Default is `arrow`. Also possible is `circle`.
arrows.middle	Object or Boolean	`Object`	Exactly the same as the to object but with an arrowhead in the center of the edge.
arrows.from	Object or Boolean	`Object`	Exactly the same as the to object but with an arrowhead at the from node of the edge.
arrowStrikethrough	Boolean	`true`	When false, the edge stops at the arrow. This can be useful if you have thick lines and you want the arrow to end in a point. Middle arrows are not affected by this.
color	Object or String	`Object`	The color object contains the color information of the edge in every situation. When the edge only needs - a single color, a color value like `'rgb(120,32,14)'`, `'#ffffff'` or - `'red'` can be supplied instead of an object. -
color.color	String	`'#848484'`	The color of the border of the node when it is not selected or hovered over (assuming hover is - enabled in the interaction module). -
color.highlight	String	`'#848484'`	The color the edge when it is selected.
color.hover	String	`'#848484'`	The color the edge when the mouse hovers over it (assuming hover is enabled in the interaction - module). -
color.inherit	String or Boolean	`'from'`	When color, highlight or hover are defined, inherit is set to false! - Supported options are: `true, false, 'from','to','both'`. - The default value is 'from' which does the same as true: the edge will inherit the color from - the border of the node on the 'from' side. - When set to 'to', the border color from the 'to' node will be used. - When set to 'both', the color will fade from the from color to the to color. 'both' is - computationally intensive because the gradient is recomputed every redraw. This is required - because the angles change when the nodes move. -
color.opacity	Number	`1.0`	It can be useful to set the opacity of an edge without manually changing all the colors. The opacity - option will convert all colors (also when using inherit) to adhere to the supplied opacity. The allowed - range of the opacity option is between `0 and 1`. This is only done once so the performance - impact is not too big. -
dashes	Array or Boolean	`false`	When true, the edge will be drawn as a dashed line. You can customize the dashes by supplying an Array. - Array formart: Array of numbers, gap length, dash length, gap length, dash length, ... etc. The array is - repeated until the distance is filled. - When using dashed lines in IE versions older than 11, the line will be drawn straight, not smooth. -
font	Object or String	`false`	This object defines the details of the label. A shorthand is also supported in the form `'size face - color'` for example: `'14px arial red'`. -
font.color	String	`'#343434'`	Color of the label text.
font.size	Number	`14`	Size of the label text.
font.face	String	`'arial'`	Font face (or font family) of the label text.
font.background	String	`undefined`	When not `undefined` but a color string, a background rectangle will be drawn behind - the label in the supplied color. -
font.strokeWidth	Number	`2`	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. -
font.strokeColor	String	`'#ffffff'`	This is the color of the stroke assuming the value for stroke is higher than 0.
font.align	String	`'horizontal'`	Possible options: `'horizontal','top','middle','bottom'`. The alignment determines how the - label is aligned over the edge. The default value `horizontal` aligns the label horizontally, - regardless of the orientation of the edge. When an option other than `horizontal` is chosen, - the label will align itself according to the edge. -
from	Number or String		Edges are between two nodes, one to and one from. This is where you define the from node. You have to supply the corresponding node ID. This naturally only applies to individual edges.
hidden	Boolean	`false`	When true, the edge is not drawn. It is part still part of the physics simulation however!
hoverWidth	Number or Function	`0.5`	Assuming the hover behaviour is enabled in the interaction module, the - hoverWidth determines the width of the edge when the user hovers over it with the mouse. If a number is - supplied, this number will be added to the width. - Because the width can be altered by the value and the scaling functions, a constant multiplier or added - value may not give the best results. To solve this, you can supply a function. Example: - - -var options: { - edges: { - hoverWidth: function (width) {return width+1;} - } -} - - It receives the `Number width` of the edge. In this simple example we add 1 to the width. You - can taylor the logic in the function as long as it returns a `Number`. -
id	String	`undefined`	The id of the edge. The id is optional for edges. When not supplied, an UUID will be assigned to the edge. This naturally only applies to individual edges.
label	String	`undefined`	The label of the edge. HTML does not work in here because the network uses HTML5 Canvas.
labelHighlightBold	Boolean	`true`	Determines whether or not the label becomes bold when the edge is selected.
length	Number	`undefined`	The physics simulation gives edges a spring length. This value can override the length of the spring in - rest. -
physics	Boolean	`true`	When true, the edge is part of the physics simulation. When false, it will not act as a spring.
scaling	Object	`Object`	If the `value` option is specified, the width of the edges will be scaled according to the - properties in this object. Keep in mind that when using scaling, the `width` option is - neglected. -
scaling.min	Number	`1`	If edges have a value, their widths are determined by the value, the scaling function and the min max - values. The min value is the minimum allowed value. -
scaling.max	Number	`15`	This is the maximum allowed width when the edges are scaled using the value option.
scaling.label	Object or Boolean	`Object`	When false, the label is not allowed to scale with the edge. If true it will scale using default - settigns. For further customization, you can supply an object. -
scaling.label.enabled	Boolean	`false`	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. -
scaling.label.min	Number	`14`	The minimum font-size used for labels when scaling.
scaling.label.max	Number	`30`	The maximum font-size used for labels when scaling.
scaling.label.maxVisible	Number	`30`	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%. -
scaling.label.drawThreshold	Number	`5`	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 - edges when zoomed out and only show the rest when zooming in. -
scaling.customScalingFunction	Function	in description	If edges have `value` fields, this function determines how the size of the nodes are scaled - based on their values. The default function is: - -function (min,max,total,value) { - if (max === min) { - return 0.5; - } - else { - var scale = 1 / (max - min); - return Math.max(0,(value - min)scale); - } -} - - 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. It has to return a value between 0 and 1.* The - nodes and edges then calculate their size as follows: - -var scale = customScalingFunction(min,max,total,value); -var diff = maxWidth - minWidth; -myWidth = minWidth + diff * scale; - - Please note: `maxWidth` and `minWidth` are the values `scaling.max` - and `scaling.min` provided in the options. -
selectionWidth	Number or Function	`1`	The selectionWidth determines the width of the edge when the edge is selected. If a number is supplied, - this number will be added to the width. - Because the width can be altered by the value and the scaling functions, a constant multiplier or added - value may not give the best results. To solve this, you can supply a function. Example: - - -var options: { - edges: { - selectionWidth: function (width) {return width*2;} - } -} - - It receives the `Number width` of the edge. In this simple example multiply the width by 2. - You can taylor the logic in the function as long as it returns a `Number`. -
selfReferenceSize	Number	`false`	When the to and from nodes are the same, a circle is drawn. This is the radius of that circle.
shadow	Object or Boolean	`Object`	When true, the edge casts a shadow using the default settings. This can be further refined by supplying - an object. -
shadow.enabled	Boolean	`false`	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. -
shadow.color	String	`'rgba(0,0,0,0.5)'`	The color size of the shadow as a string. Supported formats are 'rgb(255,255,255)', 'rgba(255,255,255,1)' and '#FFFFFF'.
shadow.size	Number	`10`	The blur size of the shadow.
shadow.x	Number	`5`	The x offset.
shadow.y	Number	`5`	The y offset.
smooth	Object or Boolean	`Object`	When true, the edge is drawn as a dynamic quadratic bezier curve. The drawing of these curves takes longer than - that of straight curves but it looks better. - There is a difference between dynamic smooth curves and static smooth curves. The dynamic smooth curves - have an invisible support node that takes part in the physics simulation. If you have a lot of edges, - you may want to consider picking a different type of smooth curves then dynamic for better performance. -
smooth.enabled	Boolean	`true`	Toggle smooth curves on and off. This is an optional option. If any of the other properties in this - object are set, this option will be set to true. -
smooth.type	String	`'dynamic'`	Possible options: `'dynamic', 'continuous', 'discrete', 'diagonalCross', 'straightCross', 'horizontal', - 'vertical', 'curvedCW', 'curvedCCW', 'cubicBezier'`. Take a look at our example 26 to see what these look like - and pick the one that you like best! - - When using dynamic, the edges will have an invisible support node guiding the shape. This node is part of the - physics simulation. -
smooth.forceDirection	String or Boolean	`false`	Accepted options: `['horizontal', 'vertical', 'none']`. This options is only used with the cubicBezier curves. When true, horizontal is chosen, when false, - the direction that is larger (x distance between nodes vs y distance between nodes) is used. If the x distance is larger, horizontal. This is ment to be used with hierarchical layouts. -
smooth.roundness	Number	`0.5`	Accepted range: `0 .. 1.0`. This parameter tweaks the roundness of the smooth curves for all types EXCEPT dynamic. -
title	String	`undefined`	The title is shown in a pop-up when the mouse moves over the edge.
to	Number or String		Edges are between two nodes, one to and one from. This is where you define the to node. You have to supply the corresponding node ID. This naturally only applies to individual edges.
value	Number	`undefined`	When a value is set, the edges' width will be scaled using the options in the scaling object defined - above. -
width	Number	`1`	The width of the edge. If value is set, this is not used.

- -

- - - - - - - - - - - - - - - diff --git a/www/lib/vis/docs/network/groups.html b/www/lib/vis/docs/network/groups.html deleted file mode 100644 index caa8d178..00000000 --- a/www/lib/vis/docs/network/groups.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - - - vis.js - Groups documentation. - - - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - groups

- -

Handles the group styling.

Options

- -

The options for the canvas have to be contained in an object titled 'groups'.

Click on the options shown to show how these options are supposed to be used.

options hidden
options shown

-
-

-var options = {
-  groups:{
-    useDefaultGroups: true,
-    myGroupId:{
-      /*node options*/
-    }
-  }
-}
-
-network.setOptions(options);
-

All of the individual options are explained here:

- - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
useDefaultGroups	Boolean	`true`	If your nodes have groups defined that are not in the Groups module, the module loops over the groups it - does have, allocating one for each unknown group. When all are used, it goes back to the first group. By - setting this to false, the default groups will not be used in this cycle. -
group*	Object		- You can add multiple groups containing styling information that applies to a certain subset of groups. - All options described in the nodes module that make sense can be used here - (you're not going to set the same id or x,y position for a group of nodes). - Example: - -var nodes = [ - {id:1, group:'myGroup', label:"I'm in a custom group called 'myGroup'!"} -] - -var options = { - groups: { - myGroup: {color:{background:'red'}, borderWidth:3} - } -} - - *) the option is not called group, as shown by the example but can by any custom id, except for - 'useDefaultGroups'. -

- -

- - - - - - - - - - - - - - - \ No newline at end of file diff --git a/www/lib/vis/docs/network/index.html b/www/lib/vis/docs/network/index.html deleted file mode 100644 index cfd03d64..00000000 --- a/www/lib/vis/docs/network/index.html +++ /dev/null @@ -1,1644 +0,0 @@ - - - - - - - - - - vis.js - Network documentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network

- -

Network is a visualization to display networks and networks consisting of nodes and edges. The visualization - is easy to use and supports custom shapes, styles, colors, sizes, images, and more. - - The network visualization works smooth on any modern browser for up to a few thousand nodes and edges. To - handle a larger amount of nodes, Network has clustering support. Network uses HTML canvas for rendering.

- -

As of 4.0, the network consists of individual modules which handle specific parts of the network. These modules - have their own docs, options, methods and events which you can access - by clicking on the modules in the list below.

- - Show the getting started! -

Creating a Network

- -

- Creating a vis network is easy. It requires you to - include the vis.js and css files which you can get here. If you have these - added to your application, you will need to specify your nodes and edges. You can use DOT language or export - nodes and edges from Gephi if you'd like but we will do it without these for now. - For more information on this click the tabs below. You can also use the vis.DataSets for dynamic data binding, - for instance, changing the color, label or any option after you have initialized the network. -

- Once you have the data, all you need is a container div to tell vis where to put your network. Additionally you - can use an options object to customize many aspects of the network. In code this - looks like this:

- -

-<html>
-<head>
-    <script type="text/javascript" src="../../dist/vis.js"></script>
-    <link href="../../dist/vis.css" rel="stylesheet" type="text/css" />
-
-    <style type="text/css">
-        #mynetwork {
-            width: 600px;
-            height: 400px;
-            border: 1px solid lightgray;
-        }
-    </style>
-</head>
-<body>
-<div id="mynetwork"></div>
-
-<script type="text/javascript">
-    // create an array with nodes
-    var nodes = new vis.DataSet([
-        {id: 1, label: 'Node 1'},
-        {id: 2, label: 'Node 2'},
-        {id: 3, label: 'Node 3'},
-        {id: 4, label: 'Node 4'},
-        {id: 5, label: 'Node 5'}
-    ]);
-
-    // create an array with edges
-    var edges = new vis.DataSet([
-        {from: 1, to: 3},
-        {from: 1, to: 2},
-        {from: 2, to: 4},
-        {from: 2, to: 5}
-    ]);
-
-    // create a network
-    var container = document.getElementById('mynetwork');
-
-    // provide the data in the vis format
-    var data = {
-        nodes: nodes,
-        edges: edges
-    };
-    var options = {};
-
-    // initialize your network!
-    var network = new vis.Network(container, data, options);
-</script>
-</body>
-</html>
-

The result of the code above will be the basic example which is shown here.

- -
-

- -

Modules
Options
Method Reference -
- Global
- Canvas
- Clustering
- Layout
- Manipulation
- Information
- Physics
- Selection
- Viewport
- Configurator
-
Events
Importing Data -
- from Gephi
- from DOT language
-

- -

Modules

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

configure	Generates an interactive option editor with filtering.
edges	Handles the creation and deletion of edges and contains the global edge options and styles.
groups	Contains the groups and some options on how to handle nodes with non-existing groups.
interaction	Used for all user interaction with the network. Handles mouse and touch events and selection as well as - the navigation buttons and the popups. -
layout	Governs the initial and hierarchical positioning.
manipulation	Supplies an API and optional GUI to alter the data in the network.
nodes	Handles the creation and deletion of nodes and contains the global node options and styles.
physics	Does all the simulation moving the nodes and edges to their final positions, also governs - stabilization. -

- -
- -

Options

-var options = {
-  autoResize: true,
-  height: '100%',
-  width: '100%'
-  locale: 'en',
-  locales: locales,
-  clickToUse: false,
-  configure: {...},    // defined in the configure module.
-  edges: {...},        // defined in the edges module.
-  nodes: {...},        // defined in the nodes module.
-  groups: {...},       // defined in the groups module.
-  layout: {...},       // defined in the layout module.
-  interaction: {...},  // defined in the interaction module.
-  manipulation: {...}, // defined in the manipulation module.
-  physics: {...},      // defined in the physics module.
-}
-
-network.setOptions(options);
-

The individual options are explained below. The ones referring to modules are explained in the corresponding - module.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
autoResize	Boolean	`true`	If true, the Network will automatically detect when its container is resized, and redraw itself - accordingly. If false, the Network can be forced to repaint after its container has been resized - using the function redraw() and setSize(). -
width	String	`'100%'`	the width of the canvas. Can be in percentages or pixels (ie. `'400px'`).
height	String	`'100%'`	the height of the canvas. Can be in percentages or pixels (ie. `'400px'`).
locale	String	`'en'`	Select the locale. By default, the language is English. -
locales	Object	defaultLocales	Locales object. By default - `'en'`, - `'de'`, - `'es'`, - `'it'`, - `'nl'` - `'pt-br'`, - `'ru'` - are supported. Take a look at the - locales section below - for more explaination on how to customize this. -
clickToUse	Boolean	false	When a Network is configured to be `clickToUse`, it will react to mouse and touch events only when active. When active, a blue shadow border is displayed around the Network. The network is set active by clicking on it, and is changed to inactive again by clicking outside the Network or by pressing the ESC key. -
configure	Object	Object	All options in this object are explained in the configure module. -
edges	Object	Object	All options in this object are explained in the edges module. -
nodes	Object	Object	All options in this object are explained in the nodes module. -
groups	Object	Object	All options in this object are explained in the groups module. -
layout	Object	Object	All options in this object are explained in the layout module. -
interaction	Object	Object	All options in this object are explained in the interaction module. -
manipulation	Object	Object	All options in this object are explained in the manipulation module. -
physics	Object	Object	All options in this object are explained in the physics module. -

- -
-
-

Custom locales

- -

The locales object has the following format:

-var locales = {
-  en: {
-    edit: 'Edit',
-    del: 'Delete selected',
-    back: 'Back',
-    addNode: 'Add Node',
-    addEdge: 'Add Edge',
-    editNode: 'Edit Node',
-    editEdge: 'Edit Edge',
-    addDescription: 'Click in an empty space to place a new node.',
-    edgeDescription: 'Click on a node and drag the edge to another node to connect them.',
-    editEdgeDescription: 'Click on the control points and drag them to a node to connect to it.',
-    createEdgeError: 'Cannot link edges to a cluster.',
-    deleteClusterError: 'Clusters cannot be deleted.',
-    editClusterError: 'Clusters cannot be edited.'
-  }
-}

If you want to define your own locale, you can change the key ('en' here) and change all the strings. You can - then use your new key in the locale option.

Methods

- -

This is a list of all the methods in the public API. They have been grouped by category, which correspond to - the - modules listed above.

Global methods for the network.
destroy()
Returns: none	Remove the network from the DOM and remove all Hammer bindings and references.
setData({`nodes: vis - DataSet/Array`,`edges: vis - DataSet/Array`}) -
Returns: none	Override all the data in the network. If stabilization is enabled in the physics - module, the network will stabilize again. This method is also performed when first initializing - the - network. -
setOptions(`Object - options`) -
Returns: none	Set the options. All available options can be found in the modules above. Each module requires it's - own - container with the module name to contain its options. -
on(`String event name, Function callback`) -
Returns: none	Set an event listener. Depending on the type of event you get different parameters for the callback function. Look at the event section of the documentation for more information. -
off(`String event name, Function callback`) -
Returns: none	Remove an event listener. The function you supply has to be the exact same as the one you used in the on function. If no function is supplied, all listeners will be removed. Look at the event section of the documentation for more information. -
once(`String event name, Function callback`) -
Returns: none	Set an event listener only once. After it has taken place, the event listener will be removed. Depending on the type of event you get different parameters for the callback function. Look at the event section of the documentation for more information. -
Methods related to the canvas.
canvasToDOM({`x: - Number`,`y: - Number`}) -
Returns: Object	This function converts canvas coordinates to coordinates on the DOM. Input and output are in the - form of - `{x:Number,y:Number}`. The DOM values are relative to the network container. -
DOMtoCanvas({`x: - Number`,`y: - Number`}) -
Returns: Object	This function converts DOM coordinates to coordinates on the canvas. Input and output are in the - form of - `{x:Number,y:Number}`. The DOM values are relative to the network container. -
redraw()
Returns: none	Redraw the network.
setSize(`String - width`,`String - height`) -
Returns: none	Set the size of the canvas. This is automatically done on a window resize.
Clustering
cluster( - `Object options`) -
Returns: none	The options object is explained in full below. The joinCondition - function - is presented with all nodes. -
clusterByConnection( - `String nodeId`, - `[Object options]` - ) -
Returns: none	This method looks at the provided node and makes a cluster of it and all it's connected nodes. The - behaviour can be customized by proving the options object. All options of this object are explained - below. The joinCondition is only presented with the connected - nodes. -
clusterByHubsize( - `[Number hubsize]`, - `[Object options]`) -
Returns: none	This method checks all nodes in the network and those with a equal or higher amount of edges than - specified with the `hubsize` qualify. If a hubsize is not defined, the hubsize will be determined as the average - value plus two standard deviations. - - For all qualifying nodes, clusterByConnection is performed on each of them. - The options object is described for `clusterByConnection` and does the same here. -
clusterOutliers( - `[Object options]`) -
Returns: none	This method will cluster all nodes with 1 edge with their respective connected node. - The options object is explained in full below. -
findNode( - `String nodeId`) -
Returns: Array	Nodes can be in clusters. Clusters can also be in clusters. This function returns and array of - nodeIds - showing where the node is. Example: - cluster 'A' contains cluster 'B', - cluster 'B' contains cluster 'C', - cluster 'C' contains node 'fred'. - `network.clustering.findNode('fred')` will return `['A','B','C','fred']`. -
getClusteredEdges( - `String baseEdgeId`) -
Returns: Array	Similiar to `findNode` in that it returns all the edge ids that were created from the provided edge during clustering -
getBaseEdge( - `String clusteredEdgeId`) -
Returns: Value	When a clusteredEdgeId is available, this method will return the original baseEdgeId provided in `data.edges` - ie. After clustering the 'SelectEdge' event is fired but provides only the clustered edge. This method can then be used to return the baseEdgeId. -
updateEdge( - `String startEdgeId, Object options`) -
Returns: none	Visible edges between clustered nodes are not the same edge as the ones provided in `data.edges` passed on `network` creation - With each layer of clustering, copies of the edges between clusters are created and the previous edges are hidden, until the cluster is opened. - This method takes an edgeId (ie. a base edgeId from data.edges) and applys the options to it and any edges that were created from it while clustering. Example: - `network.clustering.updateEdge(originalEdge.id, {color : '#aa0000'});` - This would turn the base edge and any subsequent edges red, so when opening clusters the edges will all be the same color. -
updateClusteredNode( - `String clusteredNodeId, Object options`) -
Returns: none	Clustered Nodes when created are not contained in the original `data.nodes` passed on `network` creation - This method updates the cluster node. Example: - `network.clustering.updateClusteredNode(clusteredNodeId, {shape : 'star'});` -
isCluster( - `String nodeId`) -
Returns: Boolean	Returns true if the node whose ID has been supplied is a cluster.
getNodesInCluster( - `String clusterNodeId`) -
Returns: Array	Returns an array of all nodeIds of the nodes that would be released if you open the cluster. -
openCluster( - `String nodeId, Object options`) -
Returns: none	Opens the cluster, releases the contained nodes and edges, removing the cluster node and cluster - edges. The options object is optional and currently supports one option, releaseFunction, which is a function that can be used to manually - position the nodes after the cluster is opened. - -function releaseFunction (clusterPosition, containedNodesPositions) { - var newPositions = {}; - // clusterPosition = {x:clusterX, y:clusterY}; - // containedNodesPositions = {nodeId:{x:nodeX,y:nodeY}, nodeId2....} - newPositions[nodeId] = {x:newPosX, y:newPosY}; - return newPositions; -} - The containedNodesPositions contain the positions of the nodes in the cluster at the moment they were clustered. - This function is expected to return the newPositions, which can be the containedNodesPositions (altered) or a new object. This has to be an object with keys equal - to the nodeIds that exist in the containedNodesPositions and an `{x:x,y:y}` position object. - - For all nodeIds not listed in this returned object, we will position them at the location of the cluster. This is also the default behaviour when no releaseFunction is defined. -
Layout
getSeed()
Returns: Number	If you like the layout of your network and would like it to start in the same way next time, ask for - the - seed using this method and put it in the `layout.randomSeed` option. -
Manipulation methods to use the manipulation system without GUI.
enableEditMode()
Returns: none	Programatically enable the edit mode. Similar effect to pressing the edit button.
disableEditMode()
Returns: none	Programatically disable the edit mode. Similar effect to pressing the close icon (small cross in the - corner of the toolbar). -
addNodeMode()
Returns: none	Go into addNode mode. Having edit mode or manipulation enabled is not required. To get out of this - mode, - call `disableEditMode()`. The callback functions defined in `handlerFunctions` - still apply. To use these methods without having the manipulation GUI, make sure you set - `enabled` to false. -
editNode()
Returns: none	Edit the selected node. The explaination from `addNodeMode` applies here as well.
addEdgeMode()
Returns: none	Go into addEdge mode. The explaination from `addNodeMode` applies here as well.
editEdgeMode()
Returns: none	Go into editEdge mode. The explaination from `addNodeMode` applies here as well.
deleteSelected()
Returns: none	Delete selected. Having edit mode or manipulation enabled is not required.
Methods to get information on nodes and edges.
getPositions(`[Array of - nodeIds]`) -
Returns: Object	Returns the x y positions in canvas space of the nodes with the supplied nodeIds as an object: - -{ - nodeId1: {x: xValue, y:yValue}, - nodeId2: {x: xValue, y:yValue}, - ... -} - - 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. -
storePositions()
Returns: none	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. 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. - - If the nodes are still moving and you're using dynamic smooth edges (which is on by default), you - can - use the option `stabilization.onlyDynamicEdges` in the physics - module - to improve initialization time. - - This method does not support clustering. At the moment it is not possible to cache - positions when using clusters since they cannot be correctly initialized from just the - positions. -
moveNode(`nodeId, Number x, Number y`)
Returns: none	You can use this to programatically move a node. The supplied x and y positions have to be in canvas space! -
getBoundingBox(`String - nodeId`) -
Returns: Object	Returns a bounding box for the node including label in the format: - -{ - top: Number, - left: Number, - right: Number, - bottom: Number -} - - These values are in canvas space. -
getConnectedNodes(`String - nodeId or edgeId`) -
Returns: Array	Returns an array of nodeIds of the all the nodes that are directly connected to this node. If you supply an edgeId, - vis will first match the id to nodes. If no match is found, it will search in the edgelist and return an array: `[fromId, toId]`.
getConnectedEdges(`String - nodeId`) -
Returns: Array	Returns an array of edgeIds of the edges connected to this node.
Physics methods to control when the simulation should run.
startSimulation()
Returns: none	Start the physics simulation. This is normally done whenever needed and is only really useful if you - stop the simulation yourself and wish to continue it afterwards. -
stopSimulation()
Returns: none	This stops the physics simulation and triggers a `stabilized` event. It can be restarted - by - dragging a node, altering the dataset or calling `startSimulation()`. -
stabilize([iterations])
Returns: none	You can manually call stabilize at any time. All the stabilization options above are used. You can optionally supply the number of iterations it should do.
Selection methods for nodes and edges.
getSelection()
Returns: Object	Returns an object with selected nodes and edges ids like this: - -{ - nodes: [Array of selected nodeIds], - edges: [Array of selected edgeIds] -} -
getSelectedNodes()
Returns: Array	Returns an array of selected node ids like so: - `[nodeId1, nodeId2, ..]`. -
getSelectedEdges()
Returns: Array	Returns an array of selected edge ids like so: `[edgeId1, edgeId2, ..]`.
getNodeAt(`{x: xPosition - DOM, y: yPosition DOM}`) -
Returns: String	Returns a nodeId or undefined. The DOM positions are expected to be in pixels from the top left - corner - of the canvas. -
getEdgeAt(`{x: xPosition - DOM, y: yPosition DOM}`) -
Returns: String	Returns a edgeId or undefined. The DOM positions are expected to be in pixels from the top left - corner - of the canvas.. -
selectNodes(`Array with - nodeIds`,`[Boolean - highlightEdges]`) -
Returns: none	Selects the nodes corresponding to the id's in the input array. If highlightEdges is true or - undefined, - the neighbouring edges will also be selected. This method unselects all other objects before - selecting - its own objects. Does not fire events. -
selectEdges(`Array with - edgeIds`) -
Returns: none	Selects the edges corresponding to the id's in the input array. This method unselects all other - objects - before selecting its own objects. Does not fire events. -
setSelection( - `Object selection`, - `[Object options]`)
Returns: none	Sets the selection, wich must be an object like this: - -{ - nodes: [Array of nodeIds], - edges: [Array of edgeIds] -} - You can also pass only `nodes` or `edges` in `selection` object. - Available options are: - -{ - unselectAll: Boolean, - highlightEdges: Boolean -} -
unselectAll()
Returns: none	Unselect all objects. Does not fire events.
Methods to control the viewport for zoom and animation.
getScale()
Returns: Number	Returns the current scale of the network. 1.0 is comparible to 100%, 0 is zoomed out infinitely. -
getViewPosition()
Returns: Object	Returns the current central focus point of the view in the form: `{ x: {Number}, y: {Number} }`
fit(`[Object - options]`) -
Returns: none	Zooms out so all nodes fit on the canvas. You can supply options to customize this: - -{ - nodes:[Array of nodeIds], - animation: { // -------------------> can be a boolean too! - duration: Number - easingFunction: String - } -} - - The nodes can be used to zoom to fit only specific nodes in the view. - The other options are explained in the `moveTo()` description below. - All options are optional for the fit method. -
focus( - `String nodeId`, - `[Object options]`) -
Returns: none	You can focus on a node with this function. What that means is the view will lock onto that node, if - it - is moving, the view will also move accordingly. If the view is dragged by the user, the focus is - broken. - You can supply options to customize the effect: - -{ - scale: Number, - offset: {x:Number, y:Number} - locked: boolean - animation: { // -------------------> can be a boolean too! - duration: Number - easingFunction: String - } -} - - All options except for locked are explained in the `moveTo()` description below. Locked - denotes whether or not the view remains locked to the node once the zoom-in animation is finished. - Default value is true. The options object is optional in the focus method. -
moveTo(`Object - options`) -
Returns: none	You can animate or move the camera using the moveTo method. Options are: - -{ - position: {x:Number, y:Number}, - scale: Number, - offset: {x:Number, y:Number} - animation: { // -------------------> can be a boolean too! - duration: Number - easingFunction: String - } -} - - The position (in canvas units!) is the position of the central focus point of the camera. - The scale is the target zoomlevel. Default value is 1.0. - The offset (in DOM units) is how many pixels from the center the view is focussed. Default value is - {x:0,y:0}. - For animation you can either use a Boolean to use it with the default options or disable it or you - can - define the duration (in milliseconds) and easing function manually. Available are: - `linear, easeInQuad, easeOutQuad, easeInOutQuad, easeInCubic, easeOutCubic, easeInOutCubic, - easeInQuart, easeOutQuart, easeInOutQuart, easeInQuint, easeOutQuint, easeInOutQuint`. - - You will have to define at least a scale, position or offset. Otherwise, there is nothing to move - to. -
releaseNode()
Returns: none	Programatically release the focussed node.
Methods to use with the configurator module.
getOptionsFromConfigurator()
Returns: Object	If you use the configurator, you can call this method to get an options object that contains all differences from the default options - caused by users interacting with the configurator. -

- -
-
- -

Cluster methods options object

- -

The options object supplied to the cluster functions can contain these properties:

- - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Description
joinCondition( `nodeOptions: Object` )	Function	Optional for all but the cluster method. The cluster module loops over all nodes that are - selected to be in the cluster and calls this function with their data as argument. - If this function returns true, this node will be added to the cluster. You have access to all - options - (including the default) - as well as any custom fields you may have added to the node to determine whether or not to include - it in - the cluster. Example: - -var nodes = [ - {id: 4, label: 'Node 4'}, - {id: 5, label: 'Node 5'}, - {id: 6, label: 'Node 6', cid:1}, - {id: 7, label: 'Node 7', cid:1} -] - -var options = { - joinCondition:function(nodeOptions) { - return nodeOptions.cid === 1; - } -} - -network.clustering.cluster(options); - -
processProperties( `clusterOptions: Object`, - `childNodesOptions: Array`, - `childEdgesOptions: Array` )	Function	Optional. Before creating the new cluster node, this (optional) function will be called with - the - properties supplied by you (`clusterNodeProperties`), all contained nodes and all - contained - edges. You can use this to update the - properties of the cluster based on which items it contains. The function should return the - properties to - create the cluster node. In the example below, we ensure preservation of mass and value when forming - the - cluster: - -var options = { - processProperties: function (clusterOptions, - childNodes, childEdges) { - var totalMass = 0; - var totalValue = 0; - for (var i = 0; i < childNodes.length; i++) { - totalMass += childNodes[i].mass; - totalValue = childNodes[i].value - ? totalValue + childNodes[i].value - : totalValue; - } - clusterOptions.mass = totalMass; - if (totalValue > 0) { - clusterOptions.value = totalValue; - } - return clusterOptions; - }, -} - -
clusterNodeProperties	Object	Optional. This is an object containing the options for the cluster node. All options - described - in the nodes module are allowed. This allows you to style your cluster - node - any way you want. This is also the style object that is provided in the processProperties function - for - fine tuning. If undefined, default node options will be used. - Default functionality only allows clustering if the cluster will contain 2 or more nodes. To allow clustering of single nodes you can use the `allowSingleNodeCluster : true` property. - - clusterNodeProperties: { - allowSingleNodeCluster: true - } - -
clusterEdgeProperties	Object	Optional. This is an object containing the options for the edges connected to the cluster. - All - options described in the edges module are allowed. Using this, you can - style - the edges connecting to the cluster any way you want. If none are provided, the options from the - edges - that are replaced are used. If undefined, default edge options will be used. -

Events

- -

This is a list of all the events in the public API. They are collected here from all individual modules.

- -

These events are fired by the interaction module. They are related to user input.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Properties	Description
Events triggered by human interaction, selection, dragging etc.
click	- Object -	Fired when the user clicks the mouse or taps on a touchscreen device. Passes an object with properties structured as: - - { - nodes: [Array of selected nodeIds], - edges: [Array of selected edgeIds], - event: [Object] original click event, - pointer: { - DOM: {x:pointer_x, y:pointer_y}, - canvas: {x:canvas_x, y:canvas_y} - } -} - -
doubleClick	same as `click`.	Fired when the user double clicks the mouse or double taps on a touchscreen device. Since a double - click - is in fact 2 clicks, 2 click events are fired, followed by a double click event. If you do not want - to - use the click events if a double click event is fired, just check the time between click events - before - processing them. -
oncontext	same as `click`.	Fired when the user click on the canvas with the right mouse button. The right mouse button does not - select by default. You can use the method `getNodeAt` to select the node if you - want. -
hold	same as `click`.	Fired when the user clicks and holds the mouse or taps and holds on a touchscreen device. A click - event - is also fired in this case. -
release	same as `click`.	Fired after drawing on the canvas has been completed. Can be used to draw on top of the network. -
select	same as `click`.	Fired when the selection has changed by user action. This means a node or edge has been selected, - added - to the selection or deselected. All select events are only triggered on click and hold. -
selectNode	same as `click`.	Fired when a node has been selected by the user.
selectEdge	same as `click`.	Fired when a edge has been selected by the user.
deselectNode	Object -	Fired when a node (or nodes) has (or have) been deselected by the user. The previous selection is the list of nodes and edges that were selected before the last user event. Passes an object with properties structured as: - { - nodes: [Array of selected nodeIds], - edges: [Array of selected edgeIds], - event: [Object] original click event, - pointer: { - DOM: {x:pointer_x, y:pointer_y}, - canvas: {x:canvas_x, y:canvas_y} - } - }, - previousSelection: { - nodes: [Array of previously selected nodeIds], - edges: [Array of previously selected edgeIds] - } -} - -
deselectEdge	same as `deselectNode`.	Fired when a edge (or edges) has (or have) been deselected by the user. The previous selection is - the - list of nodes and edges that were selected before the last user event. -
dragStart	same as `click`.	Fired when starting a drag.
dragging	same as `click`.	Fired when dragging node(s) or the view.
dragEnd	same as `click`.	Fired when the drag has finished.
hoverNode	`{node: nodeId}`	Fired if the option `interaction:{hover:true}` is enabled and the mouse hovers over a node.
blurNode	`{node: nodeId}`	Fired if the option `interaction:{hover:true}` is enabled and the mouse moved away from a node it was hovering over before.
hoverEdge	`{edge: edgeId}`	Fired if the option `interaction:{hover:true}` is enabled and the mouse hovers over an edge.
blurEdge	`{edge: edgeId}`	Fired if the option `interaction:{hover:true}` is enabled and the mouse moved away from an edge it was hovering over before.
zoom	`{direction:'+'/'-', scale: Number}`	Fired when the user zooms in or out. The properties tell you which direction the zoom is in. The scale is a number greater than 0, which is the same that you get with network.getScale().
showPopup	`id of item corresponding to popup`	Fired when the popup (tooltip) is shown.
hidePopup	none	Fired when the popup (tooltip) is hidden.
Events triggered the physics simulation. Can be used to trigger GUI updates.
startStabilizing	none	Fired when stabilization starts. This is also the case when you drag a node and the physics - simulation - restarts to stabilize again. Stabilization does not neccesarily imply 'without showing'. -
stabilizationProgress	Object	Fired when a multiple of the `updateInterval` number of iterations is reached. This only occurs in the 'hidden' stabilization. Passes an object with properties structured as: - - { - iterations: Number // iterations so far, - total: Number // total iterations in options -} -
stabilizationIterationsDone	none	Fired when the 'hidden' stabilization finishes. This does not necessarily mean the network is stabilized; it could also mean that the amount of iterations defined in the options has been reached. -
stabilized	Object	Fired when the network has stabilized or when the `stopSimulation()` has been called. The amount of iterations it took could be used to tweak the maximum amount of iterations needed to stabilize the network. Passes an object with properties structured as: - { - iterations: Number // iterations it took -} - -
Event triggered by the canvas.
resize	Object	Fired when the size of the canvas has been resized, either by a redraw call when the container div has changed in size, a setSize() call with new values or a setOptions() with new width and/or height values. Passes an object with properties structured as: - - -{ - width: Number // the new width of the canvas - height: Number // the new height of the canvas - oldWidth: Number // the old width of the canvas - oldHeight: Number // the old height of the canvas -} - -
Events triggered by the rendering module. Can be used to draw custom elements on the - canvas. -
initRedraw	none	Fired before the redrawing begins. The simulation step has completed at this point. Can be used to - move - custom elements before starting drawing the new frame. -
beforeDrawing	`canvas context`	Fired after the canvas has been cleared, scaled and translated to the viewing position but before - all - edges and nodes are drawn. Can be used to draw behind the network. -
afterDrawing	`canvas context`	Fired after drawing on the canvas has been completed. Can be used to draw on top of the network. -
Event triggered by the view module.
animationFinished	none	Fired when an animation is finished.
Event triggered by the configuration module.
configChange	Object	Fired when a user changes any option in the configurator. The options object can be used with the setOptions method or stringified using JSON.stringify(). - You do not have to manually put the options into the network: this is done automatically. You can use the event - to store user options in the database. -

- -

Importing data

- -

Network contains conversion utilities to import data from Gephi and graphs in the DOT language.

- -

Import data from Gephi

- -

- Network can import data straight from an exported json file from gephi. You can get the JSON exporter here: - https://marketplace.gephi.org/plugin/json-exporter/. - An example exists showing how to get a JSON file into Vis: -

- -

- Example usage: -

- -

-// load the JSON file containing the Gephi network.
-var gephiJSON = loadJSON("./datasources/WorldCup2014.json"); // code in importing_from_gephi.
-
-// you can customize the result like with these options. These are explained below.
-// These are the default options.
-var parserOptions = {
-  edges: {
-    inheritColors: false
-  },
-  nodes: {
-    fixed: true,
-    parseColor: false
-  }
-}
-
-// parse the gephi file to receive an object
-// containing nodes and edges in vis format.
-var parsed = vis.network.convertGephi(gephiJSON, parserOptions);
-
-// provide data in the normal fashion
-var data = {
-  nodes: parsed.nodes,
-  edged: parsed.edges
-};
-
-// create a network
-var network = new vis.Network(container, data);
-

- -
-

Gephi parser options

- - There are a few options you can use to tell Vis what to do with the data from Gephi. - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
nodes.fixed	Boolean	`true`	When false, the nodes will move according to the physics model after import. If true, the nodes do - not move at all. If set to true, the node positions have to be defined to avoid infinite recursion - errors in the physics. -
nodes.parseColor	Boolean	`false`	If true, the color will be parsed by the vis parser, generating extra colors for the borders, - highlighs and hover. If false, the node will be the supplied color. -
edges.inheritColor	Boolean	`false`	When true, the color supplied by gephi is ignored and the inherit color mode is used with the global - setting. -

- -

Import data in DOT language

- -

- Network supports data in the - DOT language. - To use data in the DOT language, you can use the vis.network.convertDot converter to transform the DOT - language - into a vis.Network compatible nodes, edges and options objects. You can extend the options object with other - options if you'd like. -

- -

- Example usage: -

- -

-// provide data in the DOT language
-var DOTstring = 'dinetwork {1 -> 1 -> 2; 2 -> 3; 2 -- 4; 2 -> 1 }';
-var parsedData = vis.network.convertDot(DOTstring);
-
-var data = {
-  nodes: parsedData.nodes,
-  edges: parsedData.edges
-}
-
-var options = parsedData.options;
-
-// you can extend the options like a normal JSON variable:
-options.nodes = {
-  color: 'red'
-}
-
-// create a network
-var network = new vis.Network(container, data, options);
-

- - -

- - - - - - - - - - - - - - - diff --git a/www/lib/vis/docs/network/interaction.html b/www/lib/vis/docs/network/interaction.html deleted file mode 100644 index 5483636b..00000000 --- a/www/lib/vis/docs/network/interaction.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - - - - vis.js - Interaction documentation. - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - interaction

Used for all user interaction with the network. Handles mouse and touch events as well as the navigation buttons and the popups.

Options

The options for the interaction module have to be contained in an object titled 'interaction'.

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  interaction:{
-    dragNodes:true,
-    dragView: true,
-    hideEdgesOnDrag: false,
-    hideNodesOnDrag: false,
-    hover: false,
-    hoverConnectedEdges: true,
-    keyboard: {
-      enabled: false,
-      speed: {x: 10, y: 10, zoom: 0.02},
-      bindToWindow: true
-    },
-    multiselect: false,
-    navigationButtons: false,
-    selectable: true,
-    selectConnectedEdges: true,
-    tooltipDelay: 300,
-    zoomView: true
-  }
-}
-
-network.setOptions(options);
-

- -

-// only the options that have shorthand notations are shown.
-var options = {
-  interaction:{
-    keyboard: false
-  }
-}
-
-network.setOptions(options);
-

- -

This is a list of all the methods in the public API. They are collected here from all individual modules.

- - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
dragNodes	Boolean	`true`	When true, the nodes that are not fixed can be dragged by the user.
dragView	Boolean	`true`	When true, the view can be dragged around by the user.
hideEdgesOnDrag	Boolean	`false`	When true, the edges are not drawn when dragging the view. This can greatly speed up responsiveness on dragging, improving user experience.
hideNodesOnDrag	Boolean	`false`	When true, the nodes are not drawn when dragging the view. This can greatly speed up responsiveness on dragging, improving user experience.
hover	Boolean	`false`	When true, the nodes use their hover colors when the mouse moves over them.
hoverConnectedEdges	Boolean	`true`	When true, on hovering over a node, it's connecting edges are highlighted.
keyboard	Object or Boolean	`Object`	When true, the keyboard shortcuts are enabled with the default settings. For further customization, you can supply an object.
keyboard.enabled	Boolean	`false`	Toggle the usage of the keyboard shortcuts. If this option is not defined, it is set to true if any of the properties in this object are defined.
keyboard.speed.x	Number	`1`	The speed at which the view moves in the x direction on pressing a key or pressing a navigation button.
keyboard.speed.y	Number	`1`	The speed at which the view moves in the y direction on pressing a key or pressing a navigation button.
keyboard.speed.zoom	Number	`0.02`	The speed at which the view zooms in or out pressing a key or pressing a navigation button.
keyboard.bindToWindow	Boolean	`true`	When binding the keyboard shortcuts to the window, they will work regardless of which DOM object has the focus. If you have multiple networks on your page, you could set this to false, making sure the keyboard shortcuts only work on the network that has the focus.
multiselect	Boolean	`false`	When true, a longheld click (or touch) as well as a control-click will add to the selection.
navigationButtons	Boolean	`false`	When true, navigation buttons are drawn on the network canvas. These are HTML buttons and can be completely customized using CSS.
selectable	Boolean	`true`	When true, the nodes and edges can be selected by the user.
selectConnectedEdges	Boolean	`true`	When true, on selecting a node, its connecting edges are highlighted.
tooltipDelay	Number	`300`	When nodes or edges have a defined `'title'` field, this can be shown as a pop-up tooltip. The tooltip itself is an HTML element that can be fully styled using CSS. The delay is the amount of time in milliseconds it takes before the tooltip is shown.
zoomView	Boolean	`true`	When true, the user can zoom in.

- -

- - - - - - - - - - - - - - - \ No newline at end of file diff --git a/www/lib/vis/docs/network/layout.html b/www/lib/vis/docs/network/layout.html deleted file mode 100644 index 3b38048b..00000000 --- a/www/lib/vis/docs/network/layout.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - - vis.js - Layout documentation. - - - - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - layout

Acts as the camera that looks on the canvas. Does the animation, zooming and focusing.

Options

The options for the layout module have to be contained in an object titled 'layout'.

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  layout: {
-    randomSeed: undefined,
-    improvedLayout:true,
-    hierarchical: {
-      enabled:false,
-      levelSeparation: 150,
-      nodeSpacing: 100,
-      treeSpacing: 200,
-      blockShifting: true,
-      edgeMinimization: true,
-      parentCentralization: true,
-      direction: 'UD',        // UD, DU, LR, RL
-      sortMethod: 'hubsize'   // hubsize, directed
-    }
-  }
-}
-
-network.setOptions(options);
-

- -

-// only the options that have shorthand notations are shown.
-var options = {
-  layout:{
-    hierarchical: true
-  }
-}
-
-network.setOptions(options);
-

When enabling the hierarchical layout, it overrules some of the other options. The physics is set to the hierarchical repulsion solver and dynamic smooth edges are converted to static smooth edges.

- - - - - - - - - - - - - - -

Name	Type	Default	Description
randomSeed	Number	`undefined`	When NOT using the hierarchical layout, the nodes are randomly positioned initially. This means that the settled result is different every time. If you provide a random seed manually, the layout will be the same every time. Ideally you try with an undefined seed, reload until you are happy with the layout and use the `getSeed()` method to ascertain the seed.
improvedLayout	Boolean	`true`	When enabled, the network will use the Kamada Kawai algorithm for initial layout. For networks larger than 100 nodes, clustering will be performed automatically to reduce the amount of nodes. This can greatly improve the stabilization times. If the network is very interconnected (no or few leaf nodes), this may not work and it will revert back to the old method. Performance will be improved in the future.
hierarchical	Object or Boolean	`Object`	When true, the layout engine positions the nodes in a hierarchical fashion using default settings. For customization you can supply an object.
hierarchical.enabled	Boolean	`false`	Toggle the usage of the hierarchical layout system. If this option is not defined, it is set to true if any of the properties in this object are defined.
hierarchical.levelSeparation	Number	`150`	The distance between the different levels.
hierarchical.nodeSpacing	Number	`100`	Minimum distance between nodes on the free axis. This is only for the initial layout. If you enable physics, the node distance there will be the effective node distance.
hierarchical.treeSpacing	Number	`200`	Distance between different trees (independent networks). This is only for the initial layout. If you enable physics, the repulsion model will denote the distance between the trees.
hierarchical.blockShifting	Boolean	`true`	Method for reducing whitespace. Can be used alone or together with edge minimization. Each node will check for whitespace and will shift - it's branch along with it for as far as it can, respecting the nodeSpacing on any level. This is mainly for the initial layout. If you enable physics, they layout will be determined by the physics. This will greatly speed up the stabilization time though!
hierarchical.edgeMinimization	Boolean	`true`	Method for reducing whitespace. Can be used alone or together with block shifting. Enabling block shifting will usually speed up the layout process. - Each node will try to move along its free axis to reduce the total length of it's edges. This is mainly for the initial layout. If you enable physics, they layout will be determined by the physics. This will greatly speed up the stabilization time though!
hierarchical.parentCentralization	Boolean	`true`	When true, the parents nodes will be centered again after the the layout algorithm has been finished.
hierarchical.direction	String	`'UD'`	The direction of the hierarchical layout. The available options are: `UD, DU, LR, RL`. To simplify: up-down, down-up, left-right, right-left.
hierarchical.sortMethod	String	`'hubsize'`	The algorithm used to ascertain the levels of the nodes based on the data. The possible options are: `hubsize, directed`. - Hubsize takes the nodes with the most edges and puts them at the top. From that the rest of the hierarchy is evaluated. - Directed adheres to the to and from data of the edges. A --> B so B is a level lower than A.

- -

- - - - - - - - - - - - - - - \ No newline at end of file diff --git a/www/lib/vis/docs/network/manipulation.html b/www/lib/vis/docs/network/manipulation.html deleted file mode 100644 index 7f8db952..00000000 --- a/www/lib/vis/docs/network/manipulation.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - - - - vis.js - Manipulation documentation. - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - manipulation

Acts as the camera that looks on the canvas. Does the animation, zooming and focusing.

Options

The options for the manipulation module have to be contained in an object titled 'manipulation'.

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  manipulation: {
-    enabled: false,
-    initiallyActive: false,
-    addNode: true,
-    addEdge: true,
-    editNode: undefined,
-    editEdge: true,
-    deleteNode: true,
-    deleteEdge: true,
-    controlNodeStyle:{
-      // all node options are valid.
-    }
-  }
-}
-
-network.setOptions(options);
-

- -

-// only the options that have shorthand notations are shown.
-var options = {
-  manipulation: false
-}
-
-network.setOptions(options);
-

- - - - - - - - - - - -

Name	Type	Default	Description
enabled	Boolean	`false`	Toggle the manipulation system on or off. Even when false, the manipulation API through the methods will still work. This property is optional. If you define any of the options below and enabled is undefined, this will be set to true.
initiallyActive	Boolean	`true`	Toggle whether the toolbar is visible initially or if only the edit button is visible initially.
addNode	Boolean or Function	`true`	You can use these options to switch certain functionalities on or off of attach - a handler function to them. These functions are called before the action is performed. If a node is going to be added through the manipulation system, - the addNode function will be called first. With this, you can provide a gui for your users, abort the process or anything else you want to do. For all except the editNode functionality, these handler functions are optional. - - - When you supply a boolean, you only toggle the 'add node' button on the GUI of the manipulation system. The lack of handling function could effect the API when using the methods. - When a function is supplied, it will be called when the user clicks the canvas in 'addNode' mode. This function will receive two variables: the properties of the node that can be created and a callback function. If you call the callback function with the properties of the new node, the node will be added. Example: - -var options = { - manipulation: { - addNode: function(nodeData,callback) { - nodeData.label = 'hello world'; - callback(nodeData); - } - } -} - - This function changes the label of the new node into 'hello world'. If you do not want the node created, do not call the callback function or call the callback function `null` or no argument.
addEdge	Boolean or Function	`true`	If boolean, toggle the availability of the 'addEdge' button in the GUI, the API through the methods will still work except (obviously) there will be no handler function. - When a function is supplied, it will be called when the user drags the new edge from one node to the next in 'addEdge' mode. This function will receive two variables: the properties of the edge that can be created and a callback function. If you call the callback function with the properties of the new edge, the edge will be added. Example: - -var options = { - manipulation: { - addEdge: function(edgeData,callback) { - if (edgeData.from === edgeData.to) { - var r = confirm("Do you want to connect the node to itself?"); - if (r === true) { - callback(edgeData); - } - } - else { - callback(edgeData); - } - } - } -} - - This example code will show a popup if you connect a node to itself to ask you if that was what you wanted. If you do not want the edge created, do not call the callback function or call the callback function `null` or no argument.
editNode	Function	`undefined`	Editing of nodes is only possible when a handling function is supplied. If this is not the case, editing of nodes will be disabled. The function will be called when a node is selected and the 'Edit Node' button on the toolbar is pressed. This function will be called like the `addNode` function with the node's data and a callback function.
editEdge	Boolean or Function	`true`	If boolean, toggle the editing of edges in the GUI. When a function is supplied, it will be called when an edge is selected and the 'Edit Edge' button on the toolbar is pressed. This function will be called in the same way the `addEdge` function was called. If the callback is not performed, the edge will remain hanging where it was released. To cancel, call the callback function with `null` as argument or without arguments.
deleteNode	Boolean or Function	`true`	If boolean, toggle the deletion of nodes in the GUI. If function, it will be called when a node is selected and the 'Delete selected' button is pressed. When using a function, it will receive a callback and an object with an array of selected nodeIds and an array of selected edges Ids. These are the items that will be deleted if the callback is performed.
deleteEdge	Boolean or Function	`true`	If boolean, toggle the deletion of edges in the GUI. If function, it will be called when an edge is selected and the 'Delete selected' button is pressed. When using a function, it will receive a callback and an object with an array of selected nodeIds (empty) and an array of selected edges Ids. These are the items that will be deleted if the callback is performed.
controlNodeStyle	Object	Object	You can supply any styling information you'd like here. All fields described in the nodes module are allowed except obviously for id, x, y and fixed. Default: - -{ - shape:'dot', - size:6, - color: { - background: '#ff0000', - border: '#3c3c3c', - highlight: { - background: '#07f968', - border: '#3c3c3c' - } - }, - borderWidth: 2, - borderWidthSelected: 2 -} -

- - - - - - - - - - - - - - - \ No newline at end of file diff --git a/www/lib/vis/docs/network/nodes.html b/www/lib/vis/docs/network/nodes.html deleted file mode 100644 index c3cd63a1..00000000 --- a/www/lib/vis/docs/network/nodes.html +++ /dev/null @@ -1,742 +0,0 @@ - - - - - - - - - - vis.js - Nodes documentation. - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - nodes

- -

Handles the creation and deletion of nodes and contains the global node options and styles.

Options

The options for the nodes have to be contained in an object titled 'nodes'. All of these options can be supplied per node as well. Obviously, 'id' should not be defined globally but per node. Options defined - in the global nodes object, are applied to all nodes. If a node has options of its own, those will be used instead of the global options.

When you have given a node an option, you will override the global option for that property, and also the group option for that property if the node is in a group. If you then set that option to null, - it will revert back to the default value. -

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  nodes:{
-    borderWidth: 1,
-    borderWidthSelected: 2,
-    brokenImage:undefined,
-    color: {
-      border: '#2B7CE9',
-      background: '#97C2FC',
-      highlight: {
-        border: '#2B7CE9',
-        background: '#D2E5FF'
-      },
-      hover: {
-        border: '#2B7CE9',
-        background: '#D2E5FF'
-      }
-    },
-    fixed: {
-      x:false,
-      y:false
-    },
-    font: {
-      color: '#343434',
-      size: 14, // px
-      face: 'arial',
-      background: 'none',
-      strokeWidth: 0, // px
-      strokeColor: '#ffffff',
-      align: 'center'
-    },
-    group: undefined,
-    hidden: false,
-    icon: {
-      face: 'FontAwesome',
-      code: undefined,
-      size: 50,  //50,
-      color:'#2B7CE9'
-    },
-    image: undefined,
-    label: undefined,
-    labelHighlightBold: true,
-    level: undefined,
-    mass: 1,
-    physics: true,
-    scaling: {
-      min: 10,
-      max: 30,
-      label: {
-        enabled: false,
-        min: 14,
-        max: 30,
-        maxVisible: 30,
-        drawThreshold: 5
-      },
-      customScalingFunction: function (min,max,total,value) {
-        if (max === min) {
-          return 0.5;
-        }
-        else {
-          let scale = 1 / (max - min);
-          return Math.max(0,(value - min)*scale);
-        }
-      }
-    },
-    shadow:{
-      enabled: false,
-      color: 'rgba(0,0,0,0.5)',
-      size:10,
-      x:5,
-      y:5
-    },
-    shape: 'ellipse',
-    shapeProperties: {
-      borderDashes: false, // only for borders
-      borderRadius: 6,     // only for box shape
-      interpolation: false,  // only for image and circularImage shapes
-      useImageSize: false,  // only for image and circularImage shapes
-      useBorderWithImage: false  // only for image shape
-    }
-    size: 25,
-    title: undefined,
-    value: undefined,
-    x: undefined,
-    y: undefined
-  }
-}
-
-network.setOptions(options);
-

- -

-// only the options that have shorthand notations are shown.
-var options = {
-  nodes:{
-    color: '#ff0000',
-    fixed: false,
-    font: '12px arial red',
-    scaling: {
-      label: true
-    },
-    shadow: true
-  }
-}
-network.setOptions(options);
-

- -

These options can also be set per individual node. All of the individual options are explained here:

Name	Type	Default	Description
borderWidth	Number	`1`	The width of the border of the node.
borderWidthSelected	Number	`2`	The width of the border of the node when it is selected. When undefined, the borderWidth * 2 is used.
brokenImage	String	`undefined`	When the shape is set to `image` or `circularImage`, this option can be an URL to - a backup image in case the URL supplied in the image option cannot be resolved. -
color	Object or String	`Object`	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 `'rgba(120,32,14,1)'`, `'#ffffff'` or `'red'` - can be supplied instead of an object. -
color.border	String	`'#2B7CE9'`	The color of the border of the node when it is not selected or hovered over (assuming hover is - enabled in the interaction module). -
color.background	String	`'#D2E5FF'`	The color of the background of the node when it is not selected or hovered over (assuming hover is - enabled in the interaction module). -
color.highlight	Object or String	`Object`	The color the node when it is selected. Alternatively you can just supply a string color value.
color.highlight.border	String	`'#2B7CE9'`	The color of the border of the node when it is selected.
color.highlight.background	String	`'#D2E5FF'`	The color of the background of the node when it is selected.
color.hover	Object or String	`Object`	The color the node when the mouse hovers over it (assuming hover is enabled in the interaction - module). Shorthand like above is also supported. -
color.hover.border	String	`'#2B7CE9'`	The color of the border of the node when the mouse hovers over it (assuming hover is enabled in the - interaction module). -
color.hover.background	String	`'#D2E5FF'`	The color of the background of the node when the mouse hovers over it (assuming hover is enabled in - the interaction module). -
fixed	Object or Boolean	`Object`	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. -
fixed.x	Boolean	`false`	When true, the node will not move in the X direction.
fixed.y	Boolean	`false`	When true, the node will not move in the Y direction.
font	Object or String	`false`	This object defines the details of the label. A shorthand is also supported in the form `'size face - color'` for example: `'14px arial red'`. -
font.color	String	`'#343434'`	Color of the label text.
font.size	Number	`14`	Size of the label text.
font.face	String	`'arial'`	Font face (or font family) of the label text.
font.background	String	`undefined`	When not `undefined` but a color string, a background rectangle will be drawn behind - the label in the supplied color. -
font.strokeWidth	Number	`0`	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. -
font.strokeColor	String	`'#ffffff'`	This is the color of the stroke assuming the value for stroke is higher than 0.
font.align	String	`'center'`	This can be set to 'left' to make the label left-aligned. Otherwise, - defaults to 'center'.
group	String	`undefined`	When not `undefined`, the node will belong to the defined group. Styling information of - that group will apply to this node. Node specific styling overrides group styling. -
hidden	Boolean	`false`	When true, the node will not be shown. It will still be part of the physics simulation though!
icon	Object	`Object`	These options are only used when the shape is set to `icon`.
icon.face	String	`'FontAwesome'`	These options are only used when the shape is set to `icon`. The possible options for the - face are: `'FontAwesome'` and `'Ionicons'`. -
icon.code	String	`undefined`	This is the code of the icon, for example `'\uf007'`.
icon.size	Number	`50`	The size of the icon.
icon.color	String	`'#2B7CE9'`	The color of the icon.
id	String	`undefined`	The id of the node. The id is mandatory for nodes and they have to be unique. This should obviously be set per node, not globally.
image	String	`undefined`	When the shape is set to `image` or `circularImage`, this option should be the URL - to an image. If the image cannot be found, the brokenImage option can be used. -
label	String	`undefined`	The label is the piece of text shown in or under the node, depending on the shape.
labelHighlightBold	Boolean	`true`	Determines whether or not the label becomes bold when the node is selected.
level	Number	`undefined`	When using the hierarchical layout, the level determines where the node is going to be positioned.
mass	Number	`1`	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. -
physics	Boolean	`true`	When false, the node is not part of the physics simulation. It will not move except for from manual - dragging. -
scaling	Object	`Object`	If the `value` 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: - `ellipse`, `circle`, `database`, `box`, `text`. - Always scalable are: - `image`, `circularImage`, `diamond`, `dot`, - `star`, `triangle`, `triangleDown`, `square` and - `icon`. Keep in mind that when using scaling, the `size` option is neglected. -
scaling.min	Number	`10`	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. -
scaling.max	Number	`30`	This is the maximum allowed size when the nodes are scaled using the value option.
scaling.label	Object or Boolean	`Object`	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. -
scaling.label.enabled	Boolean	`false`	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. -
scaling.label.min	Number	`14`	The minimum font-size used for labels when scaling.
scaling.label.max	Number	`30`	The maximum font-size used for labels when scaling.
scaling.label.maxVisible	Number	`30`	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%. -
scaling.label.drawThreshold	Number	`5`	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. -
scaling.customScalingFunction	Function	in description	If nodes have `value` fields, this function determines how the size of the nodes are scaled - based on their values. The default function is: - -function (min,max,total,value) { - if (max === min) { - return 0.5; - } - else { - var scale = 1 / (max - min); - return Math.max(0,(value - min)scale); - } -} - - 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. It has to return a value between 0 and 1.* The - nodes and edges then calculate their size as follows: - -var scale = customScalingFunction(min,max,total,value); -var diff = maxSize - minSize; -mySize = minSize + diff * scale; - - Please note: `maxSize` and `minSize` are the values `scaling.max` - and `scaling.min` provided in the options. -
shadow	Object or Boolean	`Object`	When true, the node casts a shadow using the default settings. This can be further refined by supplying - an object. -
shadow.enabled	Boolean	`false`	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. -
shadow.color	String	`'rgba(0,0,0,0.5)'`	The color size of the shadow as a string. Supported formats are 'rgb(255,255,255)', 'rgba(255,255,255,1)' and '#FFFFFF'.
shadow.size	Number	`10`	The blur size of the shadow.
shadow.x	Number	`5`	The x offset.
shadow.y	Number	`5`	The y offset.
shape	String	`'ellipse'`	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: - `ellipse`, `circle`, `database`, `box`, `text`. - The ones with the label outside of it are: `image`, `circularImage`, - `diamond`, `dot`, `star`, `triangle`, - `triangleDown`, `square` and `icon`. -
shapeProperties	Object	`Object`	This object contains configuration for specific shapes -
shapeProperties.borderDashes	Array or Boolean	`false`	This property applies to all shapes that have borders. - You set the dashes by supplying an Array. Array formart: [dash length, gap length]. - You can also use a Boolean, false is disable and true is default [5,15]. -
shapeProperties.borderRadius	Number	`6`	This property is used only for the `box` shape. It allows you to determine the roundness of the corners of the shape. -
shapeProperties.interpolation	Boolean	`true`	This property only applies to the `image` and `circularImage` shapes. When true, the image is resampled when scaled down, resulting in a nicer image at the cost of computional time. -
shapeProperties.useImageSize	Boolean	`false`	This property only applies to the `image` and `circularImage` shapes. When false, the size option is used, when true, the size of the image is used. Important: - if this is set to true, the image cannot be scaled with the value option! -
shapeProperties.useBorderWithImage	Boolean	`false`	This property only applies to the `image` shape. - When true, the color object is used. A rectangle with the background color is - drawn behind it and it has a border. This means all border options are taken into account. -
size	Number	`25`	The size is used to determine the size of node shapes that do not have the label inside of them. These - shapes are: `image`, `circularImage`, `diamond`, `dot`, - `star`, `triangle`, `triangleDown`, `square` and - `icon`
title	String or Element	`undefined`	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. -
value	Number	`undefined`	When a value is set, the nodes will be scaled using the options in the scaling object defined above. -
x	Number	`undefined`	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. -
y	Number	`undefined`	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. -

- -

- - - - - - - - - - - - - - - diff --git a/www/lib/vis/docs/network/physics.html b/www/lib/vis/docs/network/physics.html deleted file mode 100644 index c8fe9920..00000000 --- a/www/lib/vis/docs/network/physics.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - - - vis.js - Physics documentation. - - - - - - - - - - - - - - - - - - - - - - - - -

- -

Network - physics

Handles the physics simulation, moving the nodes and edges to show them clearly.

Options

The options for the physics have to be contained in an object titled 'physics'.

Click on the full options or shorthand options to show how these options are supposed to be used.

-
-

-// these are all options in full.
-var options = {
-  physics:{
-    enabled: true,
-    barnesHut: {
-      gravitationalConstant: -2000,
-      centralGravity: 0.3,
-      springLength: 95,
-      springConstant: 0.04,
-      damping: 0.09,
-      avoidOverlap: 0
-    },
-    forceAtlas2Based: {
-      gravitationalConstant: -50,
-      centralGravity: 0.01,
-      springConstant: 0.08,
-      springLength: 100,
-      damping: 0.4,
-      avoidOverlap: 0
-    },
-    repulsion: {
-      centralGravity: 0.2,
-      springLength: 200,
-      springConstant: 0.05,
-      nodeDistance: 100,
-      damping: 0.09
-    },
-    hierarchicalRepulsion: {
-      centralGravity: 0.0,
-      springLength: 100,
-      springConstant: 0.01,
-      nodeDistance: 120,
-      damping: 0.09
-    },
-    maxVelocity: 50,
-    minVelocity: 0.1,
-    solver: 'barnesHut',
-    stabilization: {
-      enabled: true,
-      iterations: 1000,
-      updateInterval: 100,
-      onlyDynamicEdges: false,
-      fit: true
-    },
-    timestep: 0.5,
-    adaptiveTimestep: true
-  }
-}
-
-network.setOptions(options);
-

- -

-// only the options that have shorthand notations are shown.
-var options = {
-  physics:{
-    stabilization: false
-  }
-}
-network.setOptions(options);
-

All of the individual options are explained here:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
enabled	Boolean	`true`	Toggle the physics system on or off. This property is optional. If you define any of the options below and enabled is undefined, this will be set to true.
barnesHut	Object	`Object`	BarnesHut is a quadtree based gravity model. This is the fastest, default and recommended solver for non-hierarchical layouts.
barnesHut.gravitationalConstant	Number	`-2000`	Gravity attracts. We like repulsion. So the value is negative. If you want the repulsion to be stronger, decrease the value (so -10000, -50000).
barnesHut.centralGravity	Number	`0.3`	There is a central gravity attractor to pull the entire network back to the center.
barnesHut.springLength	Number	`95`	The edges are modelled as springs. This springLength here is the the rest length of the spring.
barnesHut.springConstant	Number	`0.04`	This is how 'sturdy' the springs are. Higher values mean stronger springs.
barnesHut.damping	Number	`0.09`	Accepted range: `[0 .. 1]`. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
barnesHut.avoidOverlap	Number	`0`	Accepted range: `[0 .. 1]`. When larger than 0, the size of the node is taken into account. The distance will be calculated from the radius of the encompassing circle of the node for both the gravity model. Value 1 is maximum overlap avoidance.
forceAtlas2Based	Object	`Object`	Force Atlas 2 has been developed by Jacomi et al (2014) for use with Gephi. The forceAtlas2Based solver makes use of some of the equations provided - by them and makes use of the barnesHut implementation in vis. The main differences are the central gravity model, - which is here distance independent, and the repulsion being linear instead of quadratic. Finally, all node masses have a - multiplier based on the amount of connected edges plus one.
forceAtlas2Based.gravitationalConstant	Number	`-50`	This is similar to the barnesHut method except that the falloff is linear instead of quadratic. The connectivity is also taken into account as a factor of the mass. If you want the repulsion to be stronger, decrease the value (so -1000, -2000).
forceAtlas2Based.centralGravity	Number	`0.01`	There is a central gravity attractor to pull the entire network back to the center. This is not dependent on distance.
forceAtlas2Based.springLength	Number	`100`	The edges are modelled as springs. This springLength here is the the rest length of the spring.
forceAtlas2Based.springConstant	Number	`0.08`	This is how 'sturdy' the springs are. Higher values mean stronger springs.
forceAtlas2Based.damping	Number	`0.4`	Accepted range: `[0 .. 1]`. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
forceAtlas2Based.avoidOverlap	Number	`0`	Accepted range: `[0 .. 1]`. When larger than 0, the size of the node is taken into account. The distance will be calculated from the radius of the encompassing circle of the node for both the gravity model. Value 1 is maximum overlap avoidance.
repulsion	Object	`Object`	The repulsion model assumes nodes have a simplified repulsion field around them. It's force linearly decreases from 1 (at 0.5nodeDistance and smaller) to 0 (at 2nodeDistance).
repulsion.nodeDistance	Number	`100`	This is the range of influence for the repulsion.
repulsion.centralGravity	Number	`0.2`	There is a central gravity attractor to pull the entire network back to the center.
repulsion.springLength	Number	`200`	The edges are modelled as springs. This springLength here is the the rest length of the spring.
repulsion.springConstant	Number	`0.05`	This is how 'sturdy' the springs are. Higher values mean stronger springs.
repulsion.damping	Number	`0.09`	Accepted range: `[0 .. 1]`. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
hierarchicalRepulsion	Object	`Object`	This model is based on the repulsion solver but the levels are taken into account and the forces are normalized.
hierarchicalRepulsion.nodeDistance	Number	`120`	This is the range of influence for the repulsion.
hierarchicalRepulsion.centralGravity	Number	`0.0'`	There is a central gravity attractor to pull the entire network back to the center.
hierarchicalRepulsion.springLength	Number	`100`	The edges are modelled as springs. This springLength here is the the rest length of the spring.
hierarchicalRepulsion.springConstant	Number	`0.01`	This is how 'sturdy' the springs are. Higher values mean stronger springs.
hierarchicalRepulsion.damping	Number	`0.09`	Accepted range: `[0 .. 1]`. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
maxVelocity	Number	`50`	The physics module limits the maximum velocity of the nodes to increase the time to stabilization. This is the maximium value.
minVelocity	Number	`0.1`	Once the minimum velocity is reached for all nodes, we assume the network has been stabilized and the simulation stops.
solver	String	`'barnesHut'`	You can select your own solver. Possible options: `'barnesHut', 'repulsion', 'hierarchicalRepulsion', 'forceAtlas2Based'`. When setting the hierarchical layout, the hierarchical repulsion solver is automaticaly selected, regardless of what you fill in here.
stabilization	Object \| Boolean	`Object`	When true, the network is stabilized on load using default settings. If false, stabilization is disabled. To further customize this, you can supply an object.
stabilization.enabled	Boolean	`true`	Toggle the stabilization. This is an optional property. If undefined, it is automatically set to true when any of the properties of this object are defined.
stabilization.iterations	Number	`1000`	The physics module tries to stabilize the network on load up til a maximum number of iterations defined here. If the network stabilized with less, you are finished before the maximum number.
stabilization.updateInterval	Number	`50`	When stabilizing, the DOM can freeze. You can chop the stabilization up into pieces to show a loading bar for instance. The interval determines after how many iterations the `stabilizationProgress` event is triggered.
stabilization.onlyDynamicEdges	Boolean	`false`	If you have predefined the position of all nodes and only want to stabilize the dynamic smooth edges, set this to true. It freezes all nodes except the invisible dynamic smooth curve support nodes. If you want the visible nodes to move and stabilize, do not use this.
stabilization.fit	Boolean	`true`	Toggle whether or not you want the view to zoom to fit all nodes when the stabilization is finished.
timestep	Number	`0.5`	The physics simulation is discrete. This means we take a step in time, calculate the forces, move the nodes and take another step. If you increase this number the steps will be too large and the network can get unstable. If you see a lot of jittery movement in the network, you may want to reduce this value a little.
adaptiveTimestep	Boolean	`true`	If this is enabled, the timestep will intelligently be adapted (only during the stabilization stage if stabilization is enabled!) to greatly decrease stabilization times. The timestep configured above is taken as the minimum timestep. This can be further improved by using the improvedLayout algorithm.

- -

- - - - - - - - - - - - - - - \ No newline at end of file -- cgit v1.2.3

Network - configure

Options

Network - edges

Options

Network - groups

Options

Network

Creating a Network

Contents

Modules

Options

Custom locales

Methods

Cluster methods options object

Events

Importing data

Import data from Gephi

Gephi parser options

Import data in DOT language

Network - interaction

Options

Network - layout

Options

Network - manipulation

Options

Network - nodes

Options

Network - physics

Options