SpreadJS製品ヘルプ
toJSON メソッド
GC.Spread.Sheets 名前空間 > Workbook タイプ : toJSON メソッド
シリアル化のオプション。
ワークブックをjsonに変換するときにバインディングソースを含めるかどうか。
ワークブックをjsonに変換するときにスタイルを無視するかどうか。
ワークブックをjsonに変換するときに数式を無視するかどうか。
ワークブックをjsonに変換するときに書式文字列を無視するかどうか。
ワークブックをjsonに変換するときに行ヘッダーを固定列として扱うかどうか。
ワークブックをjsonに変換するときに列ヘッダーを固定行として扱うかどうか。
ワークブックをjsonに変換するときに自動的に結合されたセルを含めるかどうか。
オブジェクト状態をJSON文字列に保存します。
シンタックス
var instance = new GC.Spread.Sheets.Workbook(host,
                                            options,
                                            options.sheetCount,
                                            options.font,
                                            options.allowUserDragMerge,
                                            options.allowUserDragDrop,
                                            options.allowUserDragFill,
                                            options.allowUserZoom,
                                            options.allowUserResize,
                                            options.allowUndo,
                                            options.allowSheetReorder,
                                            options.allowContextMenu,
                                            options.allowUserDeselect,
                                            options.defaultDragFillType,
                                            options.showDragFillSmartTag,
                                            options.showHorizontalScrollbar,
                                            options.showVerticalScrollbar,
                                            options.scrollbarShowMax,
                                            options.scrollbarMaxAlign,
                                            options.tabStripVisible,
                                            options.tabStripRatio,
                                            options.tabEditable,
                                            options.newTabVisible,
                                            options.tabNavigationVisible,
                                            options.cutCopyIndicatorVisible,
                                            options.cutCopyIndicatorBorderColor,
                                            options.backColor,
                                            options.backgroundImage,
                                            options.backgroundImageLayout,
                                            options.grayAreaBackColor,
                                            options.showResizeTip,
                                            options.showDragDropTip,
                                            options.showDragFillTip,
                                            options.showScrollTip,
                                            options.scrollIgnoreHidden,
                                            options.highlightInvalidData,
                                            options.useTouchLayout,
                                            options.hideSelection,
                                            options.resizeZeroIndicator,
                                            options.allowUserEditFormula,
                                            options.enableFormulaTextbox,
                                            options.autoFitType,
                                            options.referenceStyle,
                                            options.calcOnDemand,
                                            options.allowCopyPasteExcelStyle,
                                            options.allowExtendPasteRange,
                                            options.copyPasteHeaderOptions,
                                            options.scrollByPixel,
                                            options.scrollPixel,
                                            options.enableAccessibility,
                                            options.allowAutoCreateHyperlink,
                                            options.columnResizeMode,
                                            options.rowResizeMode,
                                            options.customList,
                                            options.scrollbarAppearance,
                                            options.pasteSkipInvisibleRange);
var value; // Type: Object
value = instance.toJSON(                                            serializationOption,
                                            serializationOption.includeBindingSource,
                                            serializationOption.ignoreStyle,
                                            serializationOption.ignoreFormula,
                                            serializationOption.saveAsView,
                                            serializationOption.rowHeadersAsFrozenColumns,
                                            serializationOption.columnHeadersAsFrozenRows,
                                            serializationOption.includeAutoMergedCells);
function toJSON( 
   serializationOption : Object,
   (optional) serializationOption.includeBindingSource : boolean,
   (optional) serializationOption.ignoreStyle : boolean,
   (optional) serializationOption.ignoreFormula : boolean,
   (optional) serializationOption.saveAsView : boolean,
   (optional) serializationOption.rowHeadersAsFrozenColumns : boolean,
   (optional) serializationOption.columnHeadersAsFrozenRows : boolean,
   (optional) serializationOption.includeAutoMergedCells : boolean
) : Object;

パラメータ

serializationOption
シリアル化のオプション。
serializationOption.includeBindingSource
ワークブックをjsonに変換するときにバインディングソースを含めるかどうか。
serializationOption.ignoreStyle
ワークブックをjsonに変換するときにスタイルを無視するかどうか。
serializationOption.ignoreFormula
ワークブックをjsonに変換するときに数式を無視するかどうか。
serializationOption.saveAsView
ワークブックをjsonに変換するときに書式文字列を無視するかどうか。
serializationOption.rowHeadersAsFrozenColumns
ワークブックをjsonに変換するときに行ヘッダーを固定列として扱うかどうか。
serializationOption.columnHeadersAsFrozenRows
ワークブックをjsonに変換するときに列ヘッダーを固定行として扱うかどうか。
serializationOption.includeAutoMergedCells
ワークブックをjsonに変換するときに自動的に結合されたセルを含めるかどうか。

戻り値の型

スプレッドシートデータ。
使用例
次のサンプルコードは、toJSONメソッドを使用します。
activeSheet.getCell(0,0).value(123);
var jsonStr = null;
//export
jsonStr = JSON.stringify(spread.toJSON({includeBindingSource: false}));
//import
spread.fromJSON(JSON.parse(jsonStr));
alert(jsonStr);
解説

toJSONメソッドのincludeBindingSourceオプションがtrueの場合は、シートのデータソースおよびテーブルのデータソースがセル値としてシリアル化されます。

serializationOptionパラメーターは以下の引数を持ちます。

名前

説明

serializationOption

Object

シリアル化オプション。

名前

説明

includeBindingSource

boolean

optional ワークブックをjsonに変換するときに連結ソースを含めるかどうか。
ignoreStyle

boolean

optional ワークブックをjsonに変換するときにスタイルを無視するかどうか。
ignoreFormula

boolean

optional ワークブックをjsonに変換するときに数式を無視するかどうか。
rowHeadersAsFrozenColumns

boolean

optional ワークブックをjsonに変換するときに行ヘッダを固定列として扱うかどうか。
columnHeadersAsFrozenRows

boolean

optional ワークブックをjsonに変換するときに列ヘッダを固定行として扱うかどうか。

関連トピック

参照

Workbook タイプ