jqtree 1.8.1 → 1.8.3

package/docs/_entries/functions/closenode.md

@@ -1,23 +0,0 @@
----
-title: closeNode
-name: functions-closenode
----
-
-**function closeNode(node);**
-
-**function closeNode(node, slide);**
-
-Close this node. The node must have child nodes.
-
-Parameter **slide**: close the node using a slide animation (default is true).
-
-{% highlight js %}
-var node = $tree.tree('getNodeById', 123);
-$tree.tree('closeNode', node);
-{% endhighlight %}
-
-To close the node without the slide animation, call with **slide** parameter is false.
-
-{% highlight js %}
-$tree.tree('closeNode', node, false);
-{% endhighlight %}

package/docs/_entries/functions/destroy.md

@@ -1,12 +0,0 @@
----
-title: destroy
-name: functions-destroy
----
-
-**function destroy();**
-
-Destroy the tree. This removes the dom elements and event bindings.
-
-{% highlight js %}
-$('#tree1').tree('destroy');
-{% endhighlight %}

package/docs/_entries/functions/getnodebycallback.md

@@ -1,24 +0,0 @@
----
-title: getNodeByCallback
-name: functions-getnodebycallback
----
-
-**function getNodeByCallback(callback);**
-
-Get a tree node using a callback. The callback should return true if the node is found.
-
-{% highlight js %}
-var node = $('#tree1').tree(
-  'getNodeByCallback',
-  function(node) {
-      if (node.name == 'abc') {
-          // Node is found; return true
-          return true;
-      }
-      else {
-          // Node not found; continue searching
-          return false;
-      }
-  }
-);
-{% endhighlight %}

package/docs/_entries/functions/getnodebyhtmlelement.md

@@ -1,29 +0,0 @@
----
-title: getNodeByHtmlElement
-name: functions-getnodebyhtmlelement
----
-
-**function getNodeByHtmlElement(htmlElement);**
-
-Get a tree node by an html element. The html htmlElement should be:
-
-* The `li` element for the node
-* Or, an element inside the `li`. For example the `span` for the title.
-
-{% highlight js %}
-var element = document.querySelector('#tree1 .jqtree-title');
-
-var node = $('#tree1').tree('getNodeByHtmlElement', element);
-
-console.log(node);
-{% endhighlight %}
-
-The element can also be a jquery element:
-
-{% highlight js %}
-var $element = $('#tree1 .jqtree-title');
-
-var node = $('#tree1').tree('getNodeByHtmlElement', $element);
-
-console.log(node);
-{% endhighlight %}

package/docs/_entries/functions/getnodebyid.md

@@ -1,21 +0,0 @@
----
-title: getNodeById
-name: functions-getnodebyid
----
-
-**function getNodeById(id);**
-
-Get a tree node by node-id. This assumes that you have given the nodes in the data a unique id.
-
-{% highlight js %}
-var $tree = $('#tree1');
-var data = [
-    { id: 10, name: 'n1' },
-    { id: 11, name: 'n2' }
-];
-
-$tree.tree({
-    data: data
-});
-var node = $tree.tree('getNodeById', 10);
-{% endhighlight %}

package/docs/_entries/functions/getselectednode.md

@@ -1,10 +0,0 @@
----
-title: getSelectedNode
-name: functions-getselectednode
----
-
-Get the selected node. Returns the row data or false.
-
-{% highlight js %}
-var node = $tree.tree('getSelectedNode');
-{% endhighlight %}

package/docs/_entries/functions/getstate.md

@@ -1,19 +0,0 @@
----
-title: getState
-name: functions-getstate
----
-
-Get the state of tree: which nodes are open and which one is selected?
-
-Returns a javascript object that contains the ids of open nodes and selected nodes:
-
-{% highlight js %}
-{
-    open_nodes: [1, 2, 3],
-    selected_node: [4, 5, 6]
-}
-{% endhighlight %}
-
-If you want to use this function, then your tree data should include an **id** property for each node.
-
-You can use this function in combination with [setState](#functions-setstate) to save and restore the tree state.

package/docs/_entries/functions/gettree.md

@@ -1,12 +0,0 @@
----
-title: getTree
-name: functions-gettree
----
-
-**function getTree();**
-
-Get the root node of the tree.
-
-{% highlight js %}
-var treeData = $('#tree1').tree('getTree');
-{% endhighlight %}

package/docs/_entries/functions/index.md

@@ -1,6 +0,0 @@
----
-title: Functions
-name: functions
-section: true
----
-

package/docs/_entries/functions/is-node-selected.md

@@ -1,11 +0,0 @@
----
-title: isNodeSelected
-name: multiple-selection-is-node-selected
----
-
-Return if this node is selected.
-
-{% highlight js %}
-var node = $('#tree1').tree('getNodeById', 123);
-var isSelected = $('#tree1').tree('isNodeSelected', node);
-{% endhighlight %}

package/docs/_entries/functions/isdragging.md

@@ -1,12 +0,0 @@
----
-title: isDragging
-name: functions-isdragging
----
-
-**function isDragging();**
-
-Is currently a node being dragged for drag-and-drop? Returns `True` or `False`.
-
-{% highlight js %}
-const isDragging = $('#tree1').tree('isDragging');
-{% endhighlight %}

package/docs/_entries/functions/loaddata.md

@@ -1,46 +0,0 @@
----
-title: loadData
-name: functions-loaddata
----
-
-**function loadData(data);**
-
-**function loadData(data, parentNode);**
-
-Load data in the tree. The data is array of nodes.
-
-You can **replace the whole tree** or you can **load a subtree**.
-
-{% highlight js %}
-// Assuming the tree exists
-var newData = [
-    {
-        name: 'node1',
-        children: [
-            { name: 'child1' },
-            { name: 'child2' }
-        ]
-    },
-    {
-        name: 'node2',
-        children: [
-            { name: 'child3' }
-        ]
-    }
-];
-$('#tree1').tree('loadData', newData);
-{% endhighlight %}
-
-Load a subtree:
-
-{% highlight js %}
-// Get node by id (this assumes that the nodes have an id)
-var node = $('#tree1').tree('getNodeById', 100);
-
-// Add new nodes
-var data = [
-    { name: 'new node' },
-    { name: 'another new node' }
-];
-$('#tree1').tree('loadData', data, node);
-{% endhighlight %}

package/docs/_entries/functions/loaddatafromurl.md

@@ -1,55 +0,0 @@
----
-title: loadDataFromUrl
-name: functions-loaddatafromurl
----
-
-**function loadDataFromUrl(url);**
-
-**function loadDataFromUrl(url, parentNode);**
-
-**function loadDataFromUrl(parentNode);**
-
-Load data in the tree from an url using ajax. You can **replace the whole tree** or you can **load a subtree**.
-
-{% highlight js %}
-$('#tree1').tree('loadDataFromUrl', '/category/tree/');
-{% endhighlight %}
-
-Load a subtree:
-
-{% highlight js %}
-var node = $('#tree1').tree('getNodeById', 123);
-$('#tree1').tree('loadDataFromUrl', '/category/tree/123', node);
-{% endhighlight %}
-
-You can also omit the url. In this case jqTree will generate a url for you. This is very useful if you use the load-on-demand feature:
-
-{% highlight js %}
-var $tree = $('#tree1');
-
-$tree.tree({
-    dataUrl: '/my_data/'
-});
-
-var node = $tree.tree('getNodeById', 456);
-
-// jqTree will load data from /my_data/?node=456
-$tree.tree('loadDataFromUrl', node);
-{% endhighlight %}
-
-You can also add an **on_finished** callback parameter that will be called when the data is loaded:
-
-**function loadDataFromUrl(url, parentNode, onFinished);**
-
-**function loadDataFromUrl(parentNode, onFinished);**
-
-{% highlight js %}
-$('#tree1').tree(
-    'loadDataFromUrl',
-    '/category/tree/123',
-    null,
-    function() {
-        alert('data is loaded');
-    }
-);
-{% endhighlight %}

package/docs/_entries/functions/movedown.md

@@ -1,8 +0,0 @@
----
-title: moveDown
-name: functions-movedown
----
-
-**function moveDown()**
-
-Select the next node. This does the same as the *down* key.

package/docs/_entries/functions/movenode.md

@@ -1,15 +0,0 @@
----
-title: moveNode
-name: functions-movenode
----
-
-**function moveNode(node, targetNode, position);**
-
-Move a node. Position can be 'before', 'after' or 'inside'.
-
-{% highlight js %}
-var node = $tree.tree('getNodeById', 1);
-var targetNode = $tree.tree('getNodeById', 2);
-
-$tree.tree('moveNode', node, targetNode, 'after');
-{% endhighlight %}

package/docs/_entries/functions/moveup.md

@@ -1,8 +0,0 @@
----
-title: moveUp
-name: functions-moveup
----
-
-**function moveUp()**
-
-Select the previous node. This does the same as the *up* key.

package/docs/_entries/functions/opennode.md

@@ -1,44 +0,0 @@
----
-title: openNode
-name: functions-opennode
----
-
-**function openNode(node);**
-
-**function openNode(node, slide);**
-
-**function openNode(node, onFinished);**
-
-**function openNode(node, slide, onFinished);**
-
-Open this node. The node must have child nodes.
-
-Parameter **slide (optional)**: open the node using a slide animation (default is true).
-Parameter **onFinished (optional)**: callback when the node is opened; this also works for nodes that are loaded lazily
-
-{% highlight js %}
-// create tree
-var $tree = $('#tree1');
-$tree.tree({
-    data: data
-});
-
-var node = $tree.tree('getNodeById', 123);
-$tree.tree('openNode', node);
-{% endhighlight %}
-
-To open the node without the slide animation, call with **slide** parameter is false.
-
-{% highlight js %}
-$tree.tree('openNode', node, false);
-{% endhighlight %}
-
-Example with `on_finished` callback:
-
-{% highlight js %}
-function handleOpened(node) {
-    console.log('openende node', node.name);
-}
-
-$tree.tree('openNode', node, handleOpened);
-{% endhighlight %}

package/docs/_entries/functions/prependnode.md

@@ -1,21 +0,0 @@
----
-title: prependNode
-name: functions-prependnode
----
-
-**function prependNode(newNodeInfo, parentNode);**
-
-Add a node to this parent node as the first child. If **parentNode** is empty, then the new node becomes a root node.
-
-{% highlight js %}
-var parentNode = $tree.tree('getNodeById', 123);
-
-$tree.tree(
-    'prependNode',
-    {
-        name: 'new_node',
-        id: 456
-    },
-    parentNode
-);
-{% endhighlight %}

package/docs/_entries/functions/refresh.md

@@ -1,12 +0,0 @@
----
-title: refresh
-name: functions-refresh
----
-
-**function refresh();**
-
-Refresh the rendered nodes. In most cases you will not use this, because tree functions will rerender automatically. E.g. The functions `openNode` and `updateNode` rerender automatically.
-
-{% highlight js %}
-$('#tree1').tree('refresh');
-{% endhighlight %}

package/docs/_entries/functions/reload.md

@@ -1,22 +0,0 @@
----
-title: reload
-name: functions-reload
----
-
-**function reload();**
-
-**function reload(onFinished);**
-
-Reload data from the server.
-
-* Call `onFinished` when the data is loaded.
-
-{% highlight js %}
-$('#tree1').tree('reload');
-{% endhighlight %}
-
-{% highlight js %}
-$('#tree1').tree('reload', function() {
-    console.log('data is loaded');
-});
-{% endhighlight %}

package/docs/_entries/functions/removenode.md

@@ -1,12 +0,0 @@
----
-title: removeNode
-name: functions-removenode
----
-
-**function removeNode(node);**
-
-Remove node from the tree.
-
-{% highlight js %}
-$('#tree1').tree('removeNode', node);
-{% endhighlight %}

package/docs/_entries/functions/scrolltonode.md

@@ -1,13 +0,0 @@
----
-title: scrollToNode
-name: functions-scrolltonode
----
-
-**function scrollToNode(node);**
-
-Scroll to this node. This is useful if the tree is in a container div and is scrollable.
-
-{% highlight js %}
-var node = $tree.tree('getNodeById', 1);
-$tree.tree('scrollToNode', node);
-{% endhighlight %}

package/docs/_entries/functions/selectnode.md

@@ -1,45 +0,0 @@
----
-title: selectNode
-name: functions-selectnode
----
-
-**function selectNode(node);**
-
-**function selectNode(null);**
-
-**function selectNode(node, { mustToggle, mustSetFocus });**
-
-Select this node.
-
-You can deselect the current node by calling **selectNode(null)**.
-
-{% highlight js %}
-// create tree
-const $tree = $('#tree1');
-$tree.tree({
-    data: data,
-    selectable: true
-});
-
-const node = $tree.tree('getNodeById', 123);
-$tree.tree('selectNode', node);
-{% endhighlight %}
-
-**Options**
-
-* **mustSetFocus**:
-  * **true (default)**: set the focus to the node; only do this on selection, not deselection
-  * **false**: do not set the focus
-* **mustToggle**:
-  * **true (default)**: toggle; deselected if selected and vice versa
-  * **false**: select the node, never deselect
-
- {% highlight js %}
- const node = $tree.tree('getNodeById', 123);
- $tree.tree('selectNode', { mustSetFocus: false });
- {% endhighlight %}
-
- {% highlight js %}
- const node = $tree.tree('getNodeById', 123);
- $tree.tree('selectNode', { mustToggle: false });
- {% endhighlight %}

package/docs/_entries/functions/setoption.md

@@ -1,12 +0,0 @@
----
-title: setOption
-name: functions-setoption
----
-
-**function setOption(option, value);**
-
-Set a tree option. These are the same options that you can set when creating the tree.
-
-{% highlight js %}
-$('#tree1').tree('setOption', 'keyboardSupport', false);
-{% endhighlight %}

package/docs/_entries/functions/setstate.md

@@ -1,8 +0,0 @@
----
-title: setState
-name: functions-setstate
----
-
-Set the state of the tree: which nodes are open and which one is selected?
-
-See [getState](#functions-getstate) for more information.

package/docs/_entries/functions/toggle.md

@@ -1,25 +0,0 @@
----
-title: toggle
-name: functions-toggle
----
-
-**function toggle(node);**
-
-**function toggle(node, slide);**
-
-* slide: true / false
-
-Open or close the tree node.
-
-Default: toggle with slide animation:
-
-{% highlight js %}
-var node = $tree.tree('getNodeById', 123);
-$tree.tree('toggle', node);
-{% endhighlight %}
-
-Toggle without animation:
-
-{% highlight js %}
-$tree.tree('toggle', node, false);
-{% endhighlight %}

package/docs/_entries/functions/tojson.md

@@ -1,13 +0,0 @@
----
-title: toJson
-name: functions-tojson
----
-
-**function toJson();**
-
-Get the tree data as json.
-
-{% highlight js %}
-// Assuming the tree exists
-$('#tree1').tree('toJson');
-{% endhighlight %}

package/docs/_entries/functions/updatenode.md

@@ -1,50 +0,0 @@
----
-title: updateNode
-name: functions-updatenode
----
-
-**function updateNode(node, name);**
-
-**function updateNode(node, data);**
-
-Update the title of a node. You can also update the data.
-
-Update the name:
-
-{% highlight js %}
-var node = $tree.tree('getNodeById', 123);
-
-$tree.tree('updateNode', node, 'new name');
-{% endhighlight %}
-
-Update the data (including the name)
-
-{% highlight js %}
-var node = $tree.tree('getNodeById', 123);
-
-$tree.tree(
-    'updateNode',
-    node,
-    {
-        name: 'new name',
-        id: 1,
-        otherProperty: 'abc'
-    }
-);
-{% endhighlight %}
-
-It is also possible to update the children. Note that this removes the existing children:
-
-{% highlight js %}
-$tree.tree(
-    'updateNode',
-    node,
-    {
-        name: 'new name',
-        id: 1,
-        children: [
-            { name: 'child1', id: 2 }
-        ]
-    }
-);
-{% endhighlight %}