@grapecity-software/spread-sheets-designer 18.1.4 → 18.2.0

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

@@ -269,6 +269,17 @@ declare module GC.Spread.Sheets{
          * ```
          */
         function getTemplate(templateName: string): GC.Spread.Sheets.Designer.IDialogTemplate | null;
+        /**
+         * This function returns the designer's current theme.
+         * @returns {GC.Spread.Sheets.Designer.ITheme} - Current theme
+         * @example
+         * ```
+         * // Get the background color of the current theme.
+         * let currentTheme = GC.Spread.Sheets.Designer.getTheme();
+         * console.log(currentTheme.colorBackground);
+         * ```
+         */
+        function getTheme(): GC.Spread.Sheets.Designer.ITheme;
         /**
          * Register a template to templateMap so that designer can find the template.
          * @param {string} templateName - Name of template, uniquely identifies one template.
@@ -392,6 +403,22 @@ declare module GC.Spread.Sheets{
          * ```
          */
         function setResources(resources: Object): void;
+        /**
+         * This method can set the designer's theme, pass in null to reset the custom theme.
+         * @param {Partial<GC.Spread.Sheets.Designer.ITheme> | null} theme - The designer theme to be configured allows selective customization of individual properties.
+         * @returns {void}
+         * @example
+         * ```
+         * // Set the background color of the theme to blue.
+         * GC.Spread.Sheets.Designer.setTheme({
+         *     colorBackground: 'blue'
+         * });
+         *
+         * // Reset the custom theme.
+         * GC.Spread.Sheets.Designer.setTheme(null);
+         * ```
+         */
+        function setTheme(Theme: Partial<GC.Spread.Sheets.Designer.ITheme> | null): void;
         /**
          * This function will show a dialog with the option, the option will be used in the dialog template got by template name.
          * @param {string} templateName - The template name.
@@ -1347,6 +1374,32 @@ declare module GC.Spread.Sheets{
         }
 
 
+        export interface ITheme{
+            colorForeground: string | undefined;
+            colorForegroundDisabled: string | undefined;
+            colorBackground: string | undefined;
+            colorBackgroundHover: string | undefined;
+            colorBackgroundSelected: string | undefined;
+            colorBackgroundDisabled: string | undefined;
+            colorBackground2: string | undefined;
+            colorBackground2Hover: string | undefined;
+            colorBackground2Selected: string | undefined;
+            colorBrandForeground: string | undefined;
+            colorBrandBackground: string | undefined;
+            colorBrandBackgroundHover: string | undefined;
+            colorBrandBackgroundSelected: string | undefined;
+            colorStroke: string | undefined;
+            colorStrokeHover: string | undefined;
+            colorStrokeSelected: string | undefined;
+            colorStrokeDisabled: string | undefined;
+            borderRadiusM: string | undefined;
+            borderRadiusL: string | undefined;
+            borderRadiusXL: string | undefined;
+            shadow4: string | undefined;
+            shadow8: string | undefined;
+        }
+
+
         export type CommandMap = {
             [key in string]: GC.Spread.Sheets.Designer.ICommand;
         }
@@ -1444,7 +1497,7 @@ declare module GC.Spread.Sheets{
              */
             Json = 1,
             /**
-             * Specifies the import file type is excel.
+             * Specifies the import file type is excel (xlsx).
              */
             Excel = 2,
             /**
@@ -1454,7 +1507,15 @@ declare module GC.Spread.Sheets{
             /**
              * Specifies the import file type is sjs.
              */
-            SJS = 4
+            SJS = 4,
+            /**
+             * Specifies the import file type is excel (xlsm).
+             */
+            XLSM = 5,
+            /**
+             * Specifies the import file type is excel (xltm).
+             */
+            XLTM = 6
         }
 
         /**
@@ -1526,6 +1587,101 @@ declare module GC.Spread.Sheets{
             cancel = 4
         }
 
+        /**
+         * @enum {string}
+         * This enum is used to judge the import file type
+         */
+        export enum ThemeTokens{
+            /**
+             *  Normal foreground color, used for the color of all regular text.
+             */
+            colorForeground = "--sjs-color-foreground",
+            /**
+             *  The color of regular text when the component is disabled.
+             */
+            colorForegroundDisabled = "--sjs-color-foreground-disabled",
+            /**
+             * Normal background color, used for the background of all standard components.
+             */
+            colorBackground = "--sjs-color-background",
+            /**
+             * Background color when a standard component is hovered.
+             */
+            colorBackgroundHover = "--sjs-color-background-hover",
+            /**
+             *  Background color when a standard component is selected.
+             */
+            colorBackgroundSelected = "--sjs-color-background-selected",
+            /**
+             *  Background color when a standard component is disabled.
+             */
+            colorBackgroundDisabled = "--sjs-color-background-disabled",
+            /**
+             *  Background color for the bottom-most container in the designer.
+             */
+            colorBackground2 = "--sjs-color-background-2",
+            /**
+             * Background color when the bottom-most container’s component is hovered.
+             */
+            colorBackground2Hover = "--sjs-color-background-2-hover",
+            /**
+             * Background color when the bottom-most container’s component is selected.
+             */
+            colorBackground2Selected = "--sjs-color-background-2-selected",
+            /**
+             *  Text color used on top of the brand background color.
+             */
+            colorBrandForeground = "--sjs-color-brand-foreground",
+            /**
+             * The color representing the brand, used as the product’s color identifier. It serves as the background color for components that need to stand out or showcase the brand’s style.
+             */
+            colorBrandBackground = "--sjs-color-brand-background",
+            /**
+             * Background color when the brand background color is hovered.
+             */
+            colorBrandBackgroundHover = "--sjs-color-brand-background-hover",
+            /**
+             * Background color when the brand background color is selected.
+             */
+            colorBrandBackgroundSelected = "--sjs-color-brand-background-selected",
+            /**
+             * Border color.
+             */
+            colorStroke = "--sjs-color-stroke",
+            /**
+             *  Border color when the component is hovered.
+             */
+            colorStrokeHover = "--sjs-color-stroke-hover",
+            /**
+             * Border color when the component is selected.
+             */
+            colorStrokeSelected = "--sjs-color-stroke-selected",
+            /**
+             * Border color when the component is disabled.
+             */
+            colorStrokeDisabled = "--sjs-color-stroke-disabled",
+            /**
+             * Medium border radius.
+             */
+            borderRadiusM = "--sjs-border-radius-m",
+            /**
+             * Large border radius.
+             */
+            borderRadiusL = "--sjs-border-radius-l",
+            /**
+             * Extra-large border radius.
+             */
+            borderRadiusXL = "--sjs-border-radius-xl",
+            /**
+             * Shadow with a blur radius of 4px.
+             */
+            shadow4 = "--sjs-shadow-4",
+            /**
+             * Shadow with a blur radius of 8px.
+             */
+            shadow8 = "--sjs-shadow-8"
+        }
+
 
         export class AtomicComponentBase<ValueType, OptionsType>{
             /**
@@ -3415,6 +3571,14 @@ declare module GC.Spread.Sheets{
              * ```
              */
             static ComboChartPreview: string;
+            /**
+             * Get the command name CommandPaletteButton.
+             * @name GC.Spread.Sheets.Designer#CommandPaletteButton
+             * @example
+             * // This example get the CommandPaletteButton by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.CommandPaletteButton);
+             */
+            static CommandPaletteButton: string;
             /**
              * Get the command name CommandPalettePanel.
              * @name GC.Spread.Sheets.Designer#CommandPalettePanel
@@ -3519,6 +3683,22 @@ declare module GC.Spread.Sheets{
              * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.ContextMenuSlicerSetting);
              */
             static ContextMenuSlicerSetting: string;
+            /**
+             * Get the command name ConvertFromDataTable.
+             * @name GC.Spread.Sheets.Designer#ConvertFromDataTable
+             * @example
+             * // This example get the ConvertFromDataTable by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.ConvertFromDataTable);
+             */
+            static ConvertFromDataTable: string;
+            /**
+             * Get the command name ConvertToDataTable.
+             * @name GC.Spread.Sheets.Designer#ConvertToDataTable
+             * @example
+             * // This example get the ConvertToDataTable by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.ConvertToDataTable);
+             */
+            static ConvertToDataTable: string;
             /**
              * Get the command name ConvertToRange.
              * @name GC.Spread.Sheets.Designer#ConvertToRange
@@ -5762,6 +5942,14 @@ declare module GC.Spread.Sheets{
              * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.InsertTable);
              */
             static InsertTable: string;
+            /**
+             * Get the command name InsertTableFromDataTable.
+             * @name GC.Spread.Sheets.Designer#InsertTableFromDataTable
+             * @example
+             * // This example get the InsertTableFromDataTable by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.InsertTableFromDataTable);
+             */
+            static InsertTableFromDataTable: string;
             /**
              * Get the command name InsertTableSheet.
              * @name GC.Spread.Sheets.Designer#InsertTableSheet
@@ -8016,6 +8204,14 @@ declare module GC.Spread.Sheets{
              * ```
              */
             static ReportSheetExpandAll: string;
+            /**
+             * Get the command name ReportSheetHiddenRowColStyle.
+             * @name GC.Spread.Sheets.Designer#ReportSheetHiddenRowColStyle
+             * @example
+             * // This example get the ReportSheetHiddenRowColStyle by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.ReportSheetHiddenRowColStyle);
+             */
+            static ReportSheetHiddenRowColStyle: string;
             /**
              * Get the command name ReportSheetImportTemplate.
              * @name GC.Spread.Sheets.Designer#ReportSheetImportTemplate
@@ -8074,6 +8270,14 @@ declare module GC.Spread.Sheets{
              * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.ReportSheetSetDirtyStyle);
              */
             static ReportSheetSetDirtyStyle: string;
+            /**
+             * Get the command name ReportSheetShowHiddenRowCol.
+             * @name GC.Spread.Sheets.Designer#ReportSheetShowHiddenRowCol
+             * @example
+             * // This example get the ReportSheetShowHiddenRowCol by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.ReportSheetShowHiddenRowCol);
+             */
+            static ReportSheetShowHiddenRowCol: string;
             /**
              * Get the command name ReportSheetSubmit.
              * @name GC.Spread.Sheets.Designer#ReportSheetSubmit
@@ -9714,6 +9918,30 @@ declare module GC.Spread.Sheets{
              * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.TableAllowAutoExpand);
              */
             static TableAllowAutoExpand: string;
+            /**
+             * Get the command name TableBindingSource.
+             * @name GC.Spread.Sheets.Designer#TableBindingSource
+             * @example
+             * // This example get the TableBindingSource by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.TableBindingSource);
+             */
+            static TableBindingSource: string;
+            /**
+             * Get the command name TableConvertFromDataTable.
+             * @name GC.Spread.Sheets.Designer#TableConvertFromDataTable
+             * @example
+             * // This example get the TableConvertFromDataTable by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.TableConvertFromDataTable);
+             */
+            static TableConvertFromDataTable: string;
+            /**
+             * Get the command name TableConvertToDataTable.
+             * @name GC.Spread.Sheets.Designer#TableConvertToDataTable
+             * @example
+             * // This example get the TableConvertToDataTable by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.TableConvertToDataTable);
+             */
+            static TableConvertToDataTable: string;
             /**
              * Get the command name TableDelete.
              * @name GC.Spread.Sheets.Designer#TableDelete
@@ -10482,6 +10710,14 @@ declare module GC.Spread.Sheets{
              * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.TopThickBottomBorder);
              */
             static TopThickBottomBorder: string;
+            /**
+             * Get the command name TransformCells.
+             * @name GC.Spread.Sheets.Designer#TransformCells
+             * @example
+             * // This example get the TransformCells by the command name.
+             * var command = GC.Spread.Sheets.Designer.getCommand(GC.Spread.Sheets.Designer.CommandNames.TransformCells);
+             */
+            static TransformCells: string;
             /**
              * Get the command name TreemapChart.
              * @name GC.Spread.Sheets.Designer#TreemapChart
@@ -13265,6 +13501,16 @@ declare module GC.Spread.Sheets{
              * var template = GC.Spread.Sheets.Designer.getTemplate(GC.Spread.Sheets.Designer.TemplateNames.Top10RuleDialogTemplate);
              */
             static Top10RuleDialogTemplate: string;
+            /**
+             * Get the template name.
+             * @name GC.Spread.Sheets.Designer#TransFormCellsTemplate
+             * @example
+             * ```
+             * //this example get the TransFormCellsTemplate by the template name.
+             * var template = GC.Spread.Sheets.Designer.getTemplate(GC.Spread.Sheets.Designer.TemplateNames.TransFormCellsTemplate);
+             * ```
+             */
+            static TransFormCellsTemplate: string;
             /**
              * Get the template name.
              * @name GC.Spread.Sheets.Designer#TreeMapChartPanelTemplate

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grapecity-software/spread-sheets-designer",
-  "version": "18.1.4",
+  "version": "18.2.0",
   "main": "index.js",
   "description":"SpreadJS Designer Component present as a control that could be embedded into your web application easily, and also provided flexible, customizable configuration to achieve your business logic.",
   "scripts": {},