# vis.js - A dynamic, browser based visualization library.

# 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,
        locale: 'en',
        locales: locales,
        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. 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.
locale | String | `'en'` | Select the locale. By default, the language is English. If you want to use another language, you will need to define your own locale and refer to it here.
locales | Object | defaultLocales | Locales object. By default only `'en'` and `'nl'` are supported. Take a look at the locales section below for more explaination on how to customize this.
functionality | Object | Object | You can use this object to switch certain functionalities on or off. By default they are all on.
functionality.addNode | Boolean | `true` | Toggle the adding of nodes.
functionality.addEdge | Boolean | `true` | Toggle the adding of edges.
functionality.editNode | Boolean | `true` | Toggle the editing of nodes. Even if this is enabled, it will only be shown if a handler function is set for `editNode`.
functionality.editEdge | Boolean | `true` | Toggle the editing of edges.
functionality.deleteNode | Boolean | `true` | Toggle the deletion of nodes.
functionality.deleteEdge | Boolean | `true` | Toggle the deletion of edges.
handlerFunctions | Object | `Object` | These functions are inserted 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.

handlerFunctions.addNode

Function

`undefined`

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 = {
      handlerFunctions: {
        addNode: function(nodeData,callback) {
          nodeData.label = 'hello world';
          callback(nodeData);
        }
      }
    }

If you do not want the node created, do not call the callback function or call the callback function `null` or no argument.

handlerFunctions.addEdge

Function

`undefined`

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 = {
      handlerFunctions: {
        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.

handlerFunctions.editNode | Function | `undefined` | 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.
handlerFunctions.editEdge | Function | `undefined` | Called when an edge is selcted 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.
handlerFunctions.deleteNode | Function | `undefined` | Called when a node is selected and the 'Delete selected' button is pressed.
handlerFunctions.deleteEdge | Function | `undefined` | Called when an edge is selected and the 'Delete selected' button is pressed.

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
    }

### Methods

This is a list of all the methods in the public API. Options can be set directly to the module or you can use the setOptions method of the network itself and use the module name as an object name.

name | returns | description
enableEditMode() | none | Programatically enable the edit mode. Similar effect to pressing the edit button.
disableEditMode() | none | Programatically disable the edit mode. Similar effect to pressing the close icon (small cross in the corner of the toolbar).
addNodeMode() | 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.
editNodeMode() | none | Go into editNode mode. The explaination from `addNodeMode` applies here as well.
addEdgeMode() | none | Go into addEdge mode. The explaination from `addNodeMode` applies here as well.
editEdgeMode() | none | Go into editEdge mode. The explaination from `addNodeMode` applies here as well.
deleteSelected() | none | Delete selected. Having edit mode or manipulation enabled is not required.

### Events

There are no events emitted by the layout module.

### 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 string. You can then use your new key in the locale option.