The options in the data source schema are as follows:
There are 4 types of data in the hierarchy: Parent, Level, ChildrenPath, Custom.
Each of them can be configured when adding a Table to data manager:
Configure the parent hierarchy type:
Configure the level hierarchy type:
Configure the children path hierarchy type:
Configure the custom hierarchy type:
There are some operations to update the hierarchy records in the TableSheet:
Promote a record:
Demote a record:
Move up:
Move down:
Add a new row data before the specified row:
Add a new row data after the specified row:
Add a new row data as the parent of the specified row:
Add a new row data as the child of the specified row:
Expand the all hierarchy levels:
Collapse the all hierarchy levels:
Expand the hierarchy data by specified level:
There are some options to toggle the visibility of the menu items for the hierarchical records in the TableSheet options:
To show the hierarchy menu items in the TableSheet:
import * as React from 'react';
import { createRoot } from 'react-dom/client';
import './styles.css';
import { AppFunc } from './app-func';
import { App } from './app-class';
// 1. Functional Component sample
createRoot(document.getElementById('app')).render(<AppFunc />);
// 2. Class Component sample
// createRoot(document.getElementById('app')).render(<App />);
/*REPLACE_MARKER*/
/*DO NOT DELETE THESE COMMENTS*/
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import "@mescius/spread-sheets-tablesheet";
import { SpreadSheets } from '@mescius/spread-sheets-react';
import './styles.css';
export function AppFunc() {
const 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);
}
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => initSpread(spread)}>
</SpreadSheets>
</div>
</div>
);
}
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 getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api';
}
/*REPLACE_MARKER*/
/*DO NOT DELETE THESE COMMENTS*/
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import "@mescius/spread-sheets-tablesheet";
import { SpreadSheets } from '@mescius/spread-sheets-react';
import './styles.css';
const Component = React.Component;
export class App extends Component {
render() {
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => this.initSpread(spread)}>
</SpreadSheets>
</div>
</div>
);
}
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 getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api';
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/react/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<!-- SystemJS -->
<script src="$DEMOROOT$/en/react/node_modules/systemjs/dist/system.src.js"></script>
<script src="systemjs.config.js"></script>
<script>
System.import('$DEMOROOT$/en/lib/react/license.js').then(function () {
System.import('./src/app');
});
</script>
</head>
<body>
<div id="app" style="height: 100%;"></div>
</body>
</html>
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: 100%;
height: 100%;
overflow: hidden;
float: left;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
(function (global) {
System.config({
transpiler: 'plugin-babel',
babelOptions: {
es2015: true,
react: true
},
meta: {
'*.css': { loader: 'css' }
},
paths: {
// paths serve as alias
'npm:': 'node_modules/'
},
// map tells the System loader where to look for things
map: {
'@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js',
'@mescius/spread-sheets-tablesheet': 'npm:@mescius/spread-sheets-tablesheet/index.js',
'@mescius/spread-sheets-react': 'npm:@mescius/spread-sheets-react/index.js',
'@grapecity/jsob-test-dependency-package/react-components': 'npm:@grapecity/jsob-test-dependency-package/react-components/index.js',
'react': 'npm:react/cjs/react.production.js',
'react-dom': 'npm:react-dom/cjs/react-dom.production.js',
'react-dom/client': 'npm:react-dom/cjs/react-dom-client.production.js',
'scheduler': 'npm:scheduler/cjs/scheduler.production.js',
'css': 'npm:systemjs-plugin-css/css.js',
'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js',
'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js'
},
// packages tells the System loader how to load when no filename and/or no extension
packages: {
src: {
defaultExtension: 'jsx'
},
"node_modules": {
defaultExtension: 'js'
},
}
});
})(this);
