@genesislcap/grid-pro 14.348.0 → 14.350.0

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

@@ -47,44 +47,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[applyAsyncFuncName](./grid-pro.gridproserversidedatasource.applyasyncfuncname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[applyFuncName](./grid-pro.gridproserversidedatasource.applyfuncname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
 [liveUpdates](./grid-pro.gridproserversidedatasource.liveupdates.md)
 
 
@@ -139,27 +101,6 @@ any
 **_(BETA)_**
 
 
-</td></tr>
-<tr><td>
-
-[rowModel](./grid-pro.gridproserversidedatasource.rowmodel.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-IServerSideRowModel
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 
@@ -202,21 +143,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[applyTransaction(agTransaction)](./grid-pro.gridproserversidedatasource.applytransaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[applyTransactionAsync(agTransaction, callback)](./grid-pro.gridproserversidedatasource.applytransactionasync.md)
+[applyTransaction(transaction)](./grid-pro.gridproserversidedatasource.applytransaction.md)
 
 
 </td><td>

package/docs/api/grid-pro.gridproserversidedatasource.onpaginationchanged.md

@@ -10,7 +10,7 @@
 **Signature:**
 
 ```typescript
-onPaginationChanged(event: PaginationChangedEvent): void;
+onPaginationChanged(event: any): void;
 ```
 
 ## Parameters
@@ -38,7 +38,7 @@ event
 
 </td><td>
 
-PaginationChangedEvent
+any
 
 
 </td><td>

package/docs/api/{grid-pro.gridproserversidedatasource.rowmodel.md → grid-pro.gridprov34._constructor_.md}

@@ -1,14 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [rowModel](./grid-pro.gridproserversidedatasource.rowmodel.md)
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [(constructor)](./grid-pro.gridprov34._constructor_.md)
 
-## GridProServerSideDatasource.rowModel property
+## GridProV34.(constructor)
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
+Constructs a new instance of the `GridProV34` class
+
 **Signature:**
 
 ```typescript
-get rowModel(): IServerSideRowModel;
+constructor();
 ```

package/docs/api/grid-pro.gridprov34.addeventlistener.md

@@ -0,0 +1,89 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [addEventListener](./grid-pro.gridprov34.addeventlistener.md)
+
+## GridProV34.addEventListener() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Adds an event listener to the grid element.
+
+**Signature:**
+
+```typescript
+addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The event type to listen for. Recommened to use the `Events` from AG Grid.
+
+
+</td></tr>
+<tr><td>
+
+listener
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+The event listener to call when the event is fired.
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+boolean \| AddEventListenerOptions
+
+
+</td><td>
+
+_(Optional)_ An options object that specifies characteristics about the event listener.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/{grid-pro.gridproserversidedatasource.applyfuncname.md → grid-pro.gridprov34.aggrid.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [applyFuncName](./grid-pro.gridproserversidedatasource.applyfuncname.md)
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [agGrid](./grid-pro.gridprov34.aggrid.md)
 
-## GridProServerSideDatasource.applyFuncName property
+## GridProV34.agGrid property
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
@@ -10,5 +10,5 @@
 **Signature:**
 
 ```typescript
-applyFuncName: string;
+agGrid: GridApi;
 ```

package/docs/api/{grid-pro.gridproserversidedatasource.applyasyncfuncname.md → grid-pro.gridprov34.aggridoptions.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [applyAsyncFuncName](./grid-pro.gridproserversidedatasource.applyasyncfuncname.md)
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [agGridOptions](./grid-pro.gridprov34.aggridoptions.md)
 
-## GridProServerSideDatasource.applyAsyncFuncName property
+## GridProV34.agGridOptions property
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
@@ -10,5 +10,5 @@
 **Signature:**
 
 ```typescript
-applyAsyncFuncName: string;
+protected agGridOptions: GridOptions;
 ```

package/docs/api/grid-pro.gridprov34.autocellrendererbytype.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [autoCellRendererByType](./grid-pro.gridprov34.autocellrendererbytype.md)
+
+## GridProV34.autoCellRendererByType property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+autoCellRendererByType: boolean;
+```

package/docs/api/grid-pro.gridprov34.cachefilterconfig.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [cacheFilterConfig](./grid-pro.gridprov34.cachefilterconfig.md)
+
+## GridProV34.cacheFilterConfig() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+cacheFilterConfig(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/grid-pro.gridprov34.classnames.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [classNames](./grid-pro.gridprov34.classnames.md)
+
+## GridProV34.classNames property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+classNames: string;
+```

package/docs/api/grid-pro.gridprov34.clearlocalgridoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [clearLocalGridOptions](./grid-pro.gridprov34.clearlocalgridoptions.md)
+
+## GridProV34.clearLocalGridOptions() method
+
+Clears the local grid options, this is used to clear the grid options when the grid is restarted.
+
+**Signature:**
+
+```typescript
+clearLocalGridOptions(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/grid-pro.gridprov34.columncomponentname.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [columnComponentName](./grid-pro.gridprov34.columncomponentname.md)
+
+## GridProV34.columnComponentName property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+columnComponentName: string;
+```

package/docs/api/grid-pro.gridprov34.combineallgridcomponents.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [combineAllGridComponents](./grid-pro.gridprov34.combineallgridcomponents.md)
+
+## GridProV34.combineAllGridComponents() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+combineAllGridComponents(gridOptionsComponents: GridComponents): GridComponents;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+gridOptionsComponents
+
+
+</td><td>
+
+[GridComponents](./grid-pro.gridcomponents.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[GridComponents](./grid-pro.gridcomponents.md)
+

package/docs/api/grid-pro.gridprov34.connectedcallback.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [connectedCallback](./grid-pro.gridprov34.connectedcallback.md)
+
+## GridProV34.connectedCallback() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+connectedCallback(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/grid-pro.gridprov34.customerrorhandlertemplate.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [customErrorHandlerTemplate](./grid-pro.gridprov34.customerrorhandlertemplate.md)
+
+## GridProV34.customErrorHandlerTemplate property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Custom error handler dialog template function.
+
+**Signature:**
+
+```typescript
+customErrorHandlerTemplate?: (prefix: string, gridErrorItems: GridProErrorItem<any>[]) => ViewTemplate;
+```
+
+## Remarks
+
+When provided, this function will be used to render custom error dialogs instead of the default error handler. The function should accept a prefix string and an array of grid error items and return a ViewTemplate. If not provided, the default error handler dialog template will be used.
+

package/docs/api/grid-pro.gridprov34.disconnectedcallback.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [disconnectedCallback](./grid-pro.gridprov34.disconnectedcallback.md)
+
+## GridProV34.disconnectedCallback() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+disconnectedCallback(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/grid-pro.gridprov34.enablecellflashing.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [enableCellFlashing](./grid-pro.gridprov34.enablecellflashing.md)
+
+## GridProV34.enableCellFlashing property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
+
+**Signature:**
+
+```typescript
+enableCellFlashing: boolean;
+```
+
+## Remarks
+
+Defaults to true
+

package/docs/api/grid-pro.gridprov34.enablerowflashing.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [enableRowFlashing](./grid-pro.gridprov34.enablerowflashing.md)
+
+## GridProV34.enableRowFlashing property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+If true, will enable row flashing for all rows for `add` async transactions
+
+**Signature:**
+
+```typescript
+enableRowFlashing: boolean;
+```

package/docs/api/grid-pro.gridprov34.eventsandcallbacks.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [eventsAndCallbacks](./grid-pro.gridprov34.eventsandcallbacks.md)
+
+## GridProV34.eventsAndCallbacks property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+eventsAndCallbacks: GridProEventsAndCallbacks;
+```

package/docs/api/grid-pro.gridprov34.getfiltermodel.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [getfilterModel](./grid-pro.gridprov34.getfiltermodel.md)
+
+## GridProV34.getfilterModel() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+getfilterModel(): Promise<{
+        [key: string]: any;
+    }>;
+```
+**Returns:**
+
+Promise&lt;{ \[key: string\]: any; }&gt;
+

package/docs/api/grid-pro.gridprov34.getsavedcolumnstate.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [getSavedColumnState](./grid-pro.gridprov34.getsavedcolumnstate.md)
+
+## GridProV34.getSavedColumnState() method
+
+Gets the saved grid ColumnState\[\] from storage
+
+**Signature:**
+
+```typescript
+getSavedColumnState(): Promise<ColumnState[]>;
+```
+**Returns:**
+
+Promise&lt;ColumnState\[\]&gt;
+
+## Remarks
+
+This is used to restore the grid state when the grid is rehydrated
+

package/docs/api/grid-pro.gridprov34.getselectedrows.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [getSelectedRows](./grid-pro.gridprov34.getselectedrows.md)
+
+## GridProV34.getSelectedRows() method
+
+Gets the currently selected rows from the grid
+
+**Signature:**
+
+```typescript
+getSelectedRows(): any[];
+```
+**Returns:**
+
+any\[\]
+
+Array of selected row data
+

package/docs/api/{grid-pro.gridproserversidedatasource.applytransactionasync.md → grid-pro.gridprov34.globaleventlistener.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [applyTransactionAsync](./grid-pro.gridproserversidedatasource.applytransactionasync.md)
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [globalEventListener](./grid-pro.gridprov34.globaleventlistener.md)
 
-## GridProServerSideDatasource.applyTransactionAsync() method
+## GridProV34.globalEventListener() method
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
@@ -10,7 +10,7 @@
 **Signature:**
 
 ```typescript
-applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
+globalEventListener(eventType: any, event: any): void;
 ```
 
 ## Parameters
@@ -33,12 +33,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-agTransaction
+eventType
 
 
 </td><td>
 
-RowDataTransaction
+any
 
 
 </td><td>
@@ -47,18 +47,16 @@ RowDataTransaction
 </td></tr>
 <tr><td>
 
-callback
+event
 
 
 </td><td>
 
-(res: ServerSideTransactionResult) =&gt; void
+any
 
 
 </td><td>
 
-_(Optional)_
-
 
 </td></tr>
 </tbody></table>

package/docs/api/grid-pro.gridprov34.gridapi.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [gridApi](./grid-pro.gridprov34.gridapi.md)
+
+## GridProV34.gridApi property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+gridApi: GridApi;
+```

package/docs/api/grid-pro.gridprov34.gridautosizingenabled.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md) &gt; [gridAutosizingEnabled](./grid-pro.gridprov34.gridautosizingenabled.md)
+
+## GridProV34.gridAutosizingEnabled property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using `persist-column-state-key`<!-- -->.
+
+**Signature:**
+
+```typescript
+gridAutosizingEnabled: boolean;
+```