数据源模式配置

SpreadJS 支持为数据表配置数据源模式,通过 schema 定义数据的结构和属性。开发者可以在 schema 中设置字段名映射(dataName)、数据类型转换(dataType)和值映射(dataMap),从而灵活处理来自不同数据源的数据,实现数据格式化和业务语义的转换。

概述 本 Demo 展示了如何在 TableSheet 中使用数据源模式(schema)来配置数据表的结构和属性。Demo 通过 schema.columns 设置字段名映射、日期类型转换和运输公司的值映射,展示了数据源模式的核心功能。 实现思路 初始化数据管理器(dataManager)并添加数据表 在 addTable 方法中配置 schema,通过 columns 属性定义列的转换规则 使用 dataName 将原始字段名映射为新的字段名(如 Id → OrderId) 使用 dataType 将字符串日期转换为日期类型(OrderDate、RequiredDate、ShippedDate) 使用 dataMap 将数值代码映射为有意义的文本(ShipVia 字段) 创建视图并设置列的显示格式 将视图绑定到 TableSheet 代码解析 配置数据源模式 这段代码通过 schema.columns 配置了列的转换规则: dataName: "Id" 将原始数据源中的 "Id" 字段映射为数据管理器中的 "OrderId" 字段 dataType: "date" 将 JSON 字符串转换为日期类型,便于后续格式化和计算 dataMap 将数值代码(1、2、3)映射为对应的运输公司名称,提升数据的可读性 创建视图并设置格式 创建视图时为列设置了显示格式,其中日期列使用 formatter: 'MM/dd/yyyy' 进行格式化,地址列使用公式模板动态拼接地址信息。 运行效果 表格显示订单数据,其中 OrderId 列对应原始数据的 Id 字段 日期列(OrderDate、ShippedDate)以 MM/dd/yyyy 格式显示,而非原始字符串 ShipVia 列显示运输公司名称(如 "Speedy Express"),而非数值代码 Ship Address 列动态拼接地址和城市信息 API 参考 addTable 方法 name:数据表名称 dataSourceOption:数据源配置,包含 remote(远程数据源)和 schema(数据源模式) schema.columns 配置 dataName:将原始字段名映射为新字段名 dataType:指定数据类型,支持 "string"、"number"、"boolean"、"object"、"array"、"date" dataMap:值映射对象,键为原始值,值为显示值 dataPattern:数据解析模式,如日期格式 "dd/MM/yyyy"
/*REPLACE_MARKER*/ /*DO NOT DELETE THESE COMMENTS*/ window.onload = function() { var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 0 }); initSpread(spread); }; function initSpread(spread) { spread.suspendPaint(); spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader; //init a data manager var tableName = "Order"; var baseApiUrl = getBaseApiUrl(); var apiUrl = baseApiUrl + "/" + tableName; var dataManager = spread.dataManager(); var myTable = dataManager.addTable("myTable", { remote: { read: { url: apiUrl } }, schema: { columns: { OrderId: {dataName: "Id"}, OrderDate: {dataType: "date"}, RequiredDate: {dataType: "date"}, ShippedDate: {dataType: "date"}, ShipVia: {dataMap: {1: "Speedy Express", 2: "United Package", 3: "Federal Shipping"}} } } }); //init a table sheet var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet); sheet.options.allowAddNew = false; //hide new row //bind a view to the table sheet myTable.fetch().then(function() { var style = { formatter: 'MM/dd/yyyy' }; var style2 = { formatter: 'Ship To: {{=CONCAT(@."ShipAddress", ", ", @."ShipCity")}}' }; var view = myTable.addView("myView", [ { value: "OrderId", width: 60 }, { value: "CustomerId",caption:"Customer", width: 100 }, { value: "ShipName", width: 200 }, { value: "OrderDate", width: 120, style: style }, { value: "ShippedDate", width: 120, style: style }, { value: "ShipVia", width: 120 }, { value: "=[@]",caption:"Ship Address",style:style2, width: 350 }, ]); sheet.setDataView(view); }); spread.resumePaint(); } 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"> <!-- 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-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="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 id="optionContainer" class="optionContainer"> </div> </div> </body> </html>
.sample-tutorial { position: relative; height: 100%; overflow: hidden; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; } .sample-spreadsheets { width: 100%; height: 100%; overflow: hidden; float: left; }