@genesislcap/grid-pro 14.323.0 → 14.324.0

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

@@ -89,6 +89,8 @@ string
 
 </td><td>
 
+Groovy expression to perform filters on the query server; these remain active for the life of the subscription.
+
 
 </td></tr>
 <tr><td>
@@ -197,6 +199,8 @@ boolean
 
 </td><td>
 
+Disables polling if set to true (data updates for the grid will not be fetched automatically).
+
 
 </td></tr>
 <tr><td>
@@ -214,6 +218,8 @@ string
 
 </td><td>
 
+Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.
+
 
 </td></tr>
 <tr><td>
@@ -250,6 +256,8 @@ boolean
 
 </td><td>
 
+Request a snapshot from the server.
+
 
 </td></tr>
 <tr><td>
@@ -267,6 +275,8 @@ number
 
 </td><td>
 
+Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE\_ROWS messages.
+
 
 </td></tr>
 <tr><td>
@@ -284,6 +294,8 @@ number
 
 </td><td>
 
+Maximum number of rows to track as part of a client "view".
+
 
 </td></tr>
 <tr><td>
@@ -301,6 +313,27 @@ boolean
 
 </td><td>
 
+If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.
+
+
+</td></tr>
+<tr><td>
+
+[offset](./grid-pro.genesisgriddatasourceelement.offset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The offset for pagination in REQUEST\_SERVER scenarios.
+
 
 </td></tr>
 <tr><td>
@@ -318,6 +351,8 @@ string
 
 </td><td>
 
+Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.
+
 
 </td></tr>
 <tr><td>
@@ -335,6 +370,8 @@ number
 
 </td><td>
 
+Custom polling frequency (in milliseconds) for a Request Server resource.
+
 
 </td></tr>
 <tr><td>
@@ -352,6 +389,8 @@ string\[\]
 
 </td><td>
 
+Array of event names that will trigger a poll when received as commit responses.
+
 
 </td></tr>
 <tr><td>
@@ -369,6 +408,8 @@ any
 
 </td><td>
 
+Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.
+
 
 </td></tr>
 <tr><td>
@@ -405,6 +446,8 @@ string
 
 </td><td>
 
+The name of the target Data Server query or Request Server requestReply.
+
 
 </td></tr>
 <tr><td>
@@ -441,6 +484,8 @@ boolean
 
 </td><td>
 
+Option that changes the Data Server index iteration.
+
 
 </td></tr>
 <tr><td>
@@ -517,6 +562,8 @@ number
 
 </td><td>
 
+The desired view/page you want data from.
+
 
 </td></tr>
 </tbody></table>

package/docs/api/grid-pro.genesisgriddatasourceelement.movingview.md

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.movingView property
 
+If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.
+
 **Signature:**
 
 ```typescript
 movingView: boolean;
 ```
+
+## Remarks
+
+DATASERVER only. If false, the updates in the server will be sent to the front end regardless of order. Note that this will only update the UI; no changes will be performed in the database. Defaults to false.
+

package/docs/api/grid-pro.genesisgriddatasourceelement.offset.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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [offset](./grid-pro.genesisgriddatasourceelement.offset.md)
+
+## GenesisGridDatasourceElement.offset property
+
+The offset for pagination in REQUEST\_SERVER scenarios.
+
+**Signature:**
+
+```typescript
+offset: number;
+```
+
+## Remarks
+
+REQUEST\_SERVER only.
+

package/docs/api/grid-pro.genesisgriddatasourceelement.orderby.md

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.orderBy property
 
+Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.
+
 **Signature:**
 
 ```typescript
 orderBy: string;
 ```
+
+## Remarks
+
+By default, rows are returned in order of creation (from oldest database record to newest).
+

package/docs/api/grid-pro.genesisgriddatasourceelement.pollinginterval.md

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.pollingInterval property
 
+Custom polling frequency (in milliseconds) for a Request Server resource.
+
 **Signature:**
 
 ```typescript
 pollingInterval: number;
 ```
+
+## Remarks
+
+REQUEST\_SERVER only. Note that this option only works with Request Server resources; if your resource is a Data Server query, your grid is updated in real time. Defaults to 5000ms.
+

package/docs/api/grid-pro.genesisgriddatasourceelement.polltriggerevents.md

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.pollTriggerEvents property
 
+Array of event names that will trigger a poll when received as commit responses.
+
 **Signature:**
 
 ```typescript
 pollTriggerEvents: string[];
 ```
+
+## Remarks
+
+REQUEST\_SERVER only.
+

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

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.request property
 
+Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.
+
 **Signature:**
 
 ```typescript
 request: any;
 ```
+
+## Remarks
+
+REQUEST\_SERVER only.
+

package/docs/api/grid-pro.genesisgriddatasourceelement.resourcename.md

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.resourceName property
 
+The name of the target Data Server query or Request Server requestReply.
+
 **Signature:**
 
 ```typescript
 resourceName: string;
 ```
+
+## Remarks
+
+Required attribute.
+

package/docs/api/grid-pro.genesisgriddatasourceelement.reverse.md

@@ -4,8 +4,15 @@
 
 ## GenesisGridDatasourceElement.reverse property
 
+Option that changes the Data Server index iteration.
+
 **Signature:**
 
 ```typescript
 reverse: boolean;
 ```
+
+## Remarks
+
+DATASERVER only. For example, if you are using the default index, the query will return rows in order from the newest database records to the oldest. Defaults to false.
+

package/docs/api/grid-pro.genesisgriddatasourceelement.viewnumber.md

@@ -4,6 +4,8 @@
 
 ## GenesisGridDatasourceElement.viewNumber property
 
+The desired view/page you want data from.
+
 **Signature:**
 
 ```typescript

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

@@ -104,22 +104,20 @@ boolean
 </td></tr>
 <tr><td>
 
-[params](./grid-pro.gridproserversidedatasource.params.md)
+[pagingMode](./grid-pro.gridproserversidedatasource.pagingmode.md)
 
 
 </td><td>
 
-`readonly`
-
 
 </td><td>
 
-any
+[PagingMode](./grid-pro.pagingmode.md) \| undefined
 
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** The paging mode to use for data fetching.
 
 
 </td></tr>

package/docs/api/grid-pro.gridproserversidedatasource.pagingmode.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; [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.md

@@ -1656,6 +1656,17 @@ The parameters for the load more status bar component.
 The Genesis Datasource event payload types.
 
 
+</td></tr>
+<tr><td>
+
+[PagingMode](./grid-pro.pagingmode.md)
+
+
+</td><td>
+
+Available paging modes for server-side datasources
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/grid-pro.pagingmode.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; [PagingMode](./grid-pro.pagingmode.md)
+
+## PagingMode type
+
+Available paging modes for server-side datasources
+
+**Signature:**
+
+```typescript
+export type PagingMode = 'viewBased' | 'offsetBased';
+```
+
+## Remarks
+
+- This type defines the paging approach used for server-side data fetching - 'viewBased': Uses VIEW\_NUMBER and NEXT\_VIEW (1 by 1 increment) - 'offsetBased': Uses OFFSET and NEXT\_OFFSET (based on maxRows increment)
+

package/docs/api-report.md.api.md

@@ -787,7 +787,6 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
     clearErrors(): void;
     // (undocumented)
     connect: Connect;
-    // (undocumented)
     criteria: string;
     // (undocumented)
     protected criteriaFromFilters: Map<string, string>;
@@ -803,9 +802,7 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
     deferredColumnStates: ColumnState[];
     // (undocumented)
     deferredGridOptions: GridOptions;
-    // (undocumented)
     disablePolling: boolean;
-    // (undocumented)
     fields: string;
     // Warning: (ae-forgotten-export) The symbol "BaseDatasourceErrorEventDetail" needs to be exported by the entry point index.d.ts
     handleErrors(errors: string | any[], type?: BaseDatasourceErrorEventDetail['type']): void;
@@ -815,29 +812,20 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
     protected initializeDatasource(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
     // (undocumented)
     get isRequestServer(): boolean;
-    // (undocumented)
     isSnapshot: boolean;
-    // (undocumented)
     maxRows: number;
-    // (undocumented)
     maxView: number;
-    // (undocumented)
     movingView: boolean;
-    // (undocumented)
+    offset: number;
     orderBy: string;
-    // (undocumented)
     pollingInterval: number;
-    // (undocumented)
     pollTriggerEvents: string[];
     // (undocumented)
     removeFilter(fieldName: string): void;
-    // (undocumented)
     request: any;
     requestAutoSetup: boolean;
-    // (undocumented)
     resourceName: string;
     restartOnReconnection: boolean;
-    // (undocumented)
     reverse: boolean;
     rowDataMapper: Function;
     // @internal
@@ -847,7 +835,6 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
     setFilter(fieldName: string, newFilter: string): void;
     // (undocumented)
     protected update: BehaviorSubject<Map<string, string>>;
-    // (undocumented)
     viewNumber: number;
 }
 
@@ -1316,8 +1303,7 @@ export class GridProServerSideDatasource extends GridProServerSideDatasource_bas
     loadMore(): void;
     // (undocumented)
     onPaginationChanged(event: PaginationChangedEvent): void;
-    // (undocumented)
-    get params(): any;
+    pagingMode: PagingMode | undefined;
     reloadResourceData(params?: DatasourceOptions): Promise<void>;
     // (undocumented)
     request: any;
@@ -1572,6 +1558,9 @@ export class PaginationStatusBarComponent implements IStatusPanelComp {
     init(params: IStatusPanelParams): void;
 }
 
+// @public
+export type PagingMode = 'viewBased' | 'offsetBased';
+
 // @public
 export class ReloadStatusBarComponent implements IStatusPanelComp {
     // (undocumented)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "14.323.0",
+  "version": "14.324.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -38,19 +38,19 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.323.0",
-    "@genesislcap/genx": "14.323.0",
-    "@genesislcap/rollup-builder": "14.323.0",
-    "@genesislcap/ts-builder": "14.323.0",
-    "@genesislcap/uvu-playwright-builder": "14.323.0",
-    "@genesislcap/vite-builder": "14.323.0",
-    "@genesislcap/webpack-builder": "14.323.0"
+    "@genesislcap/foundation-testing": "14.324.0",
+    "@genesislcap/genx": "14.324.0",
+    "@genesislcap/rollup-builder": "14.324.0",
+    "@genesislcap/ts-builder": "14.324.0",
+    "@genesislcap/uvu-playwright-builder": "14.324.0",
+    "@genesislcap/vite-builder": "14.324.0",
+    "@genesislcap/webpack-builder": "14.324.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.323.0",
-    "@genesislcap/foundation-logger": "14.323.0",
-    "@genesislcap/foundation-ui": "14.323.0",
-    "@genesislcap/foundation-utils": "14.323.0",
+    "@genesislcap/foundation-comms": "14.324.0",
+    "@genesislcap/foundation-logger": "14.324.0",
+    "@genesislcap/foundation-ui": "14.324.0",
+    "@genesislcap/foundation-utils": "14.324.0",
     "@microsoft/fast-colors": "5.3.1",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
@@ -75,5 +75,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "08b2db7efcbbcc6498844c18a39c03187afa7cca"
+  "gitHead": "22f4afeb8817fd66d92f27f60408eaa2331ad070"
 }

package/docs/api/grid-pro.gridproserversidedatasource.params.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; [params](./grid-pro.gridproserversidedatasource.params.md)
-
-## GridProServerSideDatasource.params 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
-get params(): any;
-```