概述
本 Demo 展示了 TableSheet 的层次数据功能，通过四个工作表分别演示了四种层次结构类型的配置方式：父子关系（Parent）、等级层次（Level）、子路径（ChildrenPath）和自定义（Custom）。每种类型都配置了大纲列（outlineColumn）来显示层级结构，并启用了层次操作的菜单项。
实现思路
创建数据管理器，分别添加四个数据表
为每个数据表配置不同的层次结构类型
Parent 类型使用 TaskParentId 列建立父子关系，需要设置主键
Level 类型使用 level 列表示层级，在 hierarchy 配置中设置 outlineColumn
ChildrenPath 类型使用 children 列存储子节点数据
Custom 类型通过 parse 和 unparse 函数自定义层级关系（如 WBS 编号）
为每个工作表启用层次操作菜单项（提升、降低、移动、插入等）
创建视图并设置大纲列样式（图标、展开收起指示器）
代码解析
配置父子层次结构
Parent 类型通过指定父 ID 列来建立层级关系。isPrimaryKey 用于标识唯一记录，dataType: 'rowOrder' 支持记录的上下移动和排序。
配置等级层次结构
Level 类型通过层级数字列来确定父子关系。大纲列配置在 hierarchy 中，可以直接指定显示的列和样式。
配置子路径层次结构
ChildrenPath 类型适合树状结构的 JSON 数据。子节点数据存储在指定的 children 列中，大纲列通过 view 的列配置设置。
配置自定义层次结构
Custom 类型通过 parse 函数解析主键获取父键（如 "1.2.3" → "1.2"），unparse 函数用于创建新记录时生成主键。
启用层次操作菜单项
配置后，用户可以通过右键菜单或列头菜单进行层级操作。
运行效果
切换到不同工作表查看四种层次结构类型的数据展示效果
点击行头的展开/收起图标，展开或折叠子节点
右键点击行头，可以看到提升层级、降低层级、上移、下移、插入同级/子级等菜单项
右键点击列头，可以展开所有层级、收起所有层级、或展开到指定层级
Parent 和 Custom 类型的工作表支持完整的新增、移动操作
每种类型的大纲列都显示了不同级别的图标和缩进
API 参考
hierarchy 配置
type：层次结构类型
column：用于构建层级的关键列
outlineColumn：大纲列配置，可设置图标、展开收起指示器
parse：Custom 类型的解析函数，将主键转换为父键
unparse：Custom 类型的构建函数，生成新的主键
outlineColumn 配置
showImage：是否显示级别图标
images：各级别图标的 URL 数组
expandIndicator：展开指示器图标
collapseIndicator：收起指示器图标
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 0 });
initSpread(spread);
};
function initSpread(spread) {
spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader;
spread.clearSheets();
var dataManager = spread.dataManager();
initHierarchyParentType(spread, dataManager);
initHierarchyLevelType(spread, dataManager);
initHierarchyCustomType(spread, dataManager);
initHierarchyChildrenType(spread, dataManager);
}
function initHierarchyParentType(spread, dataManager) {
var apiUrl = getBaseApiUrl() + "/Hierarchy_Data";
var table = dataManager.addTable("hierarchyParentTable", {
remote: {
read: {
url: apiUrl
}
},
autoSync: true,
schema: {
hierarchy: {
type: 'Parent', // config the parent hierarchy type
column: 'TaskParentId', // specify the column that could be used for building hierarchical view
},
columns: {
'TaskId':{ dataName: 'id', isPrimaryKey: true}, // the primary key is required
'TaskParentId':{ dataName: 'parentId'},
'TaskTitle':{ dataName: 'title'},
'TaskOwner':{ dataName: 'owner'},
'StartDate':{ dataName: 'startDate'},
'DueDate':{ dataName: 'dueDate'},
'TaskComplete':{ dataName: 'complete'},
'TaskOrder':{ dataName: 'rowOrder', dataType: 'rowOrder'}, // if dataType be rowOrder, the records could be moved and added
}
}
});
var sheet = spread.addSheetTab(0, "HierarchyParent", GC.Spread.Sheets.SheetType.tableSheet);
sheet.setDefaultRowHeight(40, GC.Spread.Sheets.SheetArea.colHeader);
sheet.options.allowAddNew = true;
// show the menu items for hierarchical records
sheet.options.menuItemVisibility = {
// the options below be on the row header
promoteMenuItemVisible: true,
demoteMenuItemVisible: true,
// the options below be on the column header
expandAllLevelMenuItemVisible: true,
collapseAllLevelMenuItemVisible: true,
expandToLevelMenuItemVisible: true,
// the options below be on the row header
// and the menu items be enable for the dataType of the column be rowOrder
moveUpMenuItemVisible: true,
moveDownMenuItemVisible: true,
addBeforeMenuItemVisible: true,
addAfterMenuItemVisible: true,
addAboveMenuItemVisible: true,
addBelowMenuItemVisible: true,
};
table.fetch().then(function () {
var myView = table.addView("myView", [
{
value: "TaskTitle", width: 200,
outlineColumn: {
showImage: true,
images: ['$DEMOROOT$/spread/source/images/task-1.png', '$DEMOROOT$/spread/source/images/task-2.png', '$DEMOROOT$/spread/source/images/task-3.png'],
expandIndicator: '$DEMOROOT$/spread/source/images/increaseIndicator.png',
collapseIndicator: '$DEMOROOT$/spread/source/images/decreaseIndicator.png',
}
},
{ value: "TaskOwner", width: 200 },
{ value: "StartDate", width: 200 },
{ value: "DueDate", width: 200 },
{ value: "TaskComplete", width: 200 },
]);
spread.suspendPaint();
sheet.setDataView(myView);
spread.resumePaint();
});
}
function initHierarchyLevelType(spread, dataManager) {
var apiUrl = getBaseApiUrl() + "/Hierarchy_Data/level";
var table = dataManager.addTable("hierarchyLevelTable", {
remote: {
read: {
url: apiUrl
},
create: {
url: apiUrl
},
update: {
url: apiUrl,
method: 'PUT'
},
delete: {
url: apiUrl
},
batch: {
url: apiUrl
}
},
batch: true,
// autoSync: true,
schema: {
hierarchy: {
type: 'Level', // config the level hierarchy type
column: 'level',
outlineColumn: { // the outline column could be set in the hierarchy
value: "TaskTitle",
showImage: true,
images: ['$DEMOROOT$/spread/source/images/task-1.png', '$DEMOROOT$/spread/source/images/task-2.png', '$DEMOROOT$/spread/source/images/task-3.png'],
expandIndicator: '$DEMOROOT$/spread/source/images/increaseIndicator.png',
collapseIndicator: '$DEMOROOT$/spread/source/images/decreaseIndicator.png',
}
},
columns: {
'TaskTitle': { dataName: 'title' },
'TaskOwner': { dataName: 'owner' },
'StartDate': { dataName: 'startDate' },
'DueDate': { dataName: 'dueDate' },
'TaskComplete': { dataName: 'complete' },
}
}
});
var sheet = spread.addSheetTab(1, "HierarchyLevel", GC.Spread.Sheets.SheetType.tableSheet);
sheet.setDefaultRowHeight(40, GC.Spread.Sheets.SheetArea.colHeader);
sheet.options.allowAddNew = true;
sheet.options.menuItemVisibility = {
promoteMenuItemVisible: true,
demoteMenuItemVisible: true,
expandAllLevelMenuItemVisible: true,
collapseAllLevelMenuItemVisible: true,
expandToLevelMenuItemVisible: true,
moveUpMenuItemVisible: true,
moveDownMenuItemVisible: true,
addBeforeMenuItemVisible: true,
addAfterMenuItemVisible: true,
addAboveMenuItemVisible: true,
addBelowMenuItemVisible: true,
};
table.fetch().then(function () {
var myView = table.addView("myView", [
{ value: "TaskTitle", width: 200 },
{ value: "TaskOwner", width: 200 },
{ value: "StartDate", width: 200 },
{ value: "DueDate", width: 200 },
{ value: "TaskComplete", width: 200 },
]);
spread.suspendPaint();
sheet.setDataView(myView);
spread.resumePaint();
});
}
function initHierarchyChildrenType(spread, dataManager) {
var apiUrl = getBaseApiUrl() + "/Hierarchy_Data/children";
var table = dataManager.addTable("hierarchyChildrenTable", {
remote: {
read: {
url: apiUrl
},
create: {
url: apiUrl
},
update: {
url: apiUrl,
method: 'PUT'
},
delete: {
url: apiUrl
},
batch: {
url: apiUrl
}
},
batch: true,
// autoSync: true,
schema: {
hierarchy: {
type: 'ChildrenPath', // config the children path hierarchy type
column: 'children',
},
columns: {
'TaskTitle':{ dataName: 'title'},
'TaskOwner':{ dataName: 'owner'},
'StartDate':{ dataName: 'startDate'},
'DueDate':{ dataName: 'dueDate'},
'TaskComplete':{ dataName: 'complete'},
}
}
});
var sheet = spread.addSheetTab(2, "HierarchyChildren", GC.Spread.Sheets.SheetType.tableSheet);
sheet.setDefaultRowHeight(40, GC.Spread.Sheets.SheetArea.colHeader);
sheet.options.allowAddNew = true;
sheet.options.menuItemVisibility = {
promoteMenuItemVisible: true,
demoteMenuItemVisible: true,
expandAllLevelMenuItemVisible: true,
collapseAllLevelMenuItemVisible: true,
expandToLevelMenuItemVisible: true,
moveUpMenuItemVisible: true,
moveDownMenuItemVisible: true,
addBeforeMenuItemVisible: true,
addAfterMenuItemVisible: true,
addAboveMenuItemVisible: true,
addBelowMenuItemVisible: true,
};
table.fetch().then(function () {
var myView = table.addView("myView", [
{ value: "TaskTitle", width: 200, outlineColumn: true },
{ value: "TaskOwner", width: 200 },
{ value: "StartDate", width: 200 },
{ value: "DueDate", width: 200 },
{ value: "TaskComplete", width: 200 },
]);
spread.suspendPaint();
sheet.setDataView(myView);
spread.resumePaint();
});
}
function initHierarchyCustomType(spread, dataManager) {
var apiUrl = getBaseApiUrl() + "/Hierarchy_Data";
var table = dataManager.addTable("hierarchyCustomTable", {
remote: {
read: {
url: apiUrl
}
},
autoSync: true,
schema: {
hierarchy: {
type: 'Custom', // config the custom hierarchy type
column: 'WBSNumber',
parse: function (options) { // parsing the key to the parent key that be similar as the parent hierarchy type
let segments = options.data.WBSNumber.split('.');
return segments.slice(0, segments.length - 1).join('.');
},
unparse: function (options) { // if the key should be updated, unparse the related data to the key
let parentIds, currentIndex = options.index, parentData = options.parentData, parentKey = parentData && parentData.WBSNumber;
if (parentKey) {
let sp = parentKey.split('.');
parentIds = sp;
} else {
parentIds = [];
}
parentIds.push(currentIndex + 1);
return parentIds.join('.');
}
},
columns: {
'WBSNumber': { dataName: 'wbs', isPrimaryKey: true },
'TaskTitle': { dataName: 'title' },
'TaskOwner': { dataName: 'owner' },
'StartDate': { dataName: 'startDate' },
'DueDate': { dataName: 'dueDate' },
'TaskComplete': { dataName: 'complete' },
}
}
});
var sheet = spread.addSheetTab(3, "HierarchyCustom", GC.Spread.Sheets.SheetType.tableSheet);
sheet.setDefaultRowHeight(40, GC.Spread.Sheets.SheetArea.colHeader);
sheet.options.allowAddNew = true;
sheet.options.menuItemVisibility = {
promoteMenuItemVisible: true,
demoteMenuItemVisible: true,
expandAllLevelMenuItemVisible: true,
collapseAllLevelMenuItemVisible: true,
expandToLevelMenuItemVisible: true,
};
table.fetch().then(function () {
var myView = table.addView("myView", [
{ value: "WBSNumber", width: 200, outlineColumn: true },
{ value: "TaskTitle", width: 200 },
{ value: "TaskOwner", width: 200 },
{ value: "StartDate", width: 200 },
{ value: "DueDate", width: 200 },
{ value: "TaskComplete", width: 200 },
]);
spread.suspendPaint();
sheet.setDataView(myView);
spread.resumePaint();
});
}
function _getElementById(id) {
return document.getElementById(id);
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/SpreadJSTutorial\//)[0] + 'server/api';
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta name="spreadjs culture" content="zh-cn" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css"
href="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/dist/gc.spread.sheets.all.min.js"
type="text/javascript"></script>
<script
src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-resources-zh/dist/gc.spread.sheets.resources.zh.min.js"
type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/js/license.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/data/outlineColumn-wbs.js" type="text/javascript"></script>
<script
src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-tablesheet/dist/gc.spread.sheets.tablesheet.min.js"
type="text/javascript"></script>
<script src="app.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="styles.css">
</head>
<body>
<div class="sample-tutorial">
<div id="ss" class="sample-spreadsheets"></div>
</div>
</body>
</html>
.colorLabel {
background-color: #F4F8EB;
}
.rightAlignLabel {
width: 120px;
text-align: right;
margin-right: 8px;
}
input[type="text"] {
width: 190px;
}
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: 100%;
height: 100%;
overflow: hidden;
float: left;
}
.options-container {
float: right;
width: 280px;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
label {
margin-bottom: 6px;
}
input {
padding: 4px 6px;
}
input[type=button] {
margin-top: 6px;
width: 190px;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
