概述
本 Demo 展示了如何将集算表作为数据区域嵌入到工作表中,构建一个产品数据仪表板。Demo 创建了一个包含产品信息的集算表,通过数据管理器连接远程 API 获取数据,然后将集算表注册为工作表中的数据区域,并添加数据图表进行可视化展示。
实现思路
创建集算表和数据管理器,配置远程数据源(产品、供应商、类别三张表)
设置表关系,建立产品表与供应商表、类别表的关联
创建数据视图,定义列信息和样式,包括条件格式
将集算表注册为工作表中的数据区域,指定起始位置
在工作表中添加数据图表,基于集算表数据进行可视化
自动调整行高列宽,美化工作表显示
代码解析
初始化集算表和数据管理器
这段代码创建了一个集算表实例,并通过数据管理器连接到远程 API。autoSync: true 确保数据变更自动同步到服务器。
设置表关系和计算列
通过 addRelationship 方法建立表之间的关联,使得产品表可以通过 supplier.CompanyName 和 category.CategoryName 访问关联数据。计算列 TotalPrice 使用结构化公式计算总价。
创建数据视图并应用样式
addView 方法定义了视图的列信息,包括字段映射、标题、宽度和样式。conditionalFormats 属性为总价列添加条件格式,当值大于 1000 时显示为橙色。
将集算表注册为数据区域
sheet.dataRanges.add() 方法将集算表注册为工作表中的数据区域。参数 -1, -1 表示数据区域的大小自动适应集算表的数据量。集算表和数据区域共享同一个实例,修改任意一方都会同步到另一方。
添加数据图表
dataCharts.add() 方法在工作表的指定位置创建数据图表,通过 setChartConfig() 配置图表的数据源和显示样式。
运行效果
工作表顶部显示标题 "Product Dashboard"
工作表中间部分显示两个数据图表(柱状图和饼图),基于集算表数据进行可视化
工作表下方显示集算表数据区域,包含产品名称、数量、供应商、类别、单价、库存和总价等信息
总价列应用了条件格式,大于 1000 的值显示为橙色
数据区域的行高和列宽已自动调整,提供最佳的显示效果
用户可以在数据区域中进行排序、筛选等操作,与独立的集算表功能完全一致
API 参考
dataRanges.add() 方法
name:数据区域的唯一名称
tableSheetName:集算表的名称
range:数据区域在工作表中的位置,使用 new GC.Spread.Sheets.Range(row, col, -1, -1) 表示自动大小
options:可选配置项,如 { sticky: { top: 1 } } 设置粘性表头
dataCharts.add() 方法
name:数据图表的名称
x、y:图表在工作表中的位置(像素坐标)
width、height:图表的宽度和高度
type:图表类型,如 GC.Spread.Sheets.DataCharts.DataChartType.column
/*REPLACE_MARKER*/
/*DO NOT DELETE THESE COMMENTS*/
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 1 });
initSpread(spread);
};
function initSpread(spread) {
spread.suspendPaint();
var sheet = spread.getActiveSheet();
initTableSheet(spread, function(tableSheet) {
spread.setActiveSheet(sheet.name());
setDashboard(sheet);
var dataRange = registerTableSheetIntoWorksheet(tableSheet, sheet);
beautifySheet(sheet, dataRange);
addDataCharts(sheet);
spread.undoManager().clear();
});
spread.resumePaint();
}
function setDashboard(sheet) {
sheet.getCell(1, 1)
.value("Product Dashboard")
.font("20px Calibri")
.fontWeight("bold");
sheet.setRowHeight(1, 30);
sheet.addSpan(1, 1, 1, 9);
sheet.addSpan(16, 1, 1, 9);
}
async function initTableSheet(spread, callback) {
spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader;
//init a data manager
var dataManager = spread.dataManager();
var categoryAPI = getBaseApiUrl() + "/Category";
var categoryTable = dataManager.addTable("categoryTable", {
remote: {
read: { url: categoryAPI }
}
});
var supplierAPI = getBaseApiUrl() + "/Supplier";
var supplierTable = dataManager.addTable("supplierTable", {
remote: {
read: { url: supplierAPI }
}
});
var productAPI = getBaseApiUrl() + "/Product";
var productTable = dataManager.addTable("productTable", {
autoSync: true,
remote: {
read: { url: productAPI },
update: { url: productAPI, method: "PUT" },
create: { url: productAPI },
delete: { url: productAPI }
},
schema: {
columns: {
CategoryId: {
lookup: {
name: "category",
columns: [
{ value: "Id", width: 100 },
{ value: "CategoryName", width: 160 },
{ value: "Description", width: 400 }
]
}
},
SupplierId: {
lookup: {
name: "supplier",
columns: [
{ value: "Id", width: 100 },
{ value: "CompanyName", width: 180 },
{ value: "ContactName", width: 140 },
{ value: "ContactTitle", width: 140 },
{ value: "ContactTitle", width: 140 },
{ value: "City", width: 100 },
{ value: "Address", width: 140 },
{ value: "Phone", width: 100 }
]
}
},
TotalPrice: {
caption: "Total Price",
dataType: "formula",
value: "=[@UnitPrice]*[@UnitsInStock]"
}
}
}
});
dataManager.addRelationship(productTable, "CategoryId", "category", categoryTable, "Id", "product");
dataManager.addRelationship(productTable, "SupplierId", "supplier", supplierTable, "Id", "product");
//init a table sheet
var tableSheet = spread.addSheetTab(0, "MyTableSheet", GC.Spread.Sheets.SheetType.tableSheet);
tableSheet.applyTableTheme(GC.Spread.Sheets.Tables.TableThemes.professional15);
tableSheet.rowActionOptions([]);
//bind a view to the table sheet
await categoryTable.fetch();
await supplierTable.fetch();
await productTable.fetch();
var nameStyle = {
fontWeight: "bold"
};
var relationStyle = {
foreColor: "#818181"
};
var formulaRule = {
ruleType: "formulaRule",
formula: "@>1000",
style: {
foreColor: "orange"
}
};
var myView = productTable.addView("myView", [
{ value: "ProductName", caption: "Name", width: 250, style: nameStyle },
{ value: "QuantityPerUnit", caption: "Quantity Per Unit", width: 140 },
{ value: "SupplierId", caption: "Supplier Id", width: 140 },
{ value: "supplier.CompanyName", caption: "Supplier Company", width: 200, style: relationStyle, headerStyle: relationStyle },
{ value: "CategoryId", caption: "Category Id", width: 140 },
{ value: "category.CategoryName", caption: "Category Name", width: 140, style: relationStyle, headerStyle: relationStyle },
{ value: "UnitPrice", caption: "Unit Price", width: 140 },
{ value: "UnitsInStock", caption: "Units In Stock", width: 140 },
{ value: "TotalPrice", caption: "Total Price", conditionalFormats: [formulaRule] }
]);
tableSheet.setDataView(myView);
spread.suspendPaint();
callback && callback(tableSheet);
spread.resumePaint();
return tableSheet;
}
function registerTableSheetIntoWorksheet (tableSheet, sheet) {
var name = tableSheet.name() + "_DataRange";
var row = 17;
var col = 1;
var dataRange = sheet.dataRanges.add(name, tableSheet.name(), new GC.Spread.Sheets.Range(row, col, -1, -1));
return dataRange;
}
function addDataCharts (sheet) {
var columnChart = sheet.dataCharts.add("columnChart", 62, 50, 694, 281, GC.Spread.Sheets.DataCharts.DataChartType.column);
columnChart.setChartConfig(columnChartConfig);
var pieChart = sheet.dataCharts.add("pieChart", 762, 50, 360, 281, GC.Spread.Sheets.DataCharts.DataChartType.pie);
pieChart.setChartConfig(pieChartConfig);
}
function beautifySheet(sheet, dataRange) {
var range = dataRange.range();
for (var i = range.row; i < range.row + range.rowCount; i++) {
sheet.autoFitRow(i);
}
for (var i = range.col; i < range.col + range.colCount; i++) {
sheet.autoFitColumn(i);
}
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/SpreadJSTutorial\//)[0] + 'server/api';
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta name="spreadjs culture" content="zh-cn"/>
<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">
<!-- Promise Polyfill for IE, https://www.npmjs.com/package/promise-polyfill -->
<script src="https://cdn.jsdelivr.net/npm/promise-polyfill@8/dist/polyfill.min.js"></script>
<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-tablesheet/dist/gc.spread.sheets.tablesheet.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-shapes/dist/gc.spread.sheets.shapes.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-datacharts-addon/dist/gc.spread.sheets.datacharts.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="../columnChartConfig.js" type="text/javascript"></script>
<script src="../pieChartConfig.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 id="ss"></div>
</html>
body, html {
width: 100%;
height: 100%;
position: relative;
overflow: hidden;
margin: 0;
padding: 0;
}
#ss {
width: 100%;
height: 100%;
}