The plugin (derrived from jQuery.Widget).
Note:
These methods implement the standard jQuery UI widget API.
It is recommended to use methods of the {Fancytree} instance instead
- Deprecated:
- Use methods of the {Fancytree} instance instead
- Source:
- See:
Example
// DEPRECATED: Access jQuery UI widget methods and members:
var tree = $("#tree").fancytree("getTree");
var node = $("#tree").fancytree("getActiveNode");
// RECOMMENDED: Use the Fancytree object API
var tree = $.ui.fancytree.getTree("#tree");
var node = tree.getActiveNode();
// or you may already have stored the tree instance upon creation:
import {createTree, version} from 'jquery.fancytree'
const tree = createTree('#tree', { ... });
var node = tree.getActiveNode();
Members
options :FancytreeOptions
These options will be used as defaults
Type:
- Source:
Method Summary
Return Type | Name and Arguments | Details |
---|---|---|
void |
_destroy()
Use the destroy method to clean up any modifications your widget has made to the DOM |
Details |
FancytreeNode |
getActiveNode()
Return the active node or null. |
Details |
FancytreeNode |
getNodeByKey(key)
Return the matching node or null. |
Details |
FancytreeNode |
getRootNode()
Return the invisible system root node. |
Details |
Fancytree |
getTree()
Return the current tree instance. |
Details |
Method Details
_destroy()
Use the destroy method to clean up any modifications your widget has made to the DOM
- Source:
getActiveNode() → {FancytreeNode}
Return the active node or null.
- Deprecated:
- Use methods of the Fancytree instance instead (example above).
- Source:
Returns:
- Type
- FancytreeNode
getNodeByKey(key) → {FancytreeNode}
Return the matching node or null.
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
- Deprecated:
- Use methods of the Fancytree instance instead (example above).
- Source:
Returns:
- Type
- FancytreeNode
getRootNode() → {FancytreeNode}
Return the invisible system root node.
- Deprecated:
- Use methods of the Fancytree instance instead (example above).
- Source:
Returns:
- Type
- FancytreeNode
getTree() → {Fancytree}
Return the current tree instance.
- Deprecated:
- Use `$.ui.fancytree.getTree()` instead (example above).
- Source:
Returns:
- Type
- Fancytree