@genesislcap/grid-pro 14.325.1 → 14.326.0

package/dist/grid-pro.api.json

@@ -3526,6 +3526,108 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!convertColDefsToColumnStates:function(1)",
+          "docComment": "/**\n * Converts an array of ColDef to an array of ColumnState\n *\n * @param colDefs - The column definitions to convert\n *\n * @returns The corresponding ColumnState array\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function convertColDefsToColumnStates(colDefs: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ColDef",
+              "canonicalReference": "@ag-grid-community/core!ColDef:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ColumnState",
+              "canonicalReference": "@ag-grid-community/core!ColumnState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/utils/array.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 4,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "colDefs",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "convertColDefsToColumnStates"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!convertColDefToColumnState:function(1)",
+          "docComment": "/**\n * Converts a ColDef to a ColumnState\n *\n * @param colDef - The column definition to convert\n *\n * @returns The corresponding ColumnState\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function convertColDefToColumnState(colDef: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ColDef",
+              "canonicalReference": "@ag-grid-community/core!ColDef:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ColumnState",
+              "canonicalReference": "@ag-grid-community/core!ColumnState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/utils/array.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "colDef",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "convertColDefToColumnState"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/grid-pro!convertToKebabCase:function(1)",
@@ -10681,6 +10783,94 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#defaultColumnConfig:member",
+              "docComment": "/**\n * The default column config to reset to when deleteColumnState is called.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "defaultColumnConfig: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ColDef",
+                  "canonicalReference": "@ag-grid-community/core!ColDef:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "defaultColumnConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#deleteColumnState:member(1)",
+              "docComment": "/**\n * Deletes the saved column state for the current grid\n *\n * @remarks\n *\n * This removes the persisted column state from storage, allowing the grid to use default column configuration\n *\n * @param resetToDefault - Whether to reset columns to their default configuration. Defaults to true.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "deleteColumnState(resetToDefault?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resetToDefault",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "deleteColumnState"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridPro#disconnectedCallback:member(1)",
@@ -12046,6 +12236,66 @@
               "isAbstract": false,
               "name": "setupPaginationAndStatusBar"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#sizeColumnsToContent:member",
+              "docComment": "/**\n * Boolean attribute to control whether the grid automatically sizes columns to fit their content. This will call AG Grid's autoSizeColumns() method to automatically adjust column widths based on content.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "sizeColumnsToContent: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "sizeColumnsToContent",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#sizeColumnsToFit:member",
+              "docComment": "/**\n * Boolean attribute to adjust the size of columns to fit the available horizontal space. This will call AG Grid's sizeColumnsToFit() method.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "sizeColumnsToFit: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "sizeColumnsToFit",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridPro#statePersistanceEnabled:member(1)",
@@ -17255,6 +17505,59 @@
           "name": "KVStorageStatePersistence",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!KVStorageStatePersistence#deleteColumnState:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "deleteColumnState(persistColumnStateKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "persistColumnStateKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "deleteColumnState"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!KVStorageStatePersistence#getColumnState:member(1)",
@@ -18030,6 +18333,59 @@
           "name": "LocalStorageStatePersistence",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!LocalStorageStatePersistence#deleteColumnState:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "deleteColumnState(persistColumnStateKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "persistColumnStateKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "deleteColumnState"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!LocalStorageStatePersistence#getColumnState:member(1)",
@@ -21531,6 +21887,56 @@
           "name": "StatePersistence",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/grid-pro!StatePersistence#deleteColumnState:member(1)",
+              "docComment": "/**\n * Deletes the column state for the given key.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "deleteColumnState(persistColumnStateKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "persistColumnStateKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "deleteColumnState"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/grid-pro!StatePersistence#getColumnState:member(1)",

package/dist/grid-pro.d.ts

@@ -489,6 +489,22 @@ export declare const CellTemplate: ViewTemplate<GridProCell, any>;
  */
 export declare const ColumnTemplate: ViewTemplate<GridProColumn, any>;
 
+/**
+ * Converts an array of ColDef to an array of ColumnState
+ * @param colDefs - The column definitions to convert
+ * @returns The corresponding ColumnState array
+ * @public
+ */
+export declare function convertColDefsToColumnStates(colDefs: ColDef[]): ColumnState[];
+
+/**
+ * Converts a ColDef to a ColumnState
+ * @param colDef - The column definition to convert
+ * @returns The corresponding ColumnState
+ * @public
+ */
+export declare function convertColDefToColumnState(colDef: ColDef): ColumnState;
+
 /**
  * Convert string values from 'camelCase' to 'kebab-case'
  * @param value - The value to convert to Kebab case.
@@ -1762,6 +1778,8 @@ export declare const GridOptionsConfig: InterfaceSymbol<GridOptionsConfig>;
 export declare class GridPro extends GridPro_base {
     columnApi: ColumnApi;
     gridApi: GridApi;
+    private cachedTotalColumnWidth;
+    private columnCount;
     gridErrorItems: GridProErrorItem<GridProErrorEvent['detail']>[];
     statePersistence: StatePersistence;
     /**
@@ -1777,6 +1795,18 @@ export declare class GridPro extends GridPro_base {
      * in local storage if you are using `persist-column-state-key`.
      */
     gridAutosizingEnabled: boolean;
+    /**
+     * Boolean attribute to control whether the grid automatically sizes columns to fit their content.
+     * This will call AG Grid's autoSizeColumns() method to automatically adjust column widths based on content.
+     * @public
+     */
+    sizeColumnsToContent: boolean;
+    /**
+     * Boolean attribute to adjust the size of columns to fit the available horizontal space.
+     * This will call AG Grid's sizeColumnsToFit() method.
+     * @public
+     */
+    sizeColumnsToFit: boolean;
     /**
      * The index to add new rows to when using `applyTransaction` or `applyTransactionAsync`
      */
@@ -1817,6 +1847,10 @@ export declare class GridPro extends GridPro_base {
      * The key to use for persisting the filter model in local browser or KV storage.
      */
     persistFilterModelKey: string;
+    /**
+     * The default column config to reset to when deleteColumnState is called.
+     */
+    defaultColumnConfig: ColDef[];
     /**
      * The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.
      * @remarks Can be one of the following: camelCase, capitalCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase.
@@ -1974,6 +2008,13 @@ export declare class GridPro extends GridPro_base {
      * @public
      */
     getSavedColumnState(): Promise<ColumnState[]>;
+    /**
+     * Deletes the saved column state for the current grid
+     * @param resetToDefault - Whether to reset columns to their default configuration. Defaults to true.
+     * @remarks This removes the persisted column state from storage, allowing the grid to use default column configuration
+     * @public
+     */
+    deleteColumnState(resetToDefault?: boolean): Promise<void>;
     private restoreColumnState;
     cacheFilterConfig(): void;
     restoreCachedFilterConfig(): Promise<void>;
@@ -2028,6 +2069,38 @@ export declare class GridPro extends GridPro_base {
     private addDatasourcePanels;
     private addPaginationPanel;
     protected setupPaginationAndStatusBar(gridOptions: GridOptions): void;
+    /**
+     * Handles column sizing based on sizeColumnsToContent and sizeColumnsToFit attributes
+     * @private
+     */
+    private handleColumnSizing;
+    /**
+     * Handles when both sizeColumnsToContent and sizeColumnsToFit are enabled
+     * @private
+     */
+    private handleBothSizingModes;
+    /**
+     * Handles individual sizing modes when only one is enabled
+     * @private
+     */
+    private handleIndividualSizingModes;
+    /**
+     * Calculates the total width of all columns
+     * @private
+     */
+    private calculateTotalColumnWidth;
+    /**
+     * Invalidates the cached column width calculation
+     * @private
+     * @remarks This method is called automatically when column changes occur (resize, move, pin, etc.)
+     * to ensure the cached width calculation remains accurate.
+     */
+    private invalidateColumnWidthCache;
+    /**
+     * Gets the available grid width with fallbacks
+     * @private
+     */
+    private getGridWidth;
     get observedAttributes(): string[];
     agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
     globalEventListener(eventType: any, event: any): void;
@@ -4046,6 +4119,7 @@ export declare class KVStorageStatePersistence implements StatePersistence {
     session: Session;
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    deleteColumnState(persistColumnStateKey: string): Promise<void>;
     private migrateLocalStorageToKVStorage;
     getFilterModel(persistFilterModelKey: string): Promise<{
         [key: string]: any;
@@ -4127,6 +4201,7 @@ export declare class LocalStorageStatePersistence implements StatePersistence {
     session: Session;
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    deleteColumnState(persistColumnStateKey: string): Promise<void>;
     getFilterModel(persistFilterModelKey: string): Promise<{
         [key: string]: any;
     }>;
@@ -4406,6 +4481,11 @@ export declare interface StatePersistence {
      * @public
      */
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    /**
+     * Deletes the column state for the given key.
+     * @public
+     */
+    deleteColumnState(persistColumnStateKey: string): Promise<void>;
     /**
      * Returns the filter model for the given key.
      * @public

package/docs/api/grid-pro.convertcoldefstocolumnstates.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [convertColDefsToColumnStates](./grid-pro.convertcoldefstocolumnstates.md)
+
+## convertColDefsToColumnStates() function
+
+Converts an array of ColDef to an array of ColumnState
+
+**Signature:**
+
+```typescript
+export declare function convertColDefsToColumnStates(colDefs: ColDef[]): ColumnState[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colDefs
+
+
+</td><td>
+
+ColDef\[\]
+
+
+</td><td>
+
+The column definitions to convert
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+ColumnState\[\]
+
+The corresponding ColumnState array
+

package/docs/api/grid-pro.convertcoldeftocolumnstate.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [convertColDefToColumnState](./grid-pro.convertcoldeftocolumnstate.md)
+
+## convertColDefToColumnState() function
+
+Converts a ColDef to a ColumnState
+
+**Signature:**
+
+```typescript
+export declare function convertColDefToColumnState(colDef: ColDef): ColumnState;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colDef
+
+
+</td><td>
+
+ColDef
+
+
+</td><td>
+
+The column definition to convert
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+ColumnState
+
+The corresponding ColumnState
+