From 5c411a9366b1d1c6b60a3cafbbc82a5318329ba4 Mon Sep 17 00:00:00 2001 From: Alex de Mulder Date: Thu, 16 Jul 2015 18:13:32 +0200 Subject: [PATCH] polising the network docs a little --- docs/js/main.js | 2 + docs/network/index.html | 278 ++++++++++++++++------------------------ 2 files changed, 116 insertions(+), 164 deletions(-) diff --git a/docs/js/main.js b/docs/js/main.js index 08758420..2d089b7e 100644 --- a/docs/js/main.js +++ b/docs/js/main.js @@ -15,6 +15,8 @@ function checkInput() { vis.typingTimeout = setTimeout(function () {vis.initSiteSearch(true)},200); } else { + var title = document.title.replace(/(\(.+\) )/g,""); + document.title = title; document.getElementById("search-results-wrapper").style.display = "none"; } } diff --git a/docs/network/index.html b/docs/network/index.html index 6906123c..7bd6be34 100644 --- a/docs/network/index.html +++ b/docs/network/index.html @@ -227,33 +227,33 @@ Generates an interactive option editor with filtering. - edges + edges Handles the creation and deletion of edges and contains the global edge options and styles. - groups + groups Contains the groups and some options on how to handle nodes with non-existing groups. - interaction + 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 + layout Governs the initial and hierarchical positioning. - manipulation + manipulation Supplies an API and optional GUI to alter the data in the network. - nodes + nodes Handles the creation and deletion of nodes and contains the global node options and styles. - physics + physics Does all the simulation moving the nodes and edges to their final positions, also governs stabilization. @@ -294,8 +294,7 @@ network.setOptions(options); Default Description - - autoResize + autoResize Boolean true If true, the Network will automatically detect when its container is resized, and redraw itself @@ -303,20 +302,17 @@ network.setOptions(options); using the function redraw() and setSize(). - - width + width String '100%' the width of the canvas. Can be in percentages or pixels (ie. '400px'). - - height + height String '100%' the height of the canvas. Can be in percentages or pixels (ie. '400px'). - - locale + locale String 'en' Select the locale. By default, the language is English. If you want to use another language, you @@ -324,8 +320,7 @@ network.setOptions(options); need to define your own locale and refer to it here. - - locales + locales Object defaultLocales Locales object. By default only 'en' and 'nl' are supported. Take a look @@ -335,8 +330,7 @@ network.setOptions(options); section below for more explaination on how to customize this. - - clickToUse + clickToUse Boolean false Locales object. By default only 'en' and 'nl' are supported. Take a look @@ -346,60 +340,52 @@ network.setOptions(options); section below for more explaination on how to customize this. - - configure + configure Object Object - All options in this object are explained in the configure module. + All options in this object are explained in the configure module. - - edges + edges Object Object - All options in this object are explained in the edges module. + All options in this object are explained in the edges module. - - nodes + nodes Object Object - All options in this object are explained in the nodes module. + All options in this object are explained in the nodes module. - - groups + groups Object Object - All options in this object are explained in the groups module. + All options in this object are explained in the groups module. - - layout + layout Object Object - All options in this object are explained in the layout module. + All options in this object are explained in the layout module. - - interaction + interaction Object Object - All options in this object are explained in the interaction module. + All options in this object are explained in the interaction module. - - manipulation + manipulation Object Object - All options in this object are explained in the manipulation module. + All options in this object are explained in the manipulation module. - - physics + physics Object Object - All options in this object are explained in the physics module. + All options in this object are explained in the physics module. @@ -442,14 +428,14 @@ var locales = { Global methods for the network. - destroy() + destroy() Returns: none Remove the network from the DOM and remove all Hammer bindings and references. - setData({nodes: vis + setData({nodes: vis DataSet/Array,edges: vis DataSet/Array}) @@ -463,7 +449,7 @@ var locales = { - setOptions(Object + setOptions(Object options) @@ -475,7 +461,7 @@ var locales = { - on(String event name, Function callback) + on(String event name, Function callback) @@ -484,7 +470,7 @@ var locales = { - off(String event name, Function callback) + off(String event name, Function callback) @@ -493,7 +479,7 @@ var locales = { - once(String event name, Function callback) + once(String event name, Function callback) @@ -507,7 +493,7 @@ var locales = { Methods related to the canvas. - canvasToDOM({x: + canvasToDOM({x: Number,y: Number}) @@ -520,7 +506,7 @@ var locales = { - DOMtoCanvas({x: + DOMtoCanvas({x: Number,y: Number}) @@ -533,14 +519,14 @@ var locales = { - redraw() + redraw() Returns: none Redraw the network. - setSize(String + setSize(String width,String height) @@ -554,7 +540,7 @@ var locales = { Clustering - cluster( + cluster( Object options) @@ -568,7 +554,7 @@ var locales = { - clusterByConnection( + clusterByConnection( String nodeId, [Object options] ) @@ -585,7 +571,7 @@ var locales = { - clusterByHubsize( + clusterByHubsize( [Number hubsize], [Object options]) @@ -601,7 +587,7 @@ var locales = { - clusterOutliers( + clusterOutliers( [Object options]) @@ -611,7 +597,7 @@ var locales = { - findNode( + findNode( String nodeId) @@ -626,7 +612,7 @@ var locales = { - isCluster( + isCluster( String nodeId) @@ -634,7 +620,7 @@ var locales = { Returns true if the node whose ID has been supplied is a cluster. - getNodesInCluster( + getNodesInCluster( String clusterNodeId) @@ -643,7 +629,7 @@ var locales = { - openCluster( + openCluster( String nodeId, Object options) @@ -671,7 +657,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Layout - getSeed() + getSeed() @@ -688,14 +674,14 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Manipulation methods to use the manipulation system without GUI. - enableEditMode() + enableEditMode() Returns: none Programatically enable the edit mode. Similar effect to pressing the edit button. - disableEditMode() + disableEditMode() Returns: none @@ -704,7 +690,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - addNodeMode() + addNodeMode() Returns: none @@ -716,28 +702,28 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - editNode() + editNode() Returns: none Edit the selected node. The explaination from addNodeMode applies here as well. - addEdgeMode() + addEdgeMode() Returns: none Go into addEdge mode. The explaination from addNodeMode applies here as well. - editEdgeMode() + editEdgeMode() Returns: none Go into editEdge mode. The explaination from addNodeMode applies here as well. - deleteSelected() + deleteSelected() Returns: none @@ -749,7 +735,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Methods to get information on nodes and edges. - getPositions([Array of + getPositions([Array of nodeIds]) @@ -771,7 +757,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - storePositions() + storePositions() Returns: none @@ -798,7 +784,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - getBoundingBox(String + getBoundingBox(String nodeId) @@ -817,7 +803,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - getConnectedNodes(String + getConnectedNodes(String nodeId or edgeId) @@ -827,7 +813,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { 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 + getConnectedEdges(String nodeId) @@ -841,7 +827,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Physics methods to control when the simulation should run. - startSimulation() + startSimulation() Returns: none @@ -850,7 +836,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - stopSimulation() + stopSimulation() Returns: none @@ -860,7 +846,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - stabilize([iterations]) + stabilize([iterations]) Returns: none @@ -872,7 +858,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Selection methods for nodes and edges. - getSelection() + getSelection() Returns: Object @@ -886,7 +872,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - getSelectedNodes() + getSelectedNodes() Returns: Array @@ -895,14 +881,14 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - getSelectedEdges() + getSelectedEdges() Returns: Array Returns an array of selected edge ids like so: [edgeId1, edgeId2, ..]. - getNodeAt({x: xPosition + getNodeAt({x: xPosition DOM, y: yPosition DOM}) @@ -914,7 +900,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - getEdgeAt({x: xPosition + getEdgeAt({x: xPosition DOM, y: yPosition DOM}) @@ -926,7 +912,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - selectNodes(Array with + selectNodes(Array with nodeIds,[Boolean highlightEdges]) @@ -941,7 +927,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - selectEdges(Array with + selectEdges(Array with edgeIds) @@ -953,7 +939,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - unselectAll() + unselectAll() Returns: none @@ -965,7 +951,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Methods to control the viewport for zoom and animation. - getScale() + getScale() Returns: Number @@ -973,7 +959,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - getViewPosition() + getViewPosition() Returns: Number @@ -981,7 +967,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - fit([Object + fit([Object options]) @@ -1003,7 +989,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - focus( + focus( String nodeId, [Object options]) @@ -1032,7 +1018,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - moveTo(Object + moveTo(Object options) @@ -1067,7 +1053,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { - releaseNode() + releaseNode() Returns: none @@ -1077,7 +1063,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Methods to use with the configurator module. - getOptionsFromConfigurator() + getOptionsFromConfigurator() Returns: Object @@ -1099,8 +1085,7 @@ function releaseFunction (clusterPosition, containedNodesPositions) { Type Description - - joinCondition(
  nodeOptions: Object
) + 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. @@ -1128,8 +1113,7 @@ network.clustering.cluster(options); - - processProperties(
  clusterOptions: Object,
+ processProperties(
  clusterOptions: Object,
  childNodesOptions: Array,
  childEdgesOptions: Array
) Function @@ -1165,8 +1149,7 @@ var options = { - - clusterNodeProperties + clusterNodeProperties Object Optional. This is an object containing the options for the cluster node. All options described @@ -1177,8 +1160,7 @@ var options = { fine tuning. If undefined, default node options will be used. - - clusterEdgeProperties + clusterEdgeProperties Object Optional. This is an object containing the options for the edges connected to the cluster. All @@ -1208,8 +1190,7 @@ var options = { Events triggered by human interaction, selection, dragging etc. - - click + click Object @@ -1227,8 +1208,7 @@ var options = { - - doubleClick + doubleClick same as click. Fired when the user double clicks the mouse or double taps on a touchscreen device. Since a double click @@ -1239,48 +1219,41 @@ var options = { processing them. - - oncontext + 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 + 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 + release same as click. Fired after drawing on the canvas has been completed. Can be used to draw on top of the network. - - select + 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 + selectNode same as click. Fired when a node has been selected by the user. - - selectEdge + selectEdge same as click. Fired when a edge has been selected by the user. - - deselectNode + 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: @@ -1301,76 +1274,63 @@ var options = { - - deselectEdge + 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 + dragStart same as click. Fired when starting a drag. - - dragging + dragging same as click. Fired when dragging node(s) or the view. - - dragEnd + dragEnd same as click. Fired when the drag has finished. - - hoverNode + hoverNode {node: nodeId} Fired interaction:{hover:true} and the mouse hovers over a node. - - blurNode + blurNode {node: nodeId} Fired interaction:{hover:true} and the mouse moved away from a node it was hovering over before. - - hoverEdge + hoverEdge {edge: edgeId} Fired interaction:{hover:true} and the mouse hovers over an edge. - - blurEdge + blurEdge {edge: edgeId} Fired interaction:{hover:true} and the mouse moved away from an edge it was hovering over before. - - zoom + 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 + showPopup id of item corresponding to popup Fired when the popup (tooltip) is shown. - - hidePopup + hidePopup none Fired when the popup (tooltip) is hidden. Events triggered the physics simulation. Can be used to trigger GUI updates. - - startStabilizing + 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 + 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: @@ -1380,13 +1340,11 @@ var options = { } - - stabilizationIterationsDone + 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 + 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: 
{
@@ -1397,8 +1355,7 @@ var options = {
             
                 Event triggered by the canvas.
             
-            
-                resize
+            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:
 
@@ -1418,22 +1375,19 @@ var options = {
                     canvas.
                 
             
-            
-                initRedraw
+            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
+            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
+            afterDrawing
                 canvas context
                 Fired after drawing on the canvas has been completed. Can be used to draw on top of the network.
                 
@@ -1441,8 +1395,7 @@ var options = {
             
                 Event triggered by the view module.
             
-            
-                animationFinished
+            animationFinished
                 none
                 Fired when an animation is finished.
         
@@ -1508,8 +1461,7 @@ var network = new vis.Network(container, data);
                 Default
                 Description
             
-            
-                nodes.fixed
+            nodes.fixed
                 Boolean
                 true
                 When false, the nodes will move according to the physics model after import. If true, the nodes do
@@ -1517,16 +1469,14 @@ var network = new vis.Network(container, data);
                     errors in the physics.
                 
             
-            
-                nodes.parseColor
+            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
+            edges.inheritColor
                 Boolean
                 false
                 When true, the color supplied by gephi is ignored and the inherit color mode is used with the global