SpreadJS 文件格式

SpreadJS允许用户在最短的时间内打开和保存大文件，并以不同的文件格式（如Excel、CSV、SSJSON（旧版SpreadJS格式）和SJS（新版更快的SpreadJS格式））导出或导入。

新的 SJS 格式在处理非常大的 Excel 文件时显著提高了加载时间和内存使用情况，并且与以前的 SpreadJS 版本相比，重新保存时大大减小了文件大小。

为了执行打开、保存、导入和导出等不同格式的文件操作，SpreadJS提供了 gc.spread.sheets.io.xxx.js 插件。

GC.Spread.Sheets.Workbook 类提供了以下方法来进行不同的文件操作。

方法	描述
open	加载 SpreadJS 文件格式
save	保存为 SpreadJS 文件格式
export	导出文件为 Excel,、SSJSON 或 CSV 格式
import	导入格式为 Excel,、SSJSON、CSV 或 JavaScript

在以下部分中，我们将详细了解不同的文件操作。

Open - 打开文件

您可以使用 open 方法在 SpreadJS 中加载 SpreadJS 文件。此方法提供以下参数：

file blob：它代表压缩的电子表格数据文件流。
successCallBack：此函数在加载文件完成并接受 JSON 作为参数时提供成功回调。
errorCallBack：该函数在文件加载返回错误时给出错误回调。
openOptions：该参数继承自 GC.Spread.Sheets.OpenOptions 类型。

不同的打开选项如下：

选项	描述
includeStyles	表示是否在导入时包含样式，默认是包含（true）
includeFormulas	表示是否在导入时包含公式，默认是包含（true）
fullRecalc	表示是否在导入后进行全量计算，默认是计算（true）
dynamicReferences	表示是否进行动态引用计算，默认是计算（true）
calcOnDemand	表示是否开启按需计算模式，默认开启（true）
includeUnusedStyles	表示是否导入未使用的命名样式，默认为导入（true）
openMode	代表标准（`normal`）、按需加载（`lazy`）以及增量加载（`incremental`）三种模式，继承自 `GC.Spread.Sheets.OpenMode` 类型
progress	导入进度的回调函数，继承自 `GC.Spread.Sheets.ProgressFunctionType` 类型

以下代码实现显示了如何执行打开文件操作：

//This example uses the open method.
//Get file blob.
var file = document.getElementById("fileInput").files[0];
// import
spread.open(file, function () {
    // success callback to do something
}, function (e) {
    console.log(e); // error callback
}, {
    openMode: GC.Spread.Sheets.OpenMode.lazy,
    includeFormulas: false,
    includeStyles: false
});

Save - 保存文件

您可以使用 save 方法保存 SpreadJS 文件，该方法提供以下参数：

successCallBack：当 SpreadJS 文件完全保存并接受 Blob 作为参数时，此函数会提供成功回调。
errorCallBack：该函数在保存 SpreadJS 文件返回错误时给出错误回调。
saveOptions：继承自 GC.Spread.Sheets.SaveOptions 类型定义，提供保存选项。

保存选项	描述
includeBindingSource	是否包含数据源，默认不包含（false）
includeStyles	是否包含样式，默认包含（true）
includeFormulas	是否包含公式，默认包含（true）
saveAsView	是否忽略格式，默认不忽略（false）
includeAutoMergedCells	是否包含自动合并的单元格，默认不包含（false）
includeCalcModelCache	保存文件时是否可以包含计算的额外数据。默认情况下，值为 true。
includeUnusedNames	保存文件时是否可以包含未使用的自定义名称。默认情况下，值为 true。
includeEmptyRegionCells	是否可以在使用的数据范围之外包含任何空单元格。默认情况下，值为 true。
saveR1C1Formula	指示是否将r1c1公式保存在文件中。默认情况下，该值为 false。

以下代码实现显示了如何执行保存文件操作：

var fileName = "fileNamehere.sjs";
spread.save(function (blob) {
    // save blob to a file
    saveAs(blob, fileName);
}, function (e) {
    console.log(e);
}, {
    includeUnusedNames: false,
    includeEmptyRegionCells: false
});

Export - 导出文件

您可以在 SpreadJS 中将文件导出为 Excel、SSJSON 或 CSV 格式。

导出方法提供以下参数：

successCallBack：此函数在文件导出完成并接受 Blob 作为参数时提供成功回调。
errorCallBack：该函数在导出文件返回错误时给出错误回调。
saveOptions：继承自 GC.Spread.Sheets.ExportOptions 类型定义，提供导出选项。

导出选项	描述
FileOptions	继承自 `GC.Spread.Sheets.FileType` 类型定义，FileOptions 提供不同的文件格式。
ExportCsvOptions	继承自 `GC.Spread.Sheets.ExportCsvOptions`，ExportCsvOptions 提供了将文件导出为 CSV 格式的选项。
ExportSSJsonOptions	继承自 `GC.Spread.Sheets.ExportSSJsonOptions`，ExportCsvOptions 提供了将文件导出为 SSJSON 格式的选项。
ExportXlsxOptions	继承自 `GC.Spread.Sheets.ExportXlsxOptions`，ExportCsvOptions 提供了将文件导出为 Excel 格式的选项。

代码实现显示了如何执行导出文件操作：

var fileName = "fileNamehere.ssjson";           
spread.export(function (blob) {
    // save blob to a file
    saveAs(blob, fileName);
}, function (e) {
    console.log(e);
}, {
    fileType: GC.Spread.Sheets.FileType.ssjson,
    includeBindingSource: true
});

Import - 导入文件

您还可以在 SpreadJS 中导入 Excel、SSJSON 或 CSV 格式的文件。

导入方法提供以下参数：

file：要导入的 SSJSON 或 CSV 或 Excel 文件。
successCallBack：此函数在文件导入完成时提供成功回调。
errorCallBack：此函数在导入文件返回错误时给出错误回调。
importOptions：继承自 GC.Spread.Sheets.ImportOptions 类型定义，提供导入选项。

选项	描述
FileOptions	继承自 `GC.Spread.Sheets.FileType` 类型定义，FileOptions 提供不同的文件格式。
ImportCsvOptions	继承自 `GC.Spread.Sheets.ImportCsvOptions`，`ImportCsvOptions` 提供从 CSV 格式导入文件的选项。
ImportSSJsonOptions	继承自 `GC.Spread.Sheets.ImportSSJsonOptions`，ImporSSjsonOptions 提供了从 SSJSON 格式导入文件的选项。
ImportXlsxOptions	继承自 `GC.Spread.Sheets.ImportXlsxOptions`，ImportXlsxOptions 提供从 Excel 格式导入文件的选项。

代码实现显示了如何执行导入文件操作：

//Get file blob.
var file = document.getElementById("fileInput").files[0];
// import
spread.import(file, function () {
    // success callback to do something
}, function (e) {
    console.log(e); // error callback
}, {
    fileType: GC.Spread.Sheets.FileType.excel
});