jsTree 核心功能(core functionality) API

Annkiny - 博客园

由于网站访问慢,所以拷贝了一份到此

https://viky-zhang.gitbooks.io/jstree-doc/content/api-core.html

1. jsTree 核心功能(core functionality)

1.1. $.jstree

1.2. $.jstree.version

1.3. $.jstree.defaults

1.4. $.jstree.defaults.plugins

1.5. $.jstree.plugins

1.6. $.jstree.create (el [, options])

参数/返回描述elDOMElement jQuery String,要创建实例的元素,可以是jQuery对象或一个选择器optionsObject 此实例的配置(扩展自$.jstree.defaults)返回jsTree 新的实例

1.7. $.jstree.destroy ()

1.8. $.jstree.core (id) - - private

参数描述idNumber 此实例的索引号(index)

1.9. $.jstree.reference (needle)

参数/返回描述needleDOMElement jQuery String返回jsTree null 实例,若找不到实例则返回 null

$.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'));

1.10. $().jstree([arg])

参数/返回描述argString Object返回Mixed

$('#tree1').jstree(); 
$('#tree2').jstree({ plugins : [] }); 
$('#tree1').jstree('open_node', '#branch_1'); 
$('#tree2').jstree(); 
$('#tree2').jstree(true); 
$('#branch_1').jstree().select_node('#branch_1'); 

1.11. $(':jstree')

$('div:jstree').each(function () {
    $(this).jstree('destroy');
});

1.12. $.jstree.defaults.core

1.13. $.jstree.defaults.core.data

$('#tree').jstree({
    'core' : {
        'data' : {
            'url' : '/get/children/',
            'data' : function (node) {
                return { 'id' : node.id };
            }
        }
    });


$('#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']
            }
        ]
    }
});


$('#tree').jstree({
    'core' : {
        'data' : function (obj, callback) {
            callback.call(this, ['Root 1', 'Root 2']);
        }
    });

1.14. $.jstree.defaults.core.strings

$('#tree').jstree({
    'core' : {
        'data' : function (obj, callback) {
            callback.call(this, ['Root 1', 'Root 2']);
        }
    });

1.15. $.jstree.defaults.core.check_callback

  • false,所有操作(创建 create、重命名 rename、删除 delete、移动 move、复制 copy)都将被阻止。
  • true,所有操作都被允许。
  • 函数,更详细的逻辑控制。
$('#tree').jstree({
    'core' : {
        'check_callback' : function (operation, node, node_parent, node_position, more) {
            
            
            return operation === 'rename_node' ? true : false;
        }
    }
});

1.16. $.jstree.defaults.core.error

1.17. $.jstree.defaults.core.animation

  • 默认:200
  • false:禁用动画过渡
  • 数字:单位 毫秒

1.18. $.jstree.defaults.core.multiple

1.19. $.jstree.defaults.core.themes

1.20. $.jstree.defaults.core.themes.name

1.21. $.jstree.defaults.core.themes.url

  • 字符串:URL
  • false:不加载额外的 CSS 文件(因为你可在页面手动包含主题的 CSS 文件)
  • true:jstree 将尝试自动加载主题 CSS 文件

1.22. $.jstree.defaults.core.themes.dir

1.23. $.jstree.defaults.core.themes.dots

1.24. $.jstree.defaults.core.themes.icons

1.25. $.jstree.defaults.core.themes.ellipsis

1.26. $.jstree.defaults.core.themes.stripes

1.27. $.jstree.defaults.core.themes.variant

1.28. $.jstree.defaults.core.themes.responsive

1.29. $.jstree.defaults.core.expand_selected_onload

1.30. $.jstree.defaults.core.worker

1.31. $.jstree.defaults.core.force_text

1.32. $.jstree.defaults.core.dblclick_toggle

1.33. plugin (deco [, opts]) - - private

参数/返回描述decoString 插件名optsObject 插件的配置返回jsTree

1.34. init (el, optons) - - private

参数/触发描述elDOMElement jQuery String 将要成为树元素optionsObject 实例的配置触发器(Triggers)init.jstree loading.jstree loaded.jstree ready.jstree changed.jstree

1.35. init.jstree ( Event ⚡ )

1.36. loading.jstree ( Event ⚡ )

1.37. destroy ()

参数描述keep_htmlBoolean 若为true,树容器将被清空,否则将保持原状

1.38. 创建节点原型(Create prototype node)

1.39. teardown () - - private

1.40. bind () - - private

1.41. loaded.jstree ( Event ⚡ )

1.42. ready.jstree ( Event ⚡ )

1.43. unbind () - - private

1.44. trigger (ev [, data]) - - private

参数描述evString 要触发的事件名称dataObject 传递给事件的附加数据

1.45. get_container ()

1.46. get_container_ul () - - private

1.47. get_string (key) - - private

参数/返回描述keyString返回String

1.48. _firstChild (dom) - - private

参数/返回描述domDOMElement返回DOMElement

1.49. _nextSibling (dom) - - private

参数/返回描述domDOMElement返回DOMElement

1.50. _previousSibling (dom) - - private

参数/返回描述domDOMElement返回DOMElement

1.51. get_node (obj [, as_dom])

参数/返回描述objmixedas_domBoolean返回Object jQuery

1.52. get_path (obj [, glue, ids])

  • 一堆节点名称
  • 一堆节点ID
  • 一堆节点名和 ID(或数组)

参数/返回描述objmixed 节点glueString 若是字符串,则填间隔字符串(如/),若是一个假值(译注),则返回数组idsBoolean 若为true则用节点ID 构建路径,否则用节点名称返回mixed

1.53. get_next_dom (obj [, strict])

参数/返回描述objmixedstrictBoolean返回jQuery

1.54. get_prev_dom (obj [, strict])

参数/返回描述objmixedstrictBoolean返回jQuery

1.55. get_parent (obj)

参数/返回描述objmixed返回String

1.56. get_children_dom (obj)

参数/返回描述objmixed返回jQuery

1.57. is_parent (obj)

参数/返回描述objmixed返回Boolean

1.58. is_loaded (obj)

参数/返回描述objmixed返回Boolean

1.59. is_loading (obj)

参数/返回描述objmixed返回Boolean

1.60. is_open (obj)

参数/返回描述objmixed返回Boolean

1.61. is_closed (obj)

参数/返回描述objmixed返回Boolean

1.62. is_leaf (obj)

参数/返回描述objmixed返回Boolean

1.63. load_node (obj [, callback])

参数/返回/触发描述objmixedcallbackfunction 加载完毕的回调,将在实例的范围中执行,并接收两个参数:节点、boolean 状态返回Boolean触发事件load_node.jstree

1.64. load_node.jstree ( Event ⚡ )

参数描述nodeObject 已加载的节点statusBoolean 是否加载成功

1.65. _load_nodes (nodes [, callback]) - - private

参数描述nodearraycallbackfunction 加载完毕的回调,将在实例的范围中执行,并接收 1 个参数:传入的那些节点(数组)

1.66. load_all ([obj, callback])

参数描述nodemixed 加载节点下的所有节点,而非整棵树的所有节点statusfunction 加载成功的回调触发事件load_all.jstree

1.67. load_all.jstree ( Event ⚡ )

参数描述nodeObject 已递归加载的节点

1.68. _load_node (obj [, callback]) - - private

参数/返回描述objmixedcallbackfunction 加载完毕后执行此回调函数,此函数允许在实例范围内,并将接收 1 个状态参数(boolean)返回Boolean

1.69. _node_changed (obj [, callback]) - - private

1.70. _append_html_data (obj, data) - - private

参数/触发描述objmixed 要添加到的节点dataString HTML 字符串触发事件model.jstree changed.jstree

1.71. model.jstree ( Event ⚡ )

参数描述nodesArray 节点ID 数组parentString 这些节点的父节点ID

1.72. _append_json_data (obj, data) - - private

参数/触发描述objmixed 要添加到的节点dataString JSON 对象字符串force_processingBoolean 内部参数(无需设置)触发事件model.jstree changed.jstree

1.73. _parse_model_from_html (d [, p, ps]) - - private

参数/返回描述djQueryjQuery对象pString 父节点IDpsArray 所有的父节点列表返回String 将被添加到模型中的节点ID

1.74. _parse_model_from_flat_json (d [, p, ps]) - - private

参数/返回描述dObject JSON 对象pString 父节点IDpsArray 所有的父节点列表返回String 将被添加到模型中的节点ID

1.75. _parse_model_from_json (d [, p, ps]) - - private

参数/返回描述dObject JSON 对象pString 父节点IDpsArray 所有的父节点列表返回String 将被添加到模型中的节点ID

1.76. _redraw () - - private

1.77. redraw.jstree ( Event ⚡ )

1.78. redraw ([full])

参数描述fullBoolean 若true则重绘整个树的所有节点

1.79. draw_children (node) - - private

参数描述nodemixed 节点(将重绘其子节点)

1.80. redraw_node (node, deep, is_callback, force_render) - - private

参数描述nodemixed 将要重绘的节点deepBoolean 是否也重绘子节点is_callbackBoolean 是否递归调用force_renderBoolean 是否也重绘父节点未打开的子节点

1.81. open_node (obj [, callback, animation])

参数/触发描述objmixed 将要打开的节点callbackFunction 节点打开完毕后的回调animationNumber 打开节点时的动画过渡时间(毫秒)(覆盖core.animation的设置),若为false则禁用动画效果触发事件open_node.jstree after_open.jstree before_open.jstree

1.82. before_open.jstree ( Event ⚡ )

1.83. open_node.jstree ( Event ⚡ )

1.84. after_open.jstree ( Event ⚡ )

1.85. _open_to (obj) - - private

1.86. close_node (obj [, animation])

参数描述objmixed 需关闭的节点animationNumber 关闭节点时的动画过渡时间(毫秒)(覆盖core.animation的设置),若为false则禁用动画效果触发事件close_node.jstree after_close.jstree

1.87. close_node.jstree ( Event ⚡ )

1.88. after_close.jstree ( Event ⚡ )

1.89. toggle_node (obj)

1.90. open_all ([obj, animation, original_obj])

参数/触发描述objmixed 需递归打开的节点,若忽略则打开整棵树的所有节点animationNumber 打开节点时动画的过渡时间(毫秒),默认禁用动画效果referencejQuery 开始处理的节点(内部使用)触发事件open_all.jstree

1.91. open_all.jstree ( Event ⚡ )

1.92. close_all ([obj, animation])

参数/触发描述objmixed 需递归关闭的节点,若忽略则关闭整棵树的所有节点animationNumber 打开节点时动画的过渡时间(毫秒),默认禁用动画效果触发事件close_all.jstree

1.93. close_all.jstree ( Event ⚡ )

1.94. is_disabled (obj)

参数/返回描述objmixed返回Boolean

1.95. enable_node (obj)

参数/触发描述objmixed 需启用的节点触发事件enable_node.jstree

1.96. enable_node.jstree ( Event ⚡ )

1.97. disable_node (obj)

参数/触发描述objmixed 需禁用的节点触发事件disable_node.jstree

1.98. disable_node.jstree ( Event ⚡ )

1.99. is_hidden (obj)

参数/返回描述objmixed 节点返回Boolean

1.100. hide_node (obj)

参数/触发描述objmixed 需隐藏的节点skip_redrawBoolean 是否需要重绘,内部参数触发事件hide_node.jstree

1.101. hide_node.jstree ( Event ⚡ )

1.102. show_node (obj)

参数/触发描述objmixed 需显示的节点skip_redrawBoolean 是否需要重绘,内部参数触发事件show_node.jstree

1.103. show_node.jstree ( Event ⚡ )

1.104. hide_all ()

触发描述触发事件hide_node.jstree

1.105. hide_all.jstree ( Event ⚡ )

参数描述nodesArray 所有被隐藏节点的 ID 集合

1.106. show_all ()

触发描述触发事件show_all.jstree

1.107. show_all.jstree ( Event ⚡ )

参数描述nodesArray 所有被显示节点的 ID 集合

1.108. activate_node (obj, e) - - private

参数/触发描述objmixed 节点eObject 相关的事件触发事件activate_node.jstree changed.jstree

1.109. activate_node.jstree ( Event ⚡ )

参数描述nodesObjecteventObject 触发调用的原始事件(也可能是一个空对象)

1.110. hover_node (obj) - - private

参数/触发描述objmixed触发事件hover_node.jstree

1.111. hover_node.jstree ( Event ⚡ )

1.112. dehover_node (obj) - - private

参数/触发描述objmixed触发事件dehover_node.jstree

1.113. dehover_node.jstree ( Event ⚡ )

1.114. select_node (obj [, supress_event, prevent_open])

参数/触发描述objmixed 需选中的节点数组supress_eventBoolean 若为true,将不触发changed.jstree事件prevent_openBoolean 若为true,将不打开选中节点的父节点触发事件select_node.jstree changed.jstree

1.115. select_node.jstree ( Event ⚡ )

参数描述nodesObjectselectedArray 已选中的节点eventObject 触发本事件select_node的事件

1.116. changed.jstree ( Event ⚡ )

参数描述nodesObjectactionObject 引起选择发生变化的actionselectedArray 当前的已选中的节点eventObject 触发本事件changed_node的事件

1.117. deselect_node (obj [, supress_event])

参数/触发描述objmixed 若为一个数组,则是需被不选中的节点列表supress_eventBoolean 若为true,将不触发changed.jstree事件触发事件deselect_node.jstree changed.jstree

1.118. deselect_node.jstree ( Event ⚡ )

参数描述nodesObjectselectedArray 当前的已选中的节点eventObject 触发本事件deselect_node的事件

1.119. select_all ([supress_event])

1.120. select_all.jstree ( Event ⚡ )

参数描述selectedArray 当前的已选中的节点

1.121. deselect_all ([supress_event])

参数/触发描述supress_eventBoolean 若为true,将不触发changed.jstree事件触发事件deselect_all.jstree changed.jstree

1.122. deselect_all.jstree ( Event ⚡ )

参数描述nodesObject 之前的选中节点selectedArray 当前的已选中的节点

1.123. is_selected (obj)

参数/返回描述objmixed返回Boolean

1.124. get_selected ([full])

参数/返回描述fullmixed 若为true则返回节点对象全部数据,否则只返回节点 ID 列表返回Array

1.125. get_top_selected ([full])

参数/返回描述fullmixed 若为true则返回节点对象全部数据,否则只返回节点 ID 列表返回Array

1.126. get_bottom_selected ([full])

参数/返回描述fullmixed 若为true则返回节点对象全部数据,否则只返回节点 ID 列表返回Array

1.127. get_state () - - private

1.128. set_state (state [, callback]) - - private

参数/触发描述stateObject 要设置的状态。此对象是传引用,且 jstree 不会修改此对象callbackFunction 可选,设置状态完毕后的回调函数触发事件set_state.jstree

1.129. set_state.jstree ( Event ⚡ )

1.130. refresh ()

参数/触发描述skip_loadingBoolean 是否跳过加载动画forget_stateMixed 若为true则将不可恢复原来的状态,若为一个函数(此函数将接收一个状态参数)则此函数的结果将作为状态触发事件refresh.jstree

1.131. refresh.jstree ( Event ⚡ )

1.132. refresh_node (obj)

参数/触发描述objMixed 节点触发事件refresh_node.jstree

1.133. refresh_node.jstree ( Event ⚡ )

参数描述nodeObject 已刷新的节点nodesArray 已重新加载的节点 ID 列表

1.134. set_id (obj, id)

参数/返回/触发描述objmixed 节点idString 新 ID返回Boolean触发事件set_id.jstree

1.135. set_id.jstree ( Event ⚡ )

参数描述nodeObjectoldString 旧 ID

1.136. get_text (obj)

参数/返回描述objmixed 节点返回String

1.137. set_text (obj, val) - - private

参数/返回/触发描述objmixed 单个节点,或,多个节点组成的数组valString 新名称返回Boolean触发事件set_text.jstree

1.138. set_text.jstree ( Event ⚡ )

参数描述objObjecttextString 新名称

1.139. get_json ([obj, options])

参数/返回描述objmixedoptionsObjectoptions.no_stateBoolean 不包含状态options.no_idBoolean 不包含 IDoptions.no_childrenBoolean 不包含子节点options.no_dataBoolean 不包含节点数据(node data)options.no_li_attrBoolean 不包含LI元素的属性attributesoptions.no_a_attrBoolean 不包含A元素的属性attributesoptions.flatBoolean 返回扁平 JSON 数据,而不是嵌套数据返回Object

1.140. create_node ([par, node, pos, callback, is_loaded])

参数/返回/触发描述parmixed 父节点(若是创建根节点请用#或null)nodemixed 新节点的数据(JSON 对象,或节点名字符串)posmixed 插入节点的位置(index),支持first和last,默认是lastcallbackFunction 节点创建完毕后的毁回调函数is_loadedBoolean 内部参数,用于检测父节点是否已成功加载返回String 新建节点的 ID触发事件model.jstree create_node.jstree

1.141. create_node.jstree ( Event ⚡ )

1.142. rename_node (obj, val)

参数/返回/触发描述objmixed 节点,也可是一个数组,里面的节点将重命名为相同的名字valString 新名称返回Boolean触发事件rename_node.jstree

1.143. rename_node.jstree ( Event ⚡ )

1.144. delete_node (obj)

参数/返回/触发描述objmixed 节点,也可是一个数组,将同时删除多个返回Boolean触发事件delete_node.jstree changed.jstree

1.145. delete_node.jstree ( Event ⚡ )

1.146. check (chk, obj, par, pos) - - private

参数/返回描述chkString 操作名,可以是create_node rename_node delete_node copy_node move_nodeobjmixed 节点parmixed 父节点posmixed 插入的位置,或rename_node时的新名称moremixed 各种附加信息,如 DND 插件触发 move_node 操作时,此值就是鼠标经过的节点返回Boolean

1.147. last_error ()

1.148. move_node (obj, par [, pos, callback, is_loaded])

参数/触发描述objmixed 需移动的节点(也可以是一个节点数组)parmixed 新的父节点posmixed 插入节点的位置(除了整数值,还支持first last before after)默认是整数0callbackFunction 节点移动完毕后的毁回调函数,接收 3 个参数:节点、新父节点、位置is_loadedBoolean 内部参数,用于检测父节点是否已成功加载skip_redrawmixed 内部参数,是否重画整棵树instancemixed 内部参数,检测节点是否来自另一个树实例触发事件move_node.jstree

1.149. move_node.jstree ( Event ⚡ )

1.150. copy_node (obj, par [, pos, callback, is_loaded])

参数/触发描述objmixed 需复制的节点(也可以是一个节点数组)parmixed 新的父节点posmixed 插入节点的位置(除了整数值,还支持first last before after)默认是整数0callbackFunction 节点复制完毕后的毁回调函数,接收 3 个参数:节点、新父节点、位置is_loadedBoolean 内部参数,用于检测父节点是否已成功加载skip_redrawmixed 内部参数,是否重画整棵树instancemixed 内部参数,检测节点是否来自另一个树实例触发事件model.jstree copy_node.jstree

1.151. copy_node.jstree ( Event ⚡ )

1.152. cut (obj)

参数/触发描述objmixed 需剪切的节点(也可以是一个节点数组)触发事件cut.jstree

1.153. cut.jstree ( Event ⚡ )

1.154. copy (obj)

参数/触发描述objmixed 需复制的节点(也可以是一个节点数组)触发事件copy.jstree

1.155. copy.jstree ( Event ⚡ )

1.156. get_buffer ()

返回描述返回Object 一个对象,包含:状态mode(copy_node或move_node)、节点node(节点数组)、实例instance(树实例)

1.157. can_paste ()

1.158. paste (obj [, pos])

参数/触发描述objmixed 新父节点posmixed 插入的位置(除了整数,也支持first last),默认值0触发事件paste.jstree

1.159. paste.jstree ( Event ⚡ )

参数描述parentString 接收粘贴节点的 IDnodeArray 缓存中的节点列表modeString 执行的操作,copu_node或move_node

1.160. clear_buffer ()

触发描述触发事件clear_buffer.jstree

1.161. clear_buffer.jstree ( Event ⚡ )

1.162. edit (obj [, default_text, callback])

参数描述objmixeddefault_textString 默认名称(若不填,或填一个空字符串,则默认为节点目前的名称)callbackFunction 离开编辑框时将执行的回调函数,执行环境是实例内,将接收 3 个参数:节点、状态(true则重命名成功,否则失败)、Boolean值(用户是否可取消编辑)。可通过.text获取节点名

1.163. set_theme (theme_name [, theme_url])

参数/触发描述theme_nameString 主题名theme_urlmixed 主题的 CSS 文件的 URL,若不填或false,则你需手动加载该文件,若true则将尝试自动从core.theme.dir目录中加载触发事件set_theme.jstree

1.164. set_theme.jstree ( Event ⚡ )

1.165. get_theme ()

1.166. set_theme_variant (variant_name)

参数描述variant_nameString Boolean 主题的变体(若false,则移除当前的变体)

1.167. show_stripes ()

1.168. show_stripes.jstree ( Event ⚡ )

1.169. hide_stripes ()

1.170. hide_stripes.jstree ( Event ⚡ )

1.171. toggle_stripes ()

1.172. show_dots ()

1.173. show_dots.jstree ( Event ⚡ )

1.174. hide_dots ()

1.175. hide_dots.jstree ( Event ⚡ )

1.176. toggle_dots ()

1.177. show_icons ()

1.178. show_icons.jstree ( Event ⚡ )

1.179. hide_icons ()

1.180. hide_icons.jstree ( Event ⚡ )

1.181. toggle_icons ()

1.182. show_ellipsis ()

1.183. show_ellipsis.jstree ( Event ⚡ )

1.184. hide_ellipsis ()

1.185. hide_ellipsis.jstree ( Event ⚡ )

1.186. set_icon (obj, icon)

参数描述objmixediconString 新的图标名,可以是一个图标的文件路径,或 CSS 的 class 名。若使用图标文件路径,则应使用当前目录作为前缀./,否则都认为是 CSS 类名

1.187. get_icon (obj)

参数/返回描述objmixed返回String

1.188. hide_icon (obj)

1.189. show_icon (obj)

本文由 黑白世界4648 第一时间收藏到GET,原文来自 → www.cnblogs.com

「GetParty」

关注微信号,推送好文章

微信中长按图片即可关注

更多精选文章

评论
微博一键登入