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 參數包含兩個特性: |