jsTreeドキュメント日本語訳

 Checkbox plugin

This plugin renders checkbox icons in front of each node, making multiple selection much easier.
It also supports tri-state behavior, meaning that if a node has a few of its children checked it will be rendered as undetermined, and state will be propagated up.

stores all defaults for the checkbox plugin

a boolean indicating if checkboxes should be visible (can be changed at a later time using show_checkboxes() and hide_checkboxes). Defaults to true.

a boolean indicating if clicking anywhere on the node should act as clicking on the checkbox. Defaults to true.

a boolean indicating if the selected style of a node should be kept, or removed. Defaults to true.

This setting controls how cascading and undetermined nodes are applied.
If 'up' is in the string - cascading up is enabled, if 'down' is in the string - cascading down is enabled, if 'undetermined' is in the string - undetermined nodes will be used.
If three_state is set to true this setting is automatically set to 'up+down+undetermined'. Defaults to ''.

This setting controls if checkbox are bound to the general tree selection or to an internal array maintained by the checkbox plugin. Defaults to true, only set to false if you know exactly what you are doing.

show the node checkbox icons

hide the node checkbox icons

checks if a node is in an undetermined state

check a node (only if tie_selection in checkbox settings is false, otherwise select_node will be called internally)

triggered when an node is checked (only if tie_selection in checkbox settings is false)

uncheck a node (only if tie_selection in checkbox settings is false, otherwise deselect_node will be called internally)

triggered when an node is unchecked (only if tie_selection in checkbox settings is false)

checks all nodes in the tree (only if tie_selection in checkbox settings is false, otherwise select_all will be called internally)

triggered when all nodes are checked (only if tie_selection in checkbox settings is false)

uncheck all checked nodes (only if tie_selection in checkbox settings is false, otherwise deselect_all will be called internally)

triggered when all nodes are unchecked (only if tie_selection in checkbox settings is false)

checks if a node is checked (if tie_selection is on in the settings this function will return the same as is_selected)

get an array of all checked nodes (if tie_selection is on in the settings this function will return the same as get_selected)

get an array of all top level checked nodes (ignoring children of checked nodes) (if tie_selection is on in the settings this function will return the same as get_top_selected)

get an array of all bottom level checked nodes (ignoring selected parents) (if tie_selection is on in the settings this function will return the same as get_bottom_selected)

 Contextmenu plugin

Shows a context menu when a node is right-clicked.

stores all defaults for the contextmenu plugin

a boolean indicating if the node should be selected when the context menu is invoked on it. Defaults to true.

a boolean indicating if the menu should be shown aligned with the node. Defaults to true, otherwise the mouse coordinates are used.

an object of actions, or a function that accepts a node and a callback function and calls the callback function with an object of actions available for that node (you can also return the items too).

Each action consists of a key (a unique name) and a value which is an object with the following properties (only label and action are required):

• separator_before - a boolean indicating if there should be a separator before this item
• separator_after - a boolean indicating if there should be a separator after this item
• _disabled - a boolean indicating if this action should be disabled
• label - a string - the name of the action (could be a function returning a string)
• action - a function to be executed if this item is chosen
• icon - a string, can be a path to an icon or a className, if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class
• shortcut - keyCode which will trigger the action if the menu is open (for example 113 for rename, which equals F2)
• shortcut_label - shortcut label (like for example F2 for rename)

"shortcut" : 113,
"shortcut_label" : 'F2',
"icon" : "glyphicon glyphicon-leaf",

if(!('oncontextmenu' in document.body) && ('ontouchstart' in document.body)) {
var el = null, tm = null;
this.element
.on("touchstart", ".jstree-anchor", function (e) {
el = e.currentTarget;
tm = +new Date();
$(document).one("touchend", function (e) {
e.target = document.elementFromPoint(e.originalEvent.targetTouches[0].pageX - window.pageXOffset, e.originalEvent.targetTouches[0].pageY - window.pageYOffset);
e.currentTarget = e.target;
tm = ((+(new Date())) - tm);
if(e.target === el && tm > 600 && tm < 1000) {
e.preventDefault();
$(el).trigger('contextmenu', e);
}
el = null;
tm = null;
});
});
}

prepare and show the context menu for a node

triggered when the contextmenu is shown for a node

triggered on the document when the contextmenu is parsed (HTML is built)

triggered on the document when the contextmenu is shown

triggered on the document when the contextmenu is hidden

 Drag'n'drop plugin

Enables dragging and dropping of nodes in the tree, resulting in a move or copy operations.

stores all defaults for the drag'n'drop plugin

a boolean indicating if a copy should be possible while dragging (by pressint the meta key or Ctrl). Defaults to true.

a number indicating how long a node should remain hovered while dragging to be opened. Defaults to 500.

a function invoked each time a node is about to be dragged, invoked in the tree's scope and receives the nodes about to be dragged as an argument (array) - return false to prevent dragging

a boolean indicating if checks should constantly be made while the user is dragging the node (as opposed to checking only on drop), default is true

a boolean indicating if nodes from this tree should only be copied with dnd (as opposed to moved), default is false

when dropping a node "inside", this setting indicates the position the node should go to - it can be an integer or a string: "first" (same as 0) or "last", default is 0

when starting the drag on a node that is selected this setting controls if all selected nodes are dragged or only the single node, default is true, which means all selected nodes are dragged when the drag is started on a selected node

controls whether dnd works on touch devices. If left as boolean true dnd will work the same as in desktop browsers, which in some cases may impair scrolling. If set to boolean false dnd will not work on touch devices. There is a special third option - string "selected" which means only selected nodes can be dragged on touch devices.

controls whether items can be dropped anywhere on the node, not just on the anchor, by default only the node anchor is a valid drop target. Works best with the wholerow plugin. If enabled on mobile depending on the interface it might be hard for the user to cancel the drop, since the whole tree container will be a valid drop target.

controls whether a drag can be initiated from any part of the node and not just the text/icon part, works best with the wholerow plugin. Keep in mind it can cause problems with tree scrolling on mobile depending on the interface - in that case set the touch option to "selected".

triggered on the document when a drag causes an element to scroll

triggered on the document when a drag starts

triggered on the document when a drag is in progress

triggered on the document when a drag stops (the dragged element is dropped)

 Massload plugin

Adds massload functionality to jsTree, so that multiple nodes can be loaded in a single request (only useful with lazy loading).

 Search plugin

Adds search functionality to jsTree.

stores all defaults for the search plugin

a jQuery-like AJAX config, which jstree uses if a server should be queried for results.

A str (which is the search string) parameter will be added with the request, an optional inside parameter will be added if the search is limited to a node id. The expected result is a JSON array with nodes that need to be opened so that matching nodes will be revealed.
Leave this setting as false to not query the server. You can also set this to a function, which will be invoked in the instance's scope and receive 3 parameters - the search string, the callback to call with the array of nodes to load, and the optional node ID to limit the search to

Indicates if the search should be fuzzy or not (should chnd3 match child node 3). Default is false.

Indicates if the search should be case sensitive. Default is false.

Indicates if the tree should be filtered (by default) to show only matching nodes (keep in mind this can be a heavy on large trees in old browsers).
This setting can be changed at runtime when calling the search method. Default is false.

Indicates if all nodes opened to reveal the search result, should be closed when the search is cleared or a new search is performed. Default is true.

Indicates if only leaf nodes should be included in search results. Default is false.

If set to a function it wil be called in the instance's scope with two arguments - search string and node (where node will be every node in the structure, so use with caution).
If the function returns a truthy value the node will be considered a match (it might not be displayed if search_only_leaves is set to true and the node is not a leaf). Default is false.

used to search the tree nodes for a given string

triggered after search is complete

used to clear the last search (removes classes and shows all nodes if filtering is on)

triggered after search is complete

 Sort plugin

Automatically sorts all siblings in the tree according to a sorting function.

 State plugin

Saves the state of the tree (selected nodes, opened nodes) on the user's computer using available options (localStorage, cookies, etc)

A string for the key to use when saving the current tree (change if using multiple trees in your project). Defaults to jstree.

A space separated list of events that trigger a state save. Defaults to changed.jstree open_node.jstree close_node.jstree.

Time in milliseconds after which the state will expire. Defaults to 'false' meaning - no expire.

A function that will be executed prior to restoring state with one argument - the state object. Can be used to clear unwanted parts of the state.

triggered when the state plugin is finished restoring the state (and immediately after ready if there is no state to restore).

save the state

restore the state from the user's computer

clear the state on the user's computer

 Types plugin

Makes it possible to add predefined types for groups of nodes, which make it possible to easily control nesting rules and icon for each group.

An object storing all types as key value pairs, where the key is the type name and the value is an object that could contain following keys (all optional).

• max_children the maximum number of immediate children this node type can have. Do not specify or set to -1 for unlimited.
• max_depth the maximum number of nesting this node type can have. A value of 1 would mean that the node can have children, but no grandchildren. Do not specify or set to -1 for unlimited.
• valid_children an array of node type strings, that nodes of this type can have as children. Do not specify or set to -1 for no limits.
• icon a string - can be a path to an icon or a className, if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class. Omit to use the default icon from your theme.

There are two predefined types:

• # represents the root of the tree, for example max_children would control the maximum number of root nodes.
• default represents the default node - any settings here will be applied to all nodes that do not have a type specified.

used to retrieve the type settings object for a node

used to retrieve the type string or settings object for a node

used to change a node's type

 Unique plugin

Enforces that no nodes with the same name can coexist as siblings.

stores all defaults for the unique plugin

Indicates if the comparison should be case sensitive. Default is false.

A callback executed in the instance's scope when a new node is created and the name is already taken, the two arguments are the conflicting name and the counter. The default will produce results like New node (2).