@mescius/spread-sheets 17.1.3 → 17.1.4

package/dist/gc.spread.sheets.d.ts

@@ -12893,6 +12893,34 @@ declare module GC{
             }
 
 
+            export interface IDeserializationOptions{
+                /**
+                 * Whether to ignore the style when converting json to the workbook.
+                 */
+                ignoreStyle?: boolean;
+                /**
+                 * Whether to ignore the formula when converting json to the workbook.
+                 */
+                ignoreFormula?: boolean;
+                /**
+                 * Whether to treat the frozen columns as row headers when converting json to the workbook.
+                 */
+                frozenColumnsAsRowHeaders?: boolean;
+                /**
+                 * Whether to treat the frozen rows as column headers when converting json to the workbook.
+                 */
+                frozenRowsAsColumnHeaders?: boolean;
+                /**
+                 * Whether to prevent recalculation after loading the json data.
+                 */
+                doNotRecalculateAfterLoad?: boolean;
+                /**
+                 * Whether to use the incremental loading or the callbacks of incremental loading when converting json to the workbook.
+                 */
+                incrementalLoading?: boolean | GC.Spread.Sheets.IIncrementalLoadingOptions;
+            }
+
+
             export interface IDirtyCellInfo{
                 row: number;
                 col: number;
@@ -13241,6 +13269,18 @@ declare module GC{
             }
 
 
+            export interface IIncrementalLoadingOptions{
+                /**
+                 * The callback when of the incremental loading finished.
+                 */
+                loaded?: () => void;
+                /**
+                 * The callback when of the incremental loading progress.
+                 */
+                loading?: (progress: number, args: { sheet: GC.Spread.Sheets.Worksheet }) => void;
+            }
+
+
             export interface IInvalidOperationEventArgs{
                 sheet: GC.Spread.Sheets.Worksheet;
                 sheetName: string;
@@ -13622,6 +13662,42 @@ declare module GC{
             }
 
 
+            export interface ISerializationOption{
+                /**
+                 * Whether to include the binding source when converting the workbook to json.
+                 */
+                includeBindingSource?: boolean;
+                /**
+                 * Whether to ignore the style when converting the workbook to json.
+                 */
+                ignoreStyle?: boolean;
+                /**
+                 * Whether to ignore the formula when converting the workbook to json.
+                 */
+                ignoreFormula?: boolean;
+                /**
+                 * Whether to apply the format string to exporting value when converting the workbook to json, default false.
+                 */
+                saveAsView?: boolean;
+                /**
+                 * Whether to treat the row headers as frozen columns when converting the workbook to json.
+                 */
+                rowHeadersAsFrozenColumns?: boolean;
+                /**
+                 * Whether to treat the column headers as frozen rows when converting the workbook to json.
+                 */
+                columnHeadersAsFrozenRows?: boolean;
+                /**
+                 * Whether to include the automatically merged cells when converting the workbook to json.
+                 */
+                includeAutoMergedCells?: boolean;
+                /**
+                 * Whether to save the r1c1 formula in the file.
+                 */
+                saveR1C1Formula?: boolean;
+            }
+
+
             export interface ISetBorderOptions{
                 all?: boolean;
                 left?: boolean;
@@ -22835,15 +22911,7 @@ declare module GC{
                 /**
                  * Loads the object state from the specified JSON string.
                  * @param {Object} workbookData The spreadsheet data from deserialization.
-                 * @param {Object} [deserializationOptions] - The deserialization options.
-                 * @param {boolean} [deserializationOptions.ignoreStyle] - Whether to ignore the style when converting json to the workbook.
-                 * @param {boolean} [deserializationOptions.ignoreFormula] - Whether to ignore the formula when converting json to the workbook.
-                 * @param {boolean} [deserializationOptions.frozenColumnsAsRowHeaders] - Whether to treat the frozen columns as row headers when converting json to the workbook.
-                 * @param {boolean} [deserializationOptions.frozenRowsAsColumnHeaders] - Whether to treat the frozen rows as column headers when converting json to the workbook.
-                 * @param {boolean} [deserializationOptions.doNotRecalculateAfterLoad] - Whether to prevent recalculation after loading the json data.
-                 * @param {boolean | object} [deserializationOptions.incrementalLoading] - Whether to use the incremental loading or the callbacks of incremental loading when converting json to the workbook.
-                 * @param {function} [deserializationOptions.incrementalLoading.loading] - The callback when of the incremental loading progress.
-                 * @param {function} [deserializationOptions.incrementalLoading.loaded] - The callback when of the incremental loading finished.
+                 * @param {GC.Spread.Sheets.IDeserializationOptions} [deserializationOptions] - The deserialization options.
                  * @returns {Promise} - The fromJSON promise.
                  * @example
                  * ```
@@ -22859,7 +22927,7 @@ declare module GC{
                  * });
                  * ```
                  */
-                fromJSON(workbookData: Object,  deserializationOptions?: Object): Promise<any>;
+                fromJSON(workbookData: Object,  deserializationOptions?: GC.Spread.Sheets.IDeserializationOptions): Promise<any>;
                 /**
                  * Gets the active sheet.
                  * @returns {GC.Spread.Sheets.Worksheet} The active sheet instance.
@@ -23429,15 +23497,8 @@ declare module GC{
                 suspendPaint(): void;
                 /**
                  * Saves the object state to a JSON string.
-                 * @param {Object} serializationOption - The serialization options.
-                 * @param {boolean} [serializationOption.includeBindingSource] - Whether to include the binding source when converting the workbook to json.
-                 * @param {boolean} [serializationOption.ignoreStyle] - Whether to ignore the style when converting the workbook to json.
-                 * @param {boolean} [serializationOption.ignoreFormula] - Whether to ignore the formula when converting the workbook to json.
-                 * @param {boolean} [serializationOption.saveAsView] - Whether to apply the format string to exporting value when converting the workbook to json, default false.
-                 * @param {boolean} [serializationOption.rowHeadersAsFrozenColumns] - Whether to treat the row headers as frozen columns when converting the workbook to json.
-                 * @param {boolean} [serializationOption.columnHeadersAsFrozenRows] - Whether to treat the column headers as frozen rows when converting the workbook to json.
-                 * @param {boolean} [serializationOption.includeAutoMergedCells] - Whether to include the automatically merged cells when converting the workbook to json. * @returns {Object} The spreadsheet data.
-                 * @param {boolean} [serializationOption.saveR1C1Formula] - Whether to save the r1c1 formula in the file.
+                 * @param {GC.Spread.Sheets.ISerializationOption} serializationOption - The serialization options.
+                 * @returns {Object} The spreadsheet data.
                  * @example
                  * ```
                  * activeSheet.getCell(0,0).value(123);
@@ -23449,7 +23510,7 @@ declare module GC{
                  * alert(jsonStr);
                  * ```
                  */
-                toJSON(serializationOption?: Object): Object;
+                toJSON(serializationOption?: GC.Spread.Sheets.ISerializationOption): Object;
                 /**
                  * Removes the binding of an event to Workbook.
                  * @param {string} type The event type.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mescius/spread-sheets",
-  "version": "17.1.3",
+  "version": "17.1.4",
   "main": "index.js",
   "description":"A Complete Microsoft Excel-like JavaScript Spreadsheet for Enterprise Applications",
   "scripts": {},