当前位置: 首页 > 文档资料 > jsTree 中文文档 >

复选框插件

优质
小牛编辑
126浏览
2023-12-01

该插件在每个节点的前面呈现复选框图标,使多项选择变得更加容易。
它还支持三态行为,这意味着如果节点上有几个子节点处于选中状态,它将被呈现为不确定状态,并且状态将向上传播。

$.jstree.defaults.checkboxcheckbox plugin

存储复选框插件的所有默认值

$.jstree.defaults.checkbox.visiblecheckbox plugin

指示复选框是否可见的布尔值(可以稍​​后使用 show_checkboxes()hide_checkboxes)默认为 true.

$.jstree.defaults.checkbox.three_statecheckbox plugin

一个布尔值,指示复选框是否应该向下层叠并具有不确定的状态。默认为 true.

$.jstree.defaults.checkbox.whole_nodecheckbox plugin

一个布尔值,指示是否单击节点上的任何位置都应相当于单击复选框。默认为 true.

$.jstree.defaults.checkbox.keep_selected_stylecheckbox plugin

一个布尔值,指示是否应保留或删除选定的节点样式。默认为true.

$.jstree.defaults.checkbox.cascadecheckbox plugin

此设置控制如何应用级联和不确定的节点。
如果字符串中包含“ up”-启用了层叠,如果字符串中包含“ down”-启用了层叠,如果字符串中包含“ undefined”,则将使用未确定的节点。
如果three_state 设置为true此设置会自动设置为'up+down+undetermined'. 默认为 ''.

$.jstree.defaults.checkbox.tie_selectioncheckbox plugin

此设置控制复选框是否绑定到常规树选择或复选框插件维护的内部数组。默认值为 true,仅 false 在您确切知道自己在做什么时才设置为。

$.jstree.defaults.checkbox.cascade_to_disabledcheckbox plugin

此设置控制级联是否影响禁用的复选框

$.jstree.defaults.checkbox.cascade_to_hiddencheckbox plugin

此设置控制级联是否影响隐藏的复选框

get_undetermined ([full])checkbox plugin

获取状态为“不确定”的所有节点的数组;

  • full:boolean如果设置为true返回的数组将由完整的节点对象组成,否则-仅返回ID
  • ReturnsArray

_undetermined ()checkbox plugin private

在需要的地方设置不确定的状态。内部使用。

show_checkboxes ()checkbox plugin

显示节点复选框图标

hide_checkboxes ()checkbox plugin

隐藏节点复选框图标

toggle_checkboxes ()checkbox plugin

切换节点图标

is_undetermined (obj)

检查节点是否处于不确定状态

  • objmixed
  • ReturnsBoolean

disable_checkbox (obj)checkbox plugin

禁用节点的复选框

  • objmixed数组也可以使用
  • Triggersdisable_checkbox.jstree

disable_checkbox.jstree Eventcheckbox plugin

禁用节点的复选框时触发

  • nodeObject

enable_checkbox (obj)checkbox plugin

启用节点的复选框

  • objmixed数组也可以使用
  • Triggersenable_checkbox.jstree

enable_checkbox.jstree Eventcheckbox plugin

启用节点的复选框时触发

  • nodeObject

级联检查节点及其所有后代的状态。此功能不影响隐藏和禁用的节点(或其后代)。
但是,如果已经选择了这些不受影响的节点,则其ID将包含在返回的数组中。

  • idstring节点ID
  • checkedStatebool是否应检查节点

get_checked_descendants (obj)checkbox plugin

获取在由id指定的(树的)分支中选择的节点的id(不包括由id指定的节点)

  • idstring节点ID
  • ReturnsArrayID数组

check_node (obj)checkbox plugin

检查节点(仅当复选框设置中的tie_selection为false时,否则将在内部调用select_node)

  • objmixed数组可用于检查多个节点
  • Triggerscheck_node.jstree

check_node.jstree Eventcheckbox plugin

在检查节点时触发(仅当复选框设置中的tie_selection为false时)

  • nodeObject
  • selectedArray当前选择
  • eventObject触发此check_node的事件(如果有)

uncheck_node (obj)checkbox plugin

取消选中节点(仅当复选框设置中的tie_selection为false时,否则内部将调用deselect_node)

  • objmixed数组可用于取消选中多个节点
  • Triggersuncheck_node.jstree

uncheck_node.jstree Eventcheckbox plugin

取消选中节点时触发(仅当复选框设置中的tie_selection为false时)

  • nodeObject
  • selectedArray当前选择
  • eventObject触发此uncheck_node的事件(如果有)

check_all ()checkbox plugin

检查树中的所有节点(仅当复选框设置中的tie_selection为false时,否则将在内部调用select_all)

  • Triggerscheck_all.jstree changed.jstree

check_all.jstree Eventcheckbox plugin

tr选中所有节点时触发(仅当复选框设置中的tie_selection为false时)

  • selectedArray当前选择

uncheck_all ()checkbox plugin

取消选中所有选中的节点(仅当复选框设置中的tie_selection为false时,否则将在内部调用deselect_all)

  • Triggersuncheck_all.jstree

uncheck_all.jstree Eventcheckbox plugin

取消选中所有节点时触发(仅当复选框设置中的tie_selection为false时)

  • nodeObject先前的选择
  • selectedArray当前选择

is_checked (obj)checkbox plugin

检查是否检查了节点(如果tie_selection在设置中为开,此函数将返回与is_selected相同的结果)

  • objmixed
  • ReturnsBoolean

get_checked ([full])checkbox plugin

获取所有已检查节点的数组(如果在设置中启用tie_selection,则此函数将返回与get_selected相同的结果)

  • fullmixed如果设置为true返回的数组将由完整的节点对象组成,否则-仅返回ID
  • ReturnsArray

get_top_checked ([full])checkbox plugin

获取所有顶级检查节点的数组(忽略检查节点的子节点)(如果tie_selection在设置中处于启用状态,则此函数将返回与get_top_selected相同的结果)

  • fullmixed如果设置为true返回的数组将由完整的节点对象组成,否则-仅返回ID
  • ReturnsArray

get_bottom_checked ([full])checkbox plugin

获取所有底层检查节点的数组(忽略选定的父级)(如果在设置中启用tie_selection,则此函数将返回与get_bottom_selected相同的结果)

  • fullmixed如果设置为true返回的数组将由完整的节点对象组成,否则-仅返回ID
  • ReturnsArray