jsTree 核心功能
$.jstree
包含所有与jstree相关的函数和变量,包括用于创建,访问和操作实例的实际类和方法。
$.jstree.version
指定正在使用的jstree版本
$.jstree.defaults
保留创建新实例时使用的所有默认选项
$.jstree.defaults.plugins
配置哪些插件将在实例上处于活动状态。应该是一个字符串数组,其中每个元素都是一个插件名称。默认是 []
$.jstree.plugins
存储所有已加载的jstree插件(内部使用)
$.jstree.reference (needle)
获取对现有实例的引用
needle
DOMElement
jQuery
String
Returns
jsTree
实例或null
如果找不到
例子
// provided a container with an ID of "tree", and a nested node with an ID of "branch"
// all of there will return the same instance
$.jstree.reference('tree');
$.jstree.reference('#tree');
$.jstree.reference($('#tree'));
$.jstree.reference(document.getElementByID('tree'));
$.jstree.reference('branch');
$.jstree.reference('#branch');
$.jstree.reference($('#branch'));
$.jstree.reference(document.getElementByID('branch'));
$().jstree([arg])
创建实例,获取实例或在实例上调用命令。
如果没有与当前节点关联的实例,则会创建一个新实例, arg
并用于扩展 $.jstree.defaults
该新实例。没有返回值(链接未中断)。
如果存在现有实例并且 arg
是字符串, arg
则在该实例上执行by指定的命令,并将任何其他参数传递给该函数。如果函数返回一个值,它将被返回(链接可能会中断,具体取决于函数)。
如果存在现有实例并且 arg
不是字符串,则返回实例本身(类似于 $.jstree.reference
).
在任何其他情况下,都不会返回任何内容,并且链接不会中断。
arg
String
Object
Returns
Mixed
例子
$('#tree1').jstree(); // creates an instance
$('#tree2').jstree({ plugins : [] }); // create an instance with some options
$('#tree1').jstree('open_node', '#branch_1'); // call a method on an existing instance, passing additional arguments
$('#tree2').jstree(); // get an existing instance (or create an instance)
$('#tree2').jstree(true); // get an existing instance (will not create new instance)
$('#branch_1').jstree().select_node('#branch_1'); // get an instance (using a nested element and call a method)
$(':jstree')
用于查找包含实例的元素
Returns
jQuery
例子
$('div:jstree').each(function () {
$(this).jstree('destroy');
});
$.jstree.defaults.core
存储核心的所有默认值
$.jstree.defaults.core.data
数据配置
如果 false
将jstree容器元素内的HTML 保留为HTML,则用于填充树(该树应该是具有列表项的无序列表)。
您还可以在此处传递HTML字符串或JSON数组。
可以传入标准的类似jQuery的AJAX配置,并且jstree将自动确定响应是JSON还是HTML,并使用其填充树。
可以传入标准的类似jQuery的AJAX配置,并且jstree将自动确定响应是JSON还是HTML,并使用其填充树。 data
和 url
,这些函数将在当前实例的范围内运行,并且将传递参数以指示要加载的节点,并将使用这些函数的返回值。
最后一个选项是指定一个函数,该函数将接收作为参数加载的节点和第二个参数,该参数应与结果一起调用。
例子
// AJAX
$('#tree').jstree({
'core' : {
'data' : {
'url' : '/get/children/',
'data' : function (node) {
return { 'id' : node.id };
}
}
});
// direct data
$('#tree').jstree({
'core' : {
'data' : [
'Simple root node',
{
'id' : 'node_2',
'text' : 'Root node with options',
'state' : { 'opened' : true, 'selected' : true },
'children' : [ { 'text' : 'Child 1' }, 'Child 2']
}
]
}
});
// function
$('#tree').jstree({
'core' : {
'data' : function (obj, callback) {
callback.call(this, ['Root 1', 'Root 2']);
}
});
$.jstree.defaults.core.strings
配置整个树中使用的各种字符串
您可以使用一个对象,其中键是您需要替换的字符串,而值是您要替换的字符串。
另一种选择是指定一个函数,该函数将使用所需字符串的参数调用,并应返回替换函数。
如果 false
不作任何替换。
例子
$('#tree').jstree({
'core' : {
'strings' : {
'Loading ...' : 'Please wait ...'
}
}
});
$.jstree.defaults.core.check_callback
确定当用户尝试修改树的结构时会发生什么情况。
如果 false
创建,重命名,删除,移动或复制之类的所有操作,则将其保留。
您可以将其设置 true
为允许所有交互,或使用功能进行更好的控制。
例子
$('#tree').jstree({
'core' : {
'check_callback' : function (operation, node, node_parent, node_position, more) {
// operation can be 'create_node', 'rename_node', 'delete_node', 'move_node', 'copy_node' or 'edit'
// in case of 'rename_node' node_position is filled with the new node name
return operation === 'rename_node' ? true : false;
}
}
});
$.jstree.defaults.core.error
发生错误(操作失败,ajax失败等)时,在实例范围内使用单个对象参数调用的回调
$.jstree.defaults.core.animation
打开 / 关闭动画的持续时间(以毫秒为单位)-将此设置 false
为禁用动画(默认值为 200
)
$.jstree.defaults.core.multiple
指示是否可以选择多个节点的布尔值
$.jstree.defaults.core.themes
主题配置对象
$.jstree.defaults.core.themes.name
要使用的主题名称(如果使用 false
默认主题则保留)
$.jstree.defaults.core.themes.url
主题的CSS文件的URL,请保留该属性,就 false
好像您已手动包含主题CSS(推荐)一样。您也可以将此设置为true
将尝试自动加载主题。
$.jstree.defaults.core.themes.dir
所有jstree主题的位置-仅当 url
设置为时使用 true
$.jstree.defaults.core.themes.dots
指示是否显示连接点的布尔值
$.jstree.defaults.core.themes.icons
指示是否显示节点图标的布尔值
$.jstree.defaults.core.themes.ellipsis
指示是否应显示节点省略号的布尔值-只能与容器上的固定with一起使用
$.jstree.defaults.core.themes.stripes
指示树背景是否为条纹的布尔值
$.jstree.defaults.core.themes.variant
一个字符串(或boolean false
),指定要使用的主题变体(如果主题支持变体)
$.jstree.defaults.core.themes.responsive
一个布尔值,指定主题的响应版本是否应在较小的屏幕上显示(如果主题支持)。默认为false
.
$.jstree.defaults.core.expand_selected_onload
如果 true
,则在树加载后将打开所有选定节点的所有父节点(以便用户看到所有选定节点)
$.jstree.defaults.core.worker
如果 true
Web Worker使用,则将在可能的情况下使用它来解析传入的JSON数据,以使UI不会被大请求阻塞。但是,工人的速度要慢30%。默认为 true
$.jstree.defaults.core.force_text
强制将节点文本转换为纯文本(并转义HTML)。默认为 false
$.jstree.defaults.core.dblclick_toggle
如果双击文本,是否应该切换节点。默认为 true
$.jstree.defaults.core.loaded_state
加载的节点是否应该是状态的一部分。默认为 false
$.jstree.defaults.core.restore_focus
当树容器模糊时应最后一个活动节点是否被聚焦,然后再次聚焦。这有助于使用屏幕阅读器。默认为 true
$.jstree.defaults.core.keyboard
默认的键盘快捷键(一个对象,其中每个键是按钮名称或组合键-例如'enter','ctrl-space','p'等,其值是在实例范围内执行的函数)
plugin (deco [, opts])
private
用于用插件装饰实例。内部使用。
deco
String
要装饰的插件opts
Object
插件选项
Returns
jsTree
init (el, optons)
private
初始化实例。内部使用。
el
DOMElement
jQuery
String
我们正在变换的元素options
Object
该实例的选项
Triggers
init.jstree
loading.jstree
loaded.jstree
ready.jstree
changed.jstree
init.jstree Event
绑定所有事件后触发
loading.jstree Event
在显示加载文本之后和加载开始之前触发
destroy ()
销毁实例
keep_html
Boolean
如果未设置为true
容器,则将清空该容器,否则当前DOM元素将保持不变
destroy.jstree Event
在树被破坏之前触发
_create_prototype_node ()
创建一个原型节点
Returns
DOMElement
teardown ()
private
销毁实例的一部分。内部使用。
bind ()
private
绑定所有事件。内部使用。
loaded.jstree Event
根节点首次加载后触发
ready.jstree Event
所有节点加载完成后触发
unbind ()
private
销毁实例的一部分。内部使用。
trigger (ev [, data])
private
触发事件。内部使用。
ev
String
要触发的事件的名称data
Object
与事件一起传递的其他数据
get_container ()
返回jQuery扩展实例容器
Returns
jQuery
get_container_ul ()
private
返回实例容器内部的jQuery扩展主UL节点。内部使用。
Returns
jQuery
get_string (key)
private
获取字符串替换(本地化)。内部使用。
key
String
Returns
String
_firstChild (dom)
private
获取DOM节点的第一个孩子。内部使用。
dom
DOMElement
Returns
DOMElement
_nextSibling (dom)
private
获取DOM节点的下一个同级。内部使用。
dom
DOMElement
Returns
DOMElement
_previousSibling (dom)
private
获取DOM节点的上一个同级。内部使用。
dom
DOMElement
Returns
DOMElement
get_node (obj [, as_dom])
通过使用任何输入(子DOM元素,ID字符串,选择器等)获取节点(或实际的jQuery扩展DOM节点)的JSON表示形式
obj
mixed
as_dom
Boolean
Returns
Object
jQuery
get_path (obj [, glue, ids])
获取到节点的路径,该路径可以由节点文本或节点ID组成,可以选择将其粘合在一起(否则为数组)
obj
mixed
节点glue
String
如果要将路径作为字符串-在此处传递胶水(例如'/'),如果在此处提供了伪造的值,则返回一个数组ids
Boolean
如果设置为true,则使用ID构建路径,否则使用节点文本
Returns
mixed
get_next_dom (obj [, strict])
获取该节点下方的下一个可见 obj
节点。如果strict
设置为true
仅返回同级节点。
obj
mixed
strict
Boolean
Returns
jQuery
get_prev_dom (obj [, strict])
获取该节点上方的上一个可见 obj
节点。如果 strict
设置为true
仅返回同级节点。
obj
mixed
strict
Boolean
Returns
jQuery
get_parent (obj)
获取节点的父ID
obj
mixed
Returns
String
get_children_dom (obj)
获取节点的所有子节点的jQuery集合(必须渲染节点),错误时返回false
obj
mixed
Returns
jQuery
is_parent (obj)
检查节点是否有子节点
obj
mixed
Returns
Boolean
is_loaded (obj)
检查节点是否已加载(其子节点可用)
obj
mixed
Returns
Boolean
is_loading (obj)
检查节点当前是否正在加载(正在获取子节点)
obj
mixed
Returns
Boolean
is_open (obj)
检查节点是否打开
obj
mixed
Returns
Boolean
is_closed (obj)
检查节点是否处于关闭状态
obj
mixed
Returns
Boolean
is_leaf (obj)
检查节点是否没有子节点
obj
mixed
Returns
Boolean
load_node (obj [, callback])
加载节点(使用 core.data
设置获取其子节点)。可以使用数组将多个节点传递给。
obj
mixed
callback
function
加载完成后要执行的函数,该函数在实例的范围内执行并接收两个参数-节点和布尔状态
Returns
Boolean
Triggers
load_node.jstree
load_node.jstree Event
节点加载后触发
node
Object
正在加载的节点status
Boolean
节点是否成功加载
_load_nodes (nodes [, callback])
private
loa加载节点数组(一旦不可用的节点出现在结构中,它们也将加载)。内部使用。
nodes
array
callback
function
加载完成后要执行的函数,该函数在实例的范围内执行并接收一个参数-传递给_load_nodes的数组
load_all ([obj, callback])
加载所有卸载的节点
obj
mixed
递归加载的节点,省略加载树中的所有节点callback
function
加载所有节点完成后要执行的功能,
Triggers
load_all.jstree
load_all.jstree Event
在load_all调用完成后触发
node
Object
递归加载的节点
_load_node (obj [, callback])
private
处理节点的实际加载。仅在内部使用。
obj
mixed
callback
function
加载完成后要执行的函数,该函数在实例的范围内执行并接收一个参数-布尔状态
Returns
Boolean
_node_changed (obj [, callback])
private
将节点添加到要重绘的节点列表中。仅在内部使用。
obj
mixed
_append_html_data (obj, data)
private
将HTML内容附加到树上。内部使用。
obj
mixed
要追加到的节点data
String
要解析和附加的HTML字符串
Triggers
model.jstree
changed.jstree
model.jstree Event
将新数据插入树模型时触发
nodes
Array
节点ID数组parent
String
节点的父ID
_append_json_data (obj, data)
private
将JSON内容附加到树上。内部使用。
obj
mixed
要追加到的节点data
String
要解析和附加的JSON对象force_processing
Boolean
内部参数-不设置
Triggers
model.jstree
changed.jstree
_parse_model_from_html (d [, p, ps])
private
解析来自jQuery对象的节点,并将其附加到内存树模型中。内部使用。
d
jQuery
要解析的jQuery对象p
String
家长编号ps
Array
所有父节点名单
Returns
String
添加到模型中的对象的ID
_parse_model_from_flat_json (d [, p, ps])
private
从JSON对象解析节点(用于处理平面数据,该节点没有子级嵌套,但具有id和parent属性),并将其附加到内存树模型中。内部使用。
d
Object
要解析的JSON对象p
String
家长编号ps
Array
所有父节点名单
Returns
String
添加到模型中的对象的ID
_parse_model_from_json (d [, p, ps])
private
从JSON对象解析一个节点,并将其附加到内存树模型中。内部使用。
d
Object
要解析的JSON对象p
String
家长编号ps
Array
所有父节点名单
Returns
String
添加到模型中的对象的ID
_redraw ()
private
重画所有需要重画的节点。内部使用。
Triggers
redraw.jstree
redraw.jstree Event
重绘节点后触发
nodes
array
重绘的节点
redraw ([full])
重绘所有需要重绘的节点,也可以选择重绘整个树
full
Boolean
如果设置为true
所有节点,则重绘。
draw_children (node)
private
重绘单个节点的子级。内部使用。
node
mixed
将重画其子节点的节点
redraw_node (node, deep, is_callback, force_render)
private
重绘单个节点。内部使用。
node
mixed
重画节点deep
Boolean
是否也应该重绘子节点is_callback
Boolean
这是递归调用吗force_render
Boolean
是否应该吸引亲密父节点的孩子
open_node (obj [, callback, animation])
打开一个节点,显示其子节点。如果未加载该节点,则准备就绪后将对其进行加载和打开。
obj
mixed
打开的节点callback
Function
打开节点后执行的功能animation
Number
打开节点时的动画持续时间(以毫秒为单位core.animation
)(覆盖设置)。使用false
了没有动画。
Triggers
open_node.jstree
after_open.jstree
before_open.jstree
before_open.jstree Event
在节点即将打开时触发(如果该节点应该在DOM中,则将打开,但尚不可见)
node
Object
打开的节点
open_node.jstree Event
在打开节点时触发(如果有动画,它将尚未完成)
node
Object
打开的节点
after_open.jstree Event
当节点打开且动画完成时触发
node
Object
打开的节点
_open_to (obj)
private
打开节点的每个父节点(应加载节点)
obj
mixed
显示的节点
close_node (obj [, animation])
关闭节点,隐藏其子节点
obj
mixed
要关闭的节点animation
Number
关闭节点时的动画持续时间(以毫秒为单位core.animation
)(覆盖设置)。使用false
了没有动画。
Triggers
close_node.jstree
after_close.jstree
close_node.jstree Event
当节点关闭时触发(如果有动画,它将还不完整)
node
Object
封闭节点
after_close.jstree Event
当节点关闭且动画完成时触发
node
Object
封闭节点
toggle_node (obj)
切换节点-如果打开则关闭它,如果关闭则打开它
obj
mixed
要切换的节点
open_all ([obj, animation, original_obj])
打开一个节点(或树)中的所有节点,显示其子节点。如果未加载该节点,则准备就绪后将对其进行加载和打开。
obj
mixed
以递归方式打开该节点,省略以打开树中的所有节点animation
Number
打开节点时的动画持续时间(以毫秒为单位),默认为无动画reference
jQuery
到开始该过程的节点(内部使用)
Triggers
open_all.jstree
open_all.jstree Event
open_all
回调结束时触发
node
Object
打开的节点
close_all ([obj, animation])
关闭一个节点(或树)中的所有节点,显示其子节点
obj
mixed
递归关闭节点,忽略关闭树中的所有节点animation
Number
关闭节点时的动画持续时间(以毫秒为单位),默认为无动画
Triggers
close_all.jstree
close_all.jstree Event
close_all
回调结束时触发
node
Object
封闭节点
is_disabled (obj)
检查节点是否被禁用(不可选择)
obj
mixed
Returns
Boolean
enable_node (obj)
启用节点-以便可以选择它
obj
mixed
要启用的节点
Triggers
enable_node.jstree
enable_node.jstree Event
启用节点时触发
node
Object
启用的节点
disable_node (obj)
禁用节点-使其无法选择
obj
mixed
要禁用的节点
Triggers
disable_node.jstree
disable_node.jstree Event
禁用节点时触发
node
Object
禁用的节点
is_hidden (obj)
确定节点是否隐藏
obj
mixed
节点
hide_node (obj)
隐藏一个节点-它仍然在结构中但不可见
obj
mixed
隐藏的节点skip_redraw
Boolean
内部参数控制是否调用重绘
Triggers
hide_node.jstree
hide_node.jstree Event
隐藏节点时触发
node
Object
隐藏的节点
show_node (obj)
显示一个节点
obj
mixed
要显示的节点skip_redraw
Boolean
内部参数控制是否调用重绘
Triggers
show_node.jstree
show_node.jstree Event
显示节点时触发
node
Object
所示的节点
hide_all ()
隐藏所有节点
Triggers
hide_all.jstree
hide_all.jstree Event
当所有节点都隐藏时触发
nodes
Array
所有隐藏节点的ID
show_all ()
显示所有节点
Triggers
show_all.jstree
show_all.jstree Event
显示所有节点时触发
nodes
Array
显示的所有节点的ID
activate_node (obj, e)
private
当用户选择节点时调用。内部使用。
obj
mixed
节点e
Object
相关事件
Triggers
activate_node.jstree
changed.jstree
activate_node.jstree Event
t当用户单击或插入节点时触发
node
Object
event
Object
触发呼叫的原始事件(如果有)(可能是一个空对象)
hover_node (obj)
private
将悬停状态应用于节点上,当用户悬停节点时调用。内部使用。
obj
mixed
Triggers
hover_node.jstree
hover_node.jstree Event
节点悬停时触发
node
Object
dehover_node (obj)
private
当用户不再将节点悬停时,从该节点移除悬停状态。内部使用。
obj
mixed
Triggers
dehover_node.jstree
dehover_node.jstree Event
当节点不再悬停时触发
node
Object
select_node (obj [, supress_event, prevent_open])
选择一个节点
obj
mixed
数组可用于选择多个节点supress_event
Boolean
如果设置为true
thechanged.jstree
事件将不会被触发prevent_open
Boolean
如果设置为true
选定节点的父级,则不会打开
Triggers
select_node.jstree
changed.jstree
select_node.jstree Event
选择节点时触发
node
Object
selected
Array
当前选择event
Object
触发此select_node的事件(如果有)
changed.jstree Event
选择更改时触发
node
Object
action
Object
导致选择更改的动作selected
Array
当前选择event
Object
触发此更改事件的事件(如果有)
deselect_node (obj [, supress_event])
取消选择节点
obj
mixed
数组可用于取消选择多个节点supress_event
Boolean
如果设置为true
thechanged.jstree
事件将不会被触发
Triggers
deselect_node.jstree
changed.jstree
deselect_node.jstree Event
取消选择节点时触发
node
Object
selected
Array
当前选择event
Object
触发此deselect_node的事件(如果有)
select_all ([supress_event])
选择树中的所有节点
supress_event
Boolean
如果设置为true
thechanged.jstree
事件将不会被触发
Triggers
select_all.jstree
changed.jstree
select_all.jstree Event
选择所有节点时触发
selected
Array
当前选择
deselect_all ([supress_event])
取消选择所有选定的节点
supress_event
Boolean
如果设置为true
thechanged.jstree
事件将不会被触发
Triggers
deselect_all.jstree
changed.jstree
deselect_all.jstree Event
取消选择所有节点时触发
node
Object
先前的选择selected
Array
当前选择
is_selected (obj)
检查是否选择了节点
obj
mixed
Returns
Boolean
get_selected ([full])
获取所有选定节点的数组
full
mixed
如果设置为true
返回的数组将由完整的节点对象组成,否则-仅返回ID
Returns
Array
get_top_selected ([full])
获取所有顶级选定节点的数组(忽略选定节点的子级)
full
mixed
如果设置为true
返回的数组将由完整的节点对象组成,否则-仅返回ID
Returns
Array
get_bottom_selected ([full])
获取所有底层选定节点的数组(忽略选定的父级)
full
mixed
如果设置为true
返回的数组将由完整的节点对象组成,否则-仅返回ID
Returns
Array
get_state ()
private
获取树的当前状态,以便以后可以使用恢复它set_state(state)
。内部使用。
Returns
Object
set_state (state [, callback])
private
设置树的状态。内部使用。
state
Object
恢复状态。请记住,此对象是通过引用传递的,jstree会对其进行修改。callback
Function
恢复状态后执行的可选函数。
Triggers
set_state.jstree
set_state.jstree Event
set_state
回调结束时触发
refresh ()
刷新树-所有节点都重新加载了对的调用load_node
.
skip_loading
Boolean
跳过显示加载指示器的选项forget_state
Mixed
如果设置为true
则不会重新应用,如果设置为一个函数(将当前状态作为参数接收),则该函数的结果将用作状态
Triggers
refresh.jstree
refresh.jstree Event
refresh
回调结束时触发
refresh_node (obj)
刷新树中的一个节点(重新加载其子节点),该节点内的所有打开的节点都重新调用 load_node
.
obj
mixed
节点
Triggers
refresh_node.jstree
refresh_node.jstree Event
刷新节点时触发
node
Object
- 刷新的节点
nodes
Array
- 重载节点的ID的数组
set_id (obj, id)
设置(更改)节点的ID
obj
mixed
节点id
String
新的ID
Returns
Boolean
Triggers
set_id.jstree
set_id.jstree Event
节点ID值更改时触发
node
Object
old
String
旧ID
get_text (obj)
获取节点的文本值
obj
mixed
节点
Returns
String
set_text (obj, val)
private
设置节点的文本值。内部使用,请使用rename_node(obj, val)
.
obj
mixed
该节点,您可以传递一个数组以在多个节点上设置文本val
String
新的文字值
Returns
Boolean
Triggers
set_text.jstree
set_text.jstree Event
节点文本值更改时触发
obj
Object
text
String
新值
get_json ([obj, options])
获取节点(或整个树)的JSON表示形式
obj
mixed
options
Object
options.no_state
Boolean
不返回状态信息options.no_id
Boolean
不返回IDoptions.no_children
Boolean
不包括子节点options.no_data
Boolean
不包含节点数据options.no_li_attr
Boolean
不包含LI属性options.no_a_attr
Boolean
不包含A属性options.flat
Boolean
返回平面JSON而不是嵌套
Returns
Object
create_node ([par, node, pos, callback, is_loaded])
创建一个新节点(不要与load_node混淆)
par
mixed
父节点(要创建根节点,请使用“#”(字符串)或null
)node
mixed
新节点的数据(有效的JSON对象或名称简单的字符串)pos
mixed
还支持插入节点的索引“ first”和“ last”,默认为“ last”callback
Function
创建节点后要调用的功能is_loaded
Boolean
内部参数,指示父节点是否已成功加载
Returns
String
新创建节点的ID
Triggers
model.jstree
create_node.jstree
create_node.jstree Event
在创建节点时触发
node
Object
parent
String
父节点的IDposition
Number
新节点在父节点子女中的位置
rename_node (obj, val)
设置节点的文本值
obj
mixed
该节点,您可以传递一个数组以将多个节点重命名为相同的名称val
String
新的文字值
Returns
Boolean
Triggers
rename_node.jstree
rename_node.jstree Event
重命名节点时触发
node
Object
text
String
新值old
String
旧值
delete_node (obj)
删除节点
obj
mixed
该节点,您可以传递一个数组来删除多个节点
Returns
Boolean
Triggers
delete_node.jstree
changed.jstree
delete_node.jstree Event
删除节点时触发
node
Object
parent
String
父节点的ID
check (chk, obj, par, pos)
private
检查是否允许在树上进行操作。内部使用。
chk
String
检查的操作可以是"create_node", "rename_node", "delete_node", "copy_node" or "move_node"obj
mixed
节点par
mixed
父节点pos
mixed
要插入的位置,或者如果是“ rename_node”-新名称more
mixed
一些各种其他信息,例如,如果DND触发了“ move_node”操作,则将其作为悬停的节点
Returns
Boolean
last_error ()
得到最后的错误
Returns
Object
move_node (obj, par [, pos, callback, is_loaded])
将节点移到新的父节点
obj
mixed
要移动的节点,传递一个数组以移动多个节点par
mixed
新父节点pos
mixed
插入位置(除了整数值,还支持“第一个”和“最后一个”,以及“之前”和“之后”),默认为整数0
callback
function
移动完成后要调用的函数,将接收3个参数-节点,新父对象和位置is_loaded
Boolean
内部参数,指示是否已加载父节点skip_redraw
Boolean
内部参数,指示是否应重绘树instance
Boolean
内部参数,指示节点是否来自另一个实例
Triggers
move_node.jstree
move_node.jstree Event
节点移动时触发
node
Object
parent
String
父节点的IDposition
Number
节点在父级子级中的位置old_parent
String
节点的旧父级old_position
Number
节点的旧位置is_multi
Boolean
节点和新父节点属于不同的实例吗old_instance
jsTree
节点来自的实例new_instance
jsTree
新父节点的实例
copy_node (obj, par [, pos, callback, is_loaded])
将节点复制到新的父节点
obj
mixed
要复制的节点,传递一个数组以复制多个节点par
mixed
新父节点pos
mixed
插入位置(除了整数值,还支持“第一个”和“最后一个”,以及“之前”和“之后”),默认为整数0
callback
function
移动完成后要调用的函数,将接收3个参数-节点,新父对象和位置is_loaded
Boolean
内部参数,指示是否已加载父节点skip_redraw
Boolean
内部参数,指示是否应重绘树instance
Boolean
内部参数,指示节点是否来自另一个实例
Triggers
model.jstree copy_node.jstree
copy_node.jstree Event
复制节点时触发
node
Object
复制的节点original
Object
原始节点parent
String
父节点的IDposition
Number
节点在父级子级中的位置old_parent
String
节点的旧父级old_position
Number
原始节点的位置is_multi
Boolean
节点和新父节点属于不同的实例吗old_instance
jsTree
节点来自的实例new_instance
jsTree
新父节点的实例
cut (obj)
剪切一个节点(稍后调用 paste(obj)
将移动该节点)
obj
mixed
可以使用数组传递多个对象
Triggers
cut.jstree
cut.jstree Event
将节点添加到缓冲区以进行移动时触发
node
Array
copy (obj)
复制节点(以后的调用 paste(obj)
将复制该节点)
obj
mixed
可以使用数组传递多个对象
Triggers
copy.jstree
copy.jstree Event
将节点添加到缓冲区以进行复制时触发
node
Array
get_buffer ()
获取当前缓冲区(所有等待粘贴操作的节点)
Returns
Object
由mode
(“ copy_node”或“ move_node”),node
(对象数组)和inst
(实例)组成的对象
can_paste ()
检查缓冲区中是否有东西要粘贴
Returns
Boolean
paste (obj [, pos])
将先前剪切或复制的节点复制或移动到新的父节点
obj
mixed
新父节点pos
mixed
插入位置(除了整数,还支持“第一个”和“最后一个”),默认为整数0
Triggers
paste.jstree
paste.jstree Event
调用粘贴时触发
parent
String
接收节点的IDnode
Array
缓冲区中的节点mode
String
执行的操作-“ copy_node”或“ move_node”
clear_buffer ()
清除先前复制或剪切的节点的缓冲区
Triggers
clear_buffer.jstree
clear_buffer.jstree Event
清除复制/剪切缓冲区时触发
edit (obj [, default_text, callback])
将节点置于编辑模式(输入字段以重命名该节点)
obj
mixed
default_text
String
用于填充输入的文本(如果省略或设置为非字符串值,则使用节点的文本值)callback
Function
文本框模糊后要调用的函数,它将在实例的范围内被调用并接收节点,状态参数(如果重命名成功则为true,否则为false)和指示用户是否取消编辑的布尔值。您可以使用.text访问节点的标题
set_theme (theme_name [, theme_url])
改变主题
theme_name
String
要应用的新主题的名称theme_url
mixed
此主题的CSS文件的位置。false
如果手动包含文件,则省略或设置为。设置为true
从core.themes.dir
目录自动加载。
Triggers
set_theme.jstree
set_theme.jstree Event
设置主题时触发
theme
String
新主题
get_theme ()
获取当前应用的主题名称的名称
Returns
String
set_theme_variant (variant_name)
更改主题变体(如果主题具有变体)
variant_name
String
Boolean
要应用的变体(如果false
已使用,则删除当前变体)
get_theme ()
gets the name of the currently applied theme variant
Returns
String
show_stripes ()
在容器上显示条纹背景(如果主题支持)
show_stripes.jstree Event
显示条纹时触发
hide_stripes ()
隐藏容器上的条纹背景
hide_stripes.jstree Event
隐藏条纹时触发
toggle_stripes ()
切换容器上的条纹背景
show_dots ()
显示连接点(如果主题支持)
show_dots.jstree Event
显示点时触发
hide_dots ()
隐藏连接点
hide_dots.jstree Event
点被隐藏时触发
toggle_dots ()
切换连接点
show_icons ()
显示节点图标
show_icons.jstree Event
triggered when icons are shown
hide_icons ()
hide the node icons
hide_icons.jstree Event
triggered when icons are hidden
toggle_icons ()
切换节点图标
show_icons ()
show the node ellipsis
show_ellipsis.jstree Event
显示省略号时触发
hide_ellipsis ()
隐藏节点省略号
hide_ellipsis.jstree Event
隐藏省略号时触发
toggle_icons ()
toggle the node ellipsis
set_icon (obj, icon)
设置节点的节点图标
obj
mixed
icon
String
新图标-如果使用当前目录中的图像使用./
前缀,则可以是图标或className的路径,否则将被检测为类
get_icon (obj)
获取节点的节点图标
obj
mixed
Returns
String
hide_icon (obj)
隐藏单个节点上的图标
obj
mixed
show_icon (obj)
在单个节点上显示图标
obj
mixed