zTree 官網已經有完整的 API 文件,一切以官方說明為準。這裡結合實務經驗,整理幾個最常調到、也最容易搞錯的設定。zTree 的設定採 key-value 物件形式,結構清楚,只要摸熟了就很順手。
async: {
enable: true,
url: 'abc.ashx',
otherParam: { "request": "requestname" }
}
各欄位意義:
enable:是否開啟異步載入模式。url:以 AJAX 抓取資料的位址。otherParam:AJAX 請求附帶的靜態參數鍵值對,等同 jQuery 裡的 data。通常會先定義資料結構(model),其中要包含層級關係,一般至少需要 ID、父 ID 與名稱三個欄位。接著有兩種設定方式:
data: {
simpleData: {
enable: true
}
}
或者指定欄位名稱:
data: {
key: {
children: "childrens",
checked: "IsChecked"
}
}
說明:
simpleData:使用扁平陣列作為資料源綁定,此時異步載入的資料可以是平行結構,由 zTree 依父子 ID 自行組出樹狀。children:指定節點中存放子節點的屬性名稱,此時資料本身就是樹的摺疊結構,後端產生資料時必須使用遞迴。兩者的差別在於「誰來組樹」:扁平結構把組樹責任交給前端,遞迴結構則由後端負責。可依後端能力挑一種。
check: {
enable: true,
chkStyle: "checkbox",
radioType: "all",
chkboxType: { "Y": "", "N": "" }
},
data: {
key: {
checked: "IsChecked"
}
}
說明:
enable:節點上是否顯示 checkbox 或 radio。chkStyle:勾選框類型,checkbox 或 radio。radioType:radio 的分組範圍(all 表示全樹共用一組)。chkboxType:勾選時父子節點的連動關係設定。checked:資料載入後是否預先勾選,IsChecked 對應後端 model 的欄位名稱。與其用 zTree 內建的編輯功能,實務上更常見的是自己畫按鈕。設定入口是 view:
view: {
addHoverDom: addHoverDom,
removeHoverDom: removeHoverDom
}
其中 addHoverDom 負責在滑鼠移入節點時插入自訂元素:
function addHoverDom(treeId, treeNode) {
var sObj = $("#" + treeNode.tId + "_span");
if ($("#addBtn_" + treeNode.id).length > 0) return;
var str = "<a id='addBtn_" + treeNode.id + "' onclick='自定義函數1(" + treeNode.DepartmentID + ")'>添加子節點</a>";
str += "<a id='addBtn1_" + treeNode.id + "' onclick='自定義函數2(" + treeNode.DepartmentID + ")'>編輯節點</a>";
str += "<a id='addBtn2_" + treeNode.id + "' onclick='自定義函數3(" + treeNode.DepartmentID + ")'>刪除節點</a>";
sObj.after(str);
}
removeHoverDom 則在滑鼠移出時清掉它們:
function removeHoverDom(treeId, treeNode) {
$("#addBtn_" + treeNode.id).unbind().remove();
$("#addBtn1_" + treeNode.id).unbind().remove();
$("#addBtn2_" + treeNode.id).unbind().remove();
}
兩個函式的職責很明確:一個負責在節點滑入時顯示自訂控制項,一個負責滑出時隱藏,顯示與隱藏的時機跟 zTree 內建的編輯、刪除按鈕完全一致。
實作時有兩點值得注意:開頭那個 if (...length > 0) return; 是為了避免重複插入;另外,用 onclick 內嵌字串拼參數的做法在參數含引號或特殊字元時容易出錯,改用事件委派(在容器上綁一次 click,再從 e.target 反查 treeNode)會穩健許多。