TreeGrid 树形表格
扩展自 $.fn.datagrid.defaults,用 $.fn.treegrid.defaults 重写了 defaults。
依赖
- datagrid
用法
1. <table id="tt"></table>
1. $('#tt').treegrid({
2. url:'treegrid_data.json',
3. treeField:'name',
4. columns:[[
5. {title:'Task Name',field:'name',width:180},
6. {field:'persons',title:'Persons',width:60,align:'right'},
7. {field:'begin',title:'Begin Date',width:80},
8. {field:'end',title:'End Date',width:80}
9. ]]
10. });
特性
其特性扩展自 datagrid,下列是为 treegrid 增加的特性。
名称 |
类型 |
说明 |
默认值 |
treeField |
string |
定义树节点的字段。 |
null |
animate |
boolean |
定义当节点展开或折叠时是否显示动画效果。 |
false |
事件
其事件扩展自 datagrid,下列是为 treegrid 增加的事件。
名称 |
参数 |
说明 |
onClickRow |
row |
当用户点击一个节点时触发。 |
onDblClickRow |
row |
当用户双击一个节点时触发。 |
onBeforeLoad |
row, param |
发出一个加载数据的请求前触发,返回 false 就取消加载动作。 |
onLoadSuccess |
row, data |
当数据加载成功时触发。 |
onLoadError |
arguments |
当数据加载失败时触发, arguments 参数和 jQuery.ajax 的 'error' 方法一样。 |
onBeforeExpand |
row |
节点展开前触发,返回 false 就取消展开动作。 |
onExpand |
row |
当节点展开时触发。 |
onBeforeCollapse |
row |
节点折叠前触发,返回 false 就取消折叠动作。 |
onCollapse |
row |
当节点折叠时触发。 |
onContextMenu |
e, row |
当右键点击节点时触发。 |
onBeforeEdit |
row |
当用户开始编辑节点时触发。 |
onAfterEdit |
row,changes |
当用户完成编辑时触发。 |
onCancelEdit |
row |
当用户取消编辑节点时触发。 |
方法
名称 |
参数 |
说明 |
options |
none |
返回 treegrid 的options 。 |
resize |
options |
设置 treegrid 的尺寸, options 参数包含两个特性: |
fixRowHeight |
id |
适应指定行的高度。 |
loadData |
data |
加载 treegrid 的数据。 |
reload |
id |
重新加载 treegrid 的数据。 |
reloadFooter |
footer |
重新加载脚部数据。 |
getData |
none |
获取加载的数据。 |
getFooterRows |
none |
获取脚部数据。 |
getRoot |
none |
获取根节点,返回节点对象。 |
getRoots |
none |
获取根节点们,返回节点数据。 |
getParent |
id |
获取父节点。 |
getChildren |
id |
获取子节点们。 |
getSelected |
none |
获取选中的节点并返回它,如果没有选中节点就返回 null。 |
getSelections |
none |
获取所有的选中节点们。 |
getLevel |
id |
获取指定节点的层级。 |
find |
id |
找到指定节点并返回此节点数据。 |
select |
id |
选择节点。 |
unselect |
id |
取消选择节点。 |
selectAll |
none |
选择全部节点。 |
unselectAll |
none |
取消选择全部节点。 |
collapse |
id |
折叠节点。 |
expand |
id |
展开节点。 |
collapseAll |
id |
折叠全部节点。 |
expandAll |
id |
展开全部节点。 |
expandTo |
id |
从根部展开一个指定的节点。 |
toggle |
id |
切换节点的展开/折叠状态。 |
append |
param |
追加节点们到父节点。 param 参数包含下列特性: |
remove |
id |
移除节点和它的子节点们。 |
refresh |
id |
刷新指定的节点。 |
beginEdit |
id |
开始编辑节点。 |
endEdit |
id |
结束编辑节点。 |
cancelEdit |
id |
取消编辑节点。 |
getEditors |
id |
获取指定行的编辑器们。每个编辑器有下列特性: |
getEditor |
options |
获取指定的编辑器, options 参数包含两个特性: |