@genesislcap/grid-pro 14.408.0 → 14.409.0

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

@@ -1,351 +0,0 @@
-<!-- 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)
-
-## GridProServerSideDatasource class
-
-> 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.
-> 
-
-A Genesis Datasource element, for server-side \| SSRM-compatible data fetching and used exclusively by the GridPro element.
-
-**Signature:**
-
-```typescript
-export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base 
-```
-**Extends:** GridProServerSideDatasource\_base
-
-## Remarks
-
-Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
-
-\*\*Custom Sort Indicators\*\*: This datasource automatically applies custom sort indicators that are always visible (instead of only on hover). Sortable columns will show a subtle sort icon even when not sorted, and active sort indicators will be more prominent. The custom styling uses AG Grid's native icon font for consistency with the grid theme.
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[liveUpdates](./grid-pro.gridproserversidedatasource.liveupdates.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(BETA)_** Enable live updates for the grid.
-
-
-</td></tr>
-<tr><td>
-
-[pagingMode](./grid-pro.gridproserversidedatasource.pagingmode.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[PagingMode](./grid-pro.pagingmode.md) \| undefined
-
-
-</td><td>
-
-**_(BETA)_** The paging mode to use for data fetching.
-
-
-</td></tr>
-<tr><td>
-
-[pollingDatasource](./grid-pro.gridproserversidedatasource.pollingdatasource.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Datasource
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[request](./grid-pro.gridproserversidedatasource.request.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[serializer](./grid-pro.gridproserversidedatasource.serializer.md)
-
-
-</td><td>
-
-
-</td><td>
-
-JSONSerializer
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[zeroBasedViewNumber](./grid-pro.gridproserversidedatasource.zerobasedviewnumber.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(BETA)_** The starting VIEW\_NUMBER of the data to be fetched.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[applyTransaction(transaction)](./grid-pro.gridproserversidedatasource.applytransaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[connectedCallback()](./grid-pro.gridproserversidedatasource.connectedcallback.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[criteriaChanged(oldCriteria, newCriteria)](./grid-pro.gridproserversidedatasource.criteriachanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[deepClone()](./grid-pro.gridproserversidedatasource.deepclone.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./grid-pro.gridproserversidedatasource.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[disconnectedCallback()](./grid-pro.gridproserversidedatasource.disconnectedcallback.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[init()](./grid-pro.gridproserversidedatasource.init.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[loadMore()](./grid-pro.gridproserversidedatasource.loadmore.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[onPaginationChanged(event)](./grid-pro.gridproserversidedatasource.onpaginationchanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[reloadResourceData(params)](./grid-pro.gridproserversidedatasource.reloadresourcedata.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Resets the grid data while keeping columnDefs and reloads data.
-
-
-</td></tr>
-<tr><td>
-
-[resourceNameChanged(oldValue, newValue)](./grid-pro.gridproserversidedatasource.resourcenamechanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[restart()](./grid-pro.gridproserversidedatasource.restart.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,53 +0,0 @@
-<!-- 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; [onPaginationChanged](./grid-pro.gridproserversidedatasource.onpaginationchanged.md)
-
-## GridProServerSideDatasource.onPaginationChanged() 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
-onPaginationChanged(event: any): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-event
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,21 +0,0 @@
-<!-- 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; [pagingMode](./grid-pro.gridproserversidedatasource.pagingmode.md)
-
-## GridProServerSideDatasource.pagingMode 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.
-> 
-
-The paging mode to use for data fetching.
-
-**Signature:**
-
-```typescript
-pagingMode: PagingMode | undefined;
-```
-
-## Remarks
-
-- "viewBased": Uses VIEW\_NUMBER and NEXT\_VIEW (1 by 1 increment) - "offsetBased": Uses OFFSET and NEXT\_OFFSET (based on maxRows increment) - undefined: Auto-determines based on criteriaOnlyRequest availability
-

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

@@ -1,14 +0,0 @@
-<!-- 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; [pollingDatasource](./grid-pro.gridproserversidedatasource.pollingdatasource.md)
-
-## GridProServerSideDatasource.pollingDatasource 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
-pollingDatasource: Datasource;
-```

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

@@ -1,61 +0,0 @@
-<!-- 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; [reloadResourceData](./grid-pro.gridproserversidedatasource.reloadresourcedata.md)
-
-## GridProServerSideDatasource.reloadResourceData() 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.
-> 
-
-Resets the grid data while keeping columnDefs and reloads data.
-
-**Signature:**
-
-```typescript
-reloadResourceData(params?: DatasourceOptions): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-DatasourceOptions
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-
-## Remarks
-
-This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
-

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

@@ -1,14 +0,0 @@
-<!-- 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; [request](./grid-pro.gridproserversidedatasource.request.md)
-
-## GridProServerSideDatasource.request 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
-request: any;
-```

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

@@ -1,67 +0,0 @@
-<!-- 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; [resourceNameChanged](./grid-pro.gridproserversidedatasource.resourcenamechanged.md)
-
-## GridProServerSideDatasource.resourceNameChanged() 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
-resourceNameChanged(oldValue: string, newValue: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-oldValue
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-newValue
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [restart](./grid-pro.gridproserversidedatasource.restart.md)
-
-## GridProServerSideDatasource.restart() 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
-restart(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

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

@@ -1,14 +0,0 @@
-<!-- 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; [serializer](./grid-pro.gridproserversidedatasource.serializer.md)
-
-## GridProServerSideDatasource.serializer 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
-serializer: JSONSerializer;
-```

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

@@ -1,21 +0,0 @@
-<!-- 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; [zeroBasedViewNumber](./grid-pro.gridproserversidedatasource.zerobasedviewnumber.md)
-
-## GridProServerSideDatasource.zeroBasedViewNumber 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.
-> 
-
-The starting VIEW\_NUMBER of the data to be fetched.
-
-**Signature:**
-
-```typescript
-zeroBasedViewNumber: boolean;
-```
-
-## Remarks
-
-The VIEW\_NUMBER isincremented by the grid as the user scrolls or changes pages.
-

package/docs/api/grid-pro.gridprostatusbarconfig.aggregation.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) &gt; [aggregation](./grid-pro.gridprostatusbarconfig.aggregation.md)
-
-## GridProStatusBarConfig.aggregation property
-
-Enable aggregation status bar component.
-
-**Signature:**
-
-```typescript
-aggregation?: boolean;
-```
-
-## Remarks
-
-Default is true. Shows aggregation values for selected columns.
-

package/docs/api/grid-pro.gridprostatusbarconfig.loadmore.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) &gt; [loadMore](./grid-pro.gridprostatusbarconfig.loadmore.md)
-
-## GridProStatusBarConfig.loadMore property
-
-Configure load more button status bar component.
-
-**Signature:**
-
-```typescript
-loadMore?: boolean | GridProStatusBarLoadMoreConfig;
-```
-
-## Remarks
-
-Can be boolean for simple enable/disable or object for detailed configuration.
-

package/docs/api/grid-pro.gridprostatusbarconfig.maxrows.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) &gt; [maxRows](./grid-pro.gridprostatusbarconfig.maxrows.md)
-
-## GridProStatusBarConfig.maxRows property
-
-Enable max rows status bar component.
-
-**Signature:**
-
-```typescript
-maxRows?: boolean;
-```
-
-## Remarks
-
-Default is false.
-