ファイル操作

SpreadJSでは、SpreadJS独自のファイル形式であるSJS形式やSSJSON形式のファイルの入出力や、ExcelやCSVファイルのインポートとエクスポート機能を提供します。SpreadJSは、さまざまな形式のファイルの処理をサポートするためにgc.spread.sheets.io.xxx.jsプラグインを提供します。

type=warning
gc.spread.sheets.ioプラグインは、パスワードで保護されたExcelファイルはサポートしていません。パスワードで保護されたExcelファイルのインポートやエクスポートを行う場合は、gc.spread.excelioプラグインを使用してください。

GC.Spread.Sheets.Workbookクラスは、ファイル操作のために次のメソッドを提供します。

メソッド	説明
open	SpreadJSファイル（SJS形式）を読み込みます。
save	SpreadJSファイル（SJS形式）を保存します。
export	Excel、SSJSON、またはCSV形式でファイルをエクスポートします。
import	Excel、SSJSON、CSV、またはJavaScript形式のファイルをインポートします。

次のセクションでは、さまざまなファイル操作について詳しく説明します。

ファイルを開く

SpreadJSファイル（SJS形式）を読み込むには、openメソッドを使用します。このメソッドは、次のパラメータを提供します。

blob：圧縮されたスプレッドシートのデータファイルを表します。
successCallBack：この関数は、ファイルの読み込みが成功した後に呼び出されます。JSONを引数として受け取ります。
errorCallBack：この関数は、ファイルの読み込みでエラーが発生した場合に呼び出されます。
openOptions：GC.Spread.Sheets.OpenOptions から継承されます。このパラメータは、ファイルを開くオプションを提供します。

openメソッドで指定できるオプションは、次の通りです。

オプション	説明
includeStyles	読み込み時にスタイルを含めるかどうかを示します。デフォルト値は、trueです。
includeFormulas	読み込み時に数式を含めるかどうかを示します。デフォルト値は、trueです。
fullRecalc	データのロード後に再計算を行うかどうかを示します。デフォルト値は、trueです。
dynamicReferences	動的参照を使用して関数を計算できるかどうかを示します。デフォルト値は、trueです。
calcOnDemand	必要な場合にのみ数式を計算できるかどうかを示します。デフォルト値は、trueです。
includeUnusedStyles	未使用の名前付きスタイルを含めるかどうかを示します。デフォルト値は、trueです。
openMode	GC.Spread.Sheets.OpenMode列挙体から継承されます。openModeは、標準、遅延、増分のいずれかを指定します。デフォルトでは、標準です。
progress	GC.Spread.Sheets.ProgressFunctionType から継承されます。各OpenModeの進行状況のコールバック関数です。

次のサンプルコードは、ファイルを開く方法を示します。

//この例では openメソッドを使用しています。
// ファイルblobを取得します。
var file = document.getElementById("fileInput").files[0];
// インポート。
spread.open(file, function () {
    // 成功時のコールバック。
}, function (e) {
    console.log(e); // エラーが発生した時のコールバック。
}, {
    openMode: GC.Spread.Sheets.OpenMode.lazy,
    includeFormulas: false,
    includeStyles: false
});

ファイルを保存する

SpreadJSファイル（SJS形式）を保存するには、saveメソッドを使用します。このメソッドは、次のパラメータを提供します。

successCallBack：この関数は、SpreadJSファイルの保存が成功した後に呼び出されます。Blobを引数として受け取ります。
errorCallBack：この関数は、ファイルの保存でエラーが発生した場合に呼び出されます。
saveOptions：GC.Spread.Sheets.SaveOptions から継承されます。このパラメータは、保存オプションを提供します。

saveメソッドで指定できる、さまざまな保存オプションは次の通りです。

オプション	説明
includeBindingSource	ファイルを保存する時にデータソースを含めるかどうかを示します。デフォルト値はfalseです。
includeStyles	ファイルを保存する時にスタイルを含めるかどうかを示します。デフォルト値は、trueです。
includeFormulas	ファイルを保存する時に数式を含めるかどうかを示します。デフォルト値は、trueです。
saveAsView	ファイルを保存する時に、表示形式の書式を適用するかどうかを示します。デフォルト値は、falseです。
includeAutoMergedCells	ファイルを保存する時に自動的に結合されたセルを含めるかどうかを示します。デフォルト値はfalseです。
includeCalcModelCache	ファイルを保存する時に計算の余分なデータを含めるかどうかを示します。デフォルト値は、trueです。
includeUnusedNames	ファイルを保存する時に未使用のカスタム名を含めるかどうかを示します。デフォルト値は、trueです。
includeEmptyRegionCells	使用されるデータ範囲外に空のセルを含めるかどうかを示します。デフォルト値は、trueです。

次のサンプルコードは、ファイルを保存する方法を示します。

var fileName = "fileNamehere.sjs";
spread.save(function (blob) {
    // blobをファイルに保存します。
    saveAs(blob, fileName);
}, function (e) {
    console.log(e);
}, {
    includeUnusedNames: false,
    includeEmptyRegionCells: false
});

ファイルをエクスポートする

ファイルをExcel、SSJSON、またはCSV形式でエクスポートできます。exportメソッドは、次のパラメータを提供します。

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から継承されます。ExportSSJsonOptionsは、ファイルをSSJSON形式でエクスポートするオプションを提供します。
ExportXlsxOptions	GC.Spread.Sheets.ExportXlsxOptionsから継承されます。ExportXlsxOptionsは、ファイルをExcel形式でエクスポートするオプションを提供します。

次のサンプルコードは、ファイルをエクスポートする方法を示します。

var fileName = "fileNamehere.ssjson";           
spread.export(function (blob) {
    // blobをファイルに保存します。
    saveAs(blob, fileName);
}, function (e) {
    console.log(e);
}, {
    fileType: GC.Spread.Sheets.FileType.ssjson,
    includeBindingSource: true
});

ファイルをインポートする

Spreadには、Excel、SSJSON、またはCSV形式のファイルをインポートできます。importメソッドは、次のパラメータを提供します。

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形式のファイルをインポートするオプションを提供します。

次のサンプルコードは、ファイルをインポートする方法を示します。

// ファイルblobを取得します。
var file = document.getElementById("fileInput").files[0];
// インポート。
spread.import(file, function () {
    // 成功時のコールバック。
}, function (e) {
    console.log(e); // エラーが発生した時のコールバック。
}, {
    fileType: GC.Spread.Sheets.FileType.excel
});