@grapecity-software/spread-common 19.1.2 → 19.1.3

package/dist/gc.spread.common.min.js

@@ -1,6 +1,6 @@
 /*!
  * 
- * SpreadJS Library 19.1.2
+ * SpreadJS Library 19.1.3
  *
  * Copyright(c) GrapeCity Software inc.  All rights reserved.
  *

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

@@ -12532,6 +12532,22 @@ declare namespace GC{
                  * ```
                  */
                 loadTemplate(templateJson: Object): void;
+                /**
+                 * Update the report sheet template, and also the report will be regenerated based on the new template and parameter values.
+                 * @param {Object} templateJson The template json.
+                 * @returns {Promise<void>}  A Promise that resolves when the template has been loaded from templateJson.
+                 * @example
+                 * ```javascript
+                 * const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
+                 * const templateSheet = new GC.Spread.Report.TemplateSheet("Template");
+                 * templateSheet.setTemplateCell(0, 0, {
+                 *    binding: "Orders[customerId]",
+                 *    type: "Group",
+                 * });
+                 * await report.loadTemplateAsync(templateSheet.toJSON());
+                 * ```
+                 */
+                loadTemplateAsync(templateJson: Object): Promise<void>;
                 /**
                  * Gets or sets the name of the ReportSheet.
                  * @param {string} value The name of the ReportSheet.
@@ -12619,6 +12635,24 @@ declare namespace GC{
                  * ```
                  */
                 refresh(): void;
+                /**
+                 * Refresh the current report sheet, all the render modes can support this function.
+                 * Design: Refresh the cache of the template sheet and repaint.
+                 * Preview: Regenerate the report base on the current template sheet and repaint.
+                 * PaginatedPreview: Regenerate the report base on the current template sheet and repaint.
+                 * @returns {Promise<void>} A Promise that resolves when the refresh operation finishes.
+                 * @example
+                 * ```javascript
+                 * const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
+                 * const templateSheet = report.getTemplate();
+                 * templateSheet.setTemplateCell(0, 0, {
+                 *    binding: "Orders[customerId]",
+                 *    type: "Group",
+                 * });
+                 * await report.refreshAsync();
+                 * ```
+                 */
+                refreshAsync(): Promise<void>;
                 /**
                  * Regenerate the report base on the current template.
                  * @example
@@ -12633,6 +12667,21 @@ declare namespace GC{
                  * ```
                  */
                 regenerateReport(): void;
+                /**
+                 * Regenerate the report base on the current template.
+                 * @returns {Promise<void>} A Promise that resolves when report regeneration is finished.
+                 * @example
+                 * ```javascript
+                 * const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
+                 * const templateSheet = report.getTemplate();
+                 * templateSheet.setTemplateCell(0, 0, {
+                 *    binding: "Orders[customerId]",
+                 *    type: "Group",
+                 * });
+                 * await report.regenerateReportAsync();
+                 * ```
+                 */
+                regenerateReportAsync(): Promise<void>;
                 /**
                  * Get or set the render mode.
                  * @param {GC.Spread.Report.RenderMode} renderMode The render mode.
@@ -12708,6 +12757,20 @@ declare namespace GC{
                  * ```
                  */
                 setParametersUI(host: HTMLElement | string,  initParametersUI: GC.Spread.Report.InitParametersUIFunctionType,  onChange: GC.Spread.Report.OnChangeFunctionType): void;
+                /**
+                 * Get or set the render mode.
+                 * @param {GC.Spread.Report.RenderMode} renderMode The render mode.
+                 * @returns {Promise<void>} A Promise that resolves when the render mode switch is fully applied.
+                 * @example
+                 * ```javascript
+                 * // switch to preview mode.
+                 * await reportSheet.setRenderModeAsync('Preview');
+                 *
+                 * // switch to paginated preview mode.
+                 * await reportSheet.setRenderModeAsync('PaginatedPreview');
+                 * ```
+                 */
+                setRenderModeAsync(renderMode: GC.Spread.Report.RenderMode): Promise<void>;
                 /**
                  * Submit the changes to the remote database based on your data entry setting through the DataManger.
                  * @example
@@ -14150,6 +14213,18 @@ declare namespace GC{
                  * True if the user can use PivotTables.
                  */
                 allowUsePivotTable?: boolean;
+                /**
+                 * Designer-only. Enables cell-formatting commands and related UI, including the Format Cells entry and protected PivotTable style commands.
+                 */
+                formatCells?: boolean;
+                /**
+                 * Designer-only. Enables column formatting UI such as width/autofit/hide-unhide.
+                 */
+                formatColumns?: boolean;
+                /**
+                 * Designer-only. Enables row formatting UI such as height/autofit/hide-unhide.
+                 */
+                formatRows?: boolean;
             }
 
 
@@ -20644,6 +20719,35 @@ declare namespace GC{
                  * ```
                  */
                 static RangeSorting: string;
+                /**
+                 * Occurs when the report generation stage changes.
+                 * @name GC.Spread.Report.ReportSheet#ReportGenerationStageChanged
+                 * @event
+                 * @param eventParam *{@link GC.Spread.Report.ReportSheet}* `report` The report sheet that triggered the event.
+                 * @param eventParam *'analyzing-template' | 'loading-data' | 'generating-report'* `stage` The current generation stage.
+                 * @param eventParam *'start' | 'end'* `phase` The stage phase.
+                 * @example
+                 * ```javascript
+                 * //This example uses the ReportGenerationStageChanged event.
+                 * const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
+                 * spread.bind(GC.Spread.Sheets.Events.ReportGenerationStageChanged, (event, args) => {
+                 *     let { stage, phase } = args;
+                 *     if (phase === "start") {
+                 *         if (stage === "analyzing-template") {
+                 *             showLoading("Analyzing template...");
+                 *         } else if (stage === "loading-data") {
+                 *             showLoading("Loading data...");
+                 *         } else if (stage === "generating-report") {
+                 *             showLoading("Generating report...");
+                 *         }
+                 *     }
+                 *     if (phase === "end" && stage === "generating-report") {
+                 *         hideLoading();
+                 *     }
+                 * });
+                 * ```
+                 */
+                static ReportGenerationStageChanged: string;
                 /**
                  * Occurs when the report sheet data has changed by update, insert or delete. Allows submitting data changes to the server.
                  * @name GC.Spread.Report.ReportSheet#ReportSheetDataChanged
@@ -25271,6 +25375,9 @@ declare namespace GC{
                  * @property {boolean} [protectionOptions.allowOutlineColumns] - True if the user can expand or collapse the column groups.
                  * @property {boolean} [protectionOptions.allowOutlineRows] - True if the user can expand or collapse the row groups.
                  * @property {boolean} [protectionOptions.allowUsePivotTable] - True if the user can use PivotTables.
+                 * @property {boolean} [protectionOptions.formatCells] - // Designer-only. Enables cell-formatting commands and related UI, including the Format Cells entry and protected PivotTable style commands.
+                 * @property {boolean} [protectionOptions.formatColumns] - // Designer-only. Enables column formatting UI such as width/autofit/hide-unhide.
+                 * @property {boolean} [protectionOptions.formatRows] - // Designer-only. Enables row formatting UI such as height/autofit/hide-unhide.
                  * @property {string} selectionBackColor - The selection's background color for the sheet.
                  * @property {string} selectionBorderColor -  The selection's border color for the sheet.
                  * @property {Object} sheetAreaOffset - The sheetAreaOffset's options.
@@ -34327,6 +34434,27 @@ declare namespace GC{
                  * ```
                  */
                 var commitArrayFormula: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string}): any};
+                /**
+                 * Represents the command used to commit the current cell editing value without moving the active cell.
+                 * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
+                 * @property {function} execute - performs an execute or undo operation.
+                 * The arguments of the execute method are as follows.
+                 * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
+                 * @property {Object} options The options of the operation.
+                 * @property {string} options.sheetName The sheet name.
+                 * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
+                 * @example
+                 * ```javascript
+                 * // commit the cell editing value without moving the active cell
+                 * activeSheet.setValue(1, 1, 'SpreadJS');
+                 * activeSheet.setActiveCell(1, 1);
+                 * activeSheet.startEdit();
+                 * window.setTimeout(function() {
+                 *     spread.commandManager().execute({cmd: "commitInput", sheetName: "Sheet1"});
+                 * }, 1000);
+                 * ```
+                 */
+                var commitInput: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string}): any};
                 /**
                  * Represents the command used to stop cell editing and moves the active cell to the next row.
                  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grapecity-software/spread-common",
-  "version": "19.1.2",
+  "version": "19.1.3",
   "main": "index.js",
   "description":"SpreadJS common module",
   "scripts": {},