@genesislcap/grid-pro 14.141.3 → 14.142.1-alpha-a84f41b.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +2311 -950
- package/dist/dts/datasource/base.datasource.d.ts +60 -2
- package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.datasource.d.ts +19 -12
- package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +6 -66
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +3 -21
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/esm/datasource/base.datasource.js +193 -14
- package/dist/esm/datasource/server-side.datasource.js +69 -63
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +16 -156
- package/dist/esm/grid-pro.js +8 -1
- package/dist/grid-pro.api.json +188 -61
- package/dist/grid-pro.d.ts +93 -111
- package/docs/api/grid-pro.gridprogenesisdatasource.applyasyncfuncname.md +11 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.applyfuncname.md +11 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.applytransaction.md +22 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.applytransactionasync.md +23 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.md +4 -2
- package/docs/api-report.md +30 -16
- package/package.json +8 -8
- package/docs/api/grid-pro.gridprogenesisdatasource.rowdatamapper.md +0 -13
- package/docs/api/grid-pro.gridprogenesisdatasource.rowidattr.md +0 -15
package/dist/grid-pro.api.json
CHANGED
|
@@ -9482,6 +9482,194 @@
|
|
|
9482
9482
|
"name": "GridProGenesisDatasource",
|
|
9483
9483
|
"preserveMemberOrder": false,
|
|
9484
9484
|
"members": [
|
|
9485
|
+
{
|
|
9486
|
+
"kind": "Property",
|
|
9487
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyAsyncFuncName:member",
|
|
9488
|
+
"docComment": "",
|
|
9489
|
+
"excerptTokens": [
|
|
9490
|
+
{
|
|
9491
|
+
"kind": "Content",
|
|
9492
|
+
"text": "applyAsyncFuncName: "
|
|
9493
|
+
},
|
|
9494
|
+
{
|
|
9495
|
+
"kind": "Content",
|
|
9496
|
+
"text": "string"
|
|
9497
|
+
},
|
|
9498
|
+
{
|
|
9499
|
+
"kind": "Content",
|
|
9500
|
+
"text": ";"
|
|
9501
|
+
}
|
|
9502
|
+
],
|
|
9503
|
+
"isReadonly": false,
|
|
9504
|
+
"isOptional": false,
|
|
9505
|
+
"releaseTag": "Public",
|
|
9506
|
+
"name": "applyAsyncFuncName",
|
|
9507
|
+
"propertyTypeTokenRange": {
|
|
9508
|
+
"startIndex": 1,
|
|
9509
|
+
"endIndex": 2
|
|
9510
|
+
},
|
|
9511
|
+
"isStatic": false,
|
|
9512
|
+
"isProtected": false,
|
|
9513
|
+
"isAbstract": false
|
|
9514
|
+
},
|
|
9515
|
+
{
|
|
9516
|
+
"kind": "Property",
|
|
9517
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyFuncName:member",
|
|
9518
|
+
"docComment": "",
|
|
9519
|
+
"excerptTokens": [
|
|
9520
|
+
{
|
|
9521
|
+
"kind": "Content",
|
|
9522
|
+
"text": "applyFuncName: "
|
|
9523
|
+
},
|
|
9524
|
+
{
|
|
9525
|
+
"kind": "Content",
|
|
9526
|
+
"text": "string"
|
|
9527
|
+
},
|
|
9528
|
+
{
|
|
9529
|
+
"kind": "Content",
|
|
9530
|
+
"text": ";"
|
|
9531
|
+
}
|
|
9532
|
+
],
|
|
9533
|
+
"isReadonly": false,
|
|
9534
|
+
"isOptional": false,
|
|
9535
|
+
"releaseTag": "Public",
|
|
9536
|
+
"name": "applyFuncName",
|
|
9537
|
+
"propertyTypeTokenRange": {
|
|
9538
|
+
"startIndex": 1,
|
|
9539
|
+
"endIndex": 2
|
|
9540
|
+
},
|
|
9541
|
+
"isStatic": false,
|
|
9542
|
+
"isProtected": false,
|
|
9543
|
+
"isAbstract": false
|
|
9544
|
+
},
|
|
9545
|
+
{
|
|
9546
|
+
"kind": "Method",
|
|
9547
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyTransaction:member(1)",
|
|
9548
|
+
"docComment": "",
|
|
9549
|
+
"excerptTokens": [
|
|
9550
|
+
{
|
|
9551
|
+
"kind": "Content",
|
|
9552
|
+
"text": "applyTransaction(agTransaction: "
|
|
9553
|
+
},
|
|
9554
|
+
{
|
|
9555
|
+
"kind": "Reference",
|
|
9556
|
+
"text": "RowDataTransaction",
|
|
9557
|
+
"canonicalReference": "@ag-grid-community/core!RowDataTransaction:interface"
|
|
9558
|
+
},
|
|
9559
|
+
{
|
|
9560
|
+
"kind": "Content",
|
|
9561
|
+
"text": "): "
|
|
9562
|
+
},
|
|
9563
|
+
{
|
|
9564
|
+
"kind": "Reference",
|
|
9565
|
+
"text": "RowNodeTransaction",
|
|
9566
|
+
"canonicalReference": "@ag-grid-community/core!RowNodeTransaction:interface"
|
|
9567
|
+
},
|
|
9568
|
+
{
|
|
9569
|
+
"kind": "Content",
|
|
9570
|
+
"text": " | null | undefined"
|
|
9571
|
+
},
|
|
9572
|
+
{
|
|
9573
|
+
"kind": "Content",
|
|
9574
|
+
"text": ";"
|
|
9575
|
+
}
|
|
9576
|
+
],
|
|
9577
|
+
"isStatic": false,
|
|
9578
|
+
"returnTypeTokenRange": {
|
|
9579
|
+
"startIndex": 3,
|
|
9580
|
+
"endIndex": 5
|
|
9581
|
+
},
|
|
9582
|
+
"releaseTag": "Public",
|
|
9583
|
+
"isProtected": false,
|
|
9584
|
+
"overloadIndex": 1,
|
|
9585
|
+
"parameters": [
|
|
9586
|
+
{
|
|
9587
|
+
"parameterName": "agTransaction",
|
|
9588
|
+
"parameterTypeTokenRange": {
|
|
9589
|
+
"startIndex": 1,
|
|
9590
|
+
"endIndex": 2
|
|
9591
|
+
},
|
|
9592
|
+
"isOptional": false
|
|
9593
|
+
}
|
|
9594
|
+
],
|
|
9595
|
+
"isOptional": false,
|
|
9596
|
+
"isAbstract": false,
|
|
9597
|
+
"name": "applyTransaction"
|
|
9598
|
+
},
|
|
9599
|
+
{
|
|
9600
|
+
"kind": "Method",
|
|
9601
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyTransactionAsync:member(1)",
|
|
9602
|
+
"docComment": "",
|
|
9603
|
+
"excerptTokens": [
|
|
9604
|
+
{
|
|
9605
|
+
"kind": "Content",
|
|
9606
|
+
"text": "applyTransactionAsync(agTransaction: "
|
|
9607
|
+
},
|
|
9608
|
+
{
|
|
9609
|
+
"kind": "Reference",
|
|
9610
|
+
"text": "RowDataTransaction",
|
|
9611
|
+
"canonicalReference": "@ag-grid-community/core!RowDataTransaction:interface"
|
|
9612
|
+
},
|
|
9613
|
+
{
|
|
9614
|
+
"kind": "Content",
|
|
9615
|
+
"text": ", callback?: "
|
|
9616
|
+
},
|
|
9617
|
+
{
|
|
9618
|
+
"kind": "Content",
|
|
9619
|
+
"text": "(res: "
|
|
9620
|
+
},
|
|
9621
|
+
{
|
|
9622
|
+
"kind": "Reference",
|
|
9623
|
+
"text": "RowNodeTransaction",
|
|
9624
|
+
"canonicalReference": "@ag-grid-community/core!RowNodeTransaction:interface"
|
|
9625
|
+
},
|
|
9626
|
+
{
|
|
9627
|
+
"kind": "Content",
|
|
9628
|
+
"text": ") => void"
|
|
9629
|
+
},
|
|
9630
|
+
{
|
|
9631
|
+
"kind": "Content",
|
|
9632
|
+
"text": "): "
|
|
9633
|
+
},
|
|
9634
|
+
{
|
|
9635
|
+
"kind": "Content",
|
|
9636
|
+
"text": "void"
|
|
9637
|
+
},
|
|
9638
|
+
{
|
|
9639
|
+
"kind": "Content",
|
|
9640
|
+
"text": ";"
|
|
9641
|
+
}
|
|
9642
|
+
],
|
|
9643
|
+
"isStatic": false,
|
|
9644
|
+
"returnTypeTokenRange": {
|
|
9645
|
+
"startIndex": 7,
|
|
9646
|
+
"endIndex": 8
|
|
9647
|
+
},
|
|
9648
|
+
"releaseTag": "Public",
|
|
9649
|
+
"isProtected": false,
|
|
9650
|
+
"overloadIndex": 1,
|
|
9651
|
+
"parameters": [
|
|
9652
|
+
{
|
|
9653
|
+
"parameterName": "agTransaction",
|
|
9654
|
+
"parameterTypeTokenRange": {
|
|
9655
|
+
"startIndex": 1,
|
|
9656
|
+
"endIndex": 2
|
|
9657
|
+
},
|
|
9658
|
+
"isOptional": false
|
|
9659
|
+
},
|
|
9660
|
+
{
|
|
9661
|
+
"parameterName": "callback",
|
|
9662
|
+
"parameterTypeTokenRange": {
|
|
9663
|
+
"startIndex": 3,
|
|
9664
|
+
"endIndex": 6
|
|
9665
|
+
},
|
|
9666
|
+
"isOptional": true
|
|
9667
|
+
}
|
|
9668
|
+
],
|
|
9669
|
+
"isOptional": false,
|
|
9670
|
+
"isAbstract": false,
|
|
9671
|
+
"name": "applyTransactionAsync"
|
|
9672
|
+
},
|
|
9485
9673
|
{
|
|
9486
9674
|
"kind": "Property",
|
|
9487
9675
|
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#auth:member",
|
|
@@ -10142,67 +10330,6 @@
|
|
|
10142
10330
|
"isProtected": false,
|
|
10143
10331
|
"isAbstract": false
|
|
10144
10332
|
},
|
|
10145
|
-
{
|
|
10146
|
-
"kind": "Property",
|
|
10147
|
-
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#rowDataMapper:member",
|
|
10148
|
-
"docComment": "/**\n * Allows grid data updates to be processed via and external function before applying in grid\n */\n",
|
|
10149
|
-
"excerptTokens": [
|
|
10150
|
-
{
|
|
10151
|
-
"kind": "Content",
|
|
10152
|
-
"text": "rowDataMapper: "
|
|
10153
|
-
},
|
|
10154
|
-
{
|
|
10155
|
-
"kind": "Reference",
|
|
10156
|
-
"text": "Function",
|
|
10157
|
-
"canonicalReference": "!Function:interface"
|
|
10158
|
-
},
|
|
10159
|
-
{
|
|
10160
|
-
"kind": "Content",
|
|
10161
|
-
"text": ";"
|
|
10162
|
-
}
|
|
10163
|
-
],
|
|
10164
|
-
"isReadonly": false,
|
|
10165
|
-
"isOptional": false,
|
|
10166
|
-
"releaseTag": "Public",
|
|
10167
|
-
"name": "rowDataMapper",
|
|
10168
|
-
"propertyTypeTokenRange": {
|
|
10169
|
-
"startIndex": 1,
|
|
10170
|
-
"endIndex": 2
|
|
10171
|
-
},
|
|
10172
|
-
"isStatic": false,
|
|
10173
|
-
"isProtected": false,
|
|
10174
|
-
"isAbstract": false
|
|
10175
|
-
},
|
|
10176
|
-
{
|
|
10177
|
-
"kind": "Property",
|
|
10178
|
-
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#rowIdAttr:member",
|
|
10179
|
-
"docComment": "/**\n * Attribute to set an unique identifier for the row.\n *\n * Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.\n */\n",
|
|
10180
|
-
"excerptTokens": [
|
|
10181
|
-
{
|
|
10182
|
-
"kind": "Content",
|
|
10183
|
-
"text": "rowIdAttr: "
|
|
10184
|
-
},
|
|
10185
|
-
{
|
|
10186
|
-
"kind": "Content",
|
|
10187
|
-
"text": "any"
|
|
10188
|
-
},
|
|
10189
|
-
{
|
|
10190
|
-
"kind": "Content",
|
|
10191
|
-
"text": ";"
|
|
10192
|
-
}
|
|
10193
|
-
],
|
|
10194
|
-
"isReadonly": false,
|
|
10195
|
-
"isOptional": false,
|
|
10196
|
-
"releaseTag": "Public",
|
|
10197
|
-
"name": "rowIdAttr",
|
|
10198
|
-
"propertyTypeTokenRange": {
|
|
10199
|
-
"startIndex": 1,
|
|
10200
|
-
"endIndex": 2
|
|
10201
|
-
},
|
|
10202
|
-
"isStatic": false,
|
|
10203
|
-
"isProtected": false,
|
|
10204
|
-
"isAbstract": false
|
|
10205
|
-
},
|
|
10206
10333
|
{
|
|
10207
10334
|
"kind": "Method",
|
|
10208
10335
|
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#setFilter:member(1)",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -30,12 +30,18 @@ import { ICellRendererParams } from '@ag-grid-community/core';
|
|
|
30
30
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
31
31
|
import type { IServerSideDatasource } from '@ag-grid-community/core';
|
|
32
32
|
import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
|
|
33
|
+
import type { IServerSideRowModel } from '@ag-grid-community/core';
|
|
33
34
|
import { ITooltipComp } from '@ag-grid-community/core';
|
|
34
35
|
import { ITooltipParams } from '@ag-grid-community/core';
|
|
35
36
|
import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
|
|
36
37
|
import { Logger } from '@genesislcap/foundation-logger';
|
|
37
38
|
import { MetadataDetail } from '@genesislcap/foundation-comms';
|
|
38
39
|
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
|
40
|
+
import type { RowDataTransaction } from '@ag-grid-community/core';
|
|
41
|
+
import type { RowNodeTransaction } from '@ag-grid-community/core';
|
|
42
|
+
import type { ServerSideTransaction } from '@ag-grid-community/core';
|
|
43
|
+
import type { ServerSideTransactionResult } from '@ag-grid-community/core';
|
|
44
|
+
import { Session } from '@genesislcap/foundation-comms';
|
|
39
45
|
import { SocketObservable } from '@genesislcap/foundation-comms';
|
|
40
46
|
import { Swatch } from '@microsoft/fast-components';
|
|
41
47
|
import { SwatchRGB } from '@microsoft/fast-components';
|
|
@@ -932,6 +938,42 @@ declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
|
932
938
|
onChange?: (value: string, params: FuiCellRendererParams) => void;
|
|
933
939
|
}
|
|
934
940
|
|
|
941
|
+
declare class GenesisGridDatasourceElement extends FoundationElement {
|
|
942
|
+
connect: Connect;
|
|
943
|
+
session: Session;
|
|
944
|
+
deferredGridOptions: GridOptions;
|
|
945
|
+
deferredColumnStates: ColumnState[];
|
|
946
|
+
/**
|
|
947
|
+
* Allows grid data updates to be processed via and external function before applying in grid
|
|
948
|
+
*/
|
|
949
|
+
rowDataMapper: Function;
|
|
950
|
+
criteria: string;
|
|
951
|
+
fields: string;
|
|
952
|
+
isSnapshot: boolean;
|
|
953
|
+
maxRows: number;
|
|
954
|
+
maxView: number;
|
|
955
|
+
movingView: boolean;
|
|
956
|
+
orderBy: string;
|
|
957
|
+
resourceName: string;
|
|
958
|
+
reverse: boolean;
|
|
959
|
+
/**
|
|
960
|
+
* Attribute to set an unique identifier for the row.
|
|
961
|
+
*
|
|
962
|
+
* Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
|
|
963
|
+
* @privateRemarks Attribute-only, not to be used as a property. Use `rowId` getter instead.
|
|
964
|
+
*/
|
|
965
|
+
rowIdAttr: any;
|
|
966
|
+
protected get rowId(): string;
|
|
967
|
+
/**
|
|
968
|
+
* Returns whether the `row-id` attribute is the default one, depending on the resource type.
|
|
969
|
+
* @internal
|
|
970
|
+
*/
|
|
971
|
+
protected get hasDefaultRowId(): boolean;
|
|
972
|
+
protected get defaultRowIdByResourceType(): string;
|
|
973
|
+
protected isRequestServer: boolean;
|
|
974
|
+
protected get agGrid(): GridPro | null;
|
|
975
|
+
}
|
|
976
|
+
|
|
935
977
|
/**
|
|
936
978
|
* Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for Actions Menu Renderer.
|
|
937
979
|
* Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).
|
|
@@ -1471,27 +1513,9 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1471
1513
|
querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
|
|
1472
1514
|
querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
|
|
1473
1515
|
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
|
1474
|
-
querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
* @param columnDefs - The column definitions to apply to the grid.
|
|
1478
|
-
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
1479
|
-
* @returns The merged column definitions.
|
|
1480
|
-
*/
|
|
1481
|
-
querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>; /**
|
|
1482
|
-
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
1483
|
-
* @deprecated use `applyTemplateDefinitions` instead.
|
|
1484
|
-
* @param columnDefs - The column definitions to apply to the grid.
|
|
1485
|
-
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
1486
|
-
* @returns The merged column definitions.
|
|
1487
|
-
*/
|
|
1488
|
-
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>; /**
|
|
1489
|
-
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
1490
|
-
* @deprecated use `applyTemplateDefinitions` instead.
|
|
1491
|
-
* @param columnDefs - The column definitions to apply to the grid.
|
|
1492
|
-
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
1493
|
-
* @returns The merged column definitions.
|
|
1494
|
-
*/
|
|
1516
|
+
querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
|
|
1517
|
+
querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
|
|
1518
|
+
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
|
1495
1519
|
replaceChildren(...nodes: (string | Node)[]): void;
|
|
1496
1520
|
readonly assignedSlot: HTMLSlotElement;
|
|
1497
1521
|
oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
@@ -1601,19 +1625,27 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1601
1625
|
focus(options?: FocusOptions): void;
|
|
1602
1626
|
}) & typeof FoundationElement;
|
|
1603
1627
|
|
|
1604
|
-
declare class GridProBaseDatasource extends
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1628
|
+
declare class GridProBaseDatasource extends GenesisGridDatasourceElement {
|
|
1629
|
+
protected dataSubWasLoggedOff: boolean;
|
|
1630
|
+
rowData: Map<string, any>;
|
|
1631
|
+
protected agTransaction: RowDataTransaction | ServerSideTransaction;
|
|
1632
|
+
protected applyFuncName: string;
|
|
1633
|
+
protected applyAsyncFuncName: string;
|
|
1634
|
+
protected handleStreamInserts(insertedRows: any[]): void;
|
|
1635
|
+
protected handleStreamDeletes(deletedRows: any[]): void;
|
|
1636
|
+
protected handleStreamUpdates(updatedRows: any[]): void;
|
|
1637
|
+
protected applyAllAgTransactions(): void;
|
|
1638
|
+
private flashAddedCells;
|
|
1639
|
+
private applyMappedAgTransaction;
|
|
1640
|
+
protected applyTransaction(agTransaction: RowDataTransaction): any;
|
|
1641
|
+
protected applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: any) => void): void;
|
|
1642
|
+
/**
|
|
1643
|
+
* Maps the transaction data to the row data mapper function, if it exists.
|
|
1644
|
+
* @param transaction - The transaction data to be mapped.
|
|
1645
|
+
* @param operations - The operations to be mapped. Can be 'add', 'update' or 'remove'.
|
|
1646
|
+
* @returns The mapped transaction (if the row data mapper function exists), or the original transaction.
|
|
1647
|
+
*/
|
|
1648
|
+
private mapTransaction;
|
|
1617
1649
|
}
|
|
1618
1650
|
|
|
1619
1651
|
/**
|
|
@@ -1669,50 +1701,24 @@ export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSou
|
|
|
1669
1701
|
export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
|
|
1670
1702
|
auth: Auth;
|
|
1671
1703
|
datasource: Datasource;
|
|
1704
|
+
applyFuncName: string;
|
|
1705
|
+
applyAsyncFuncName: string;
|
|
1672
1706
|
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
1673
1707
|
pollingInterval: number;
|
|
1674
1708
|
disablePolling: boolean;
|
|
1675
1709
|
request: any;
|
|
1676
1710
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
1677
|
-
/**
|
|
1678
|
-
* Attribute to set an unique identifier for the row.
|
|
1679
|
-
*
|
|
1680
|
-
* Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
|
|
1681
|
-
* @privateRemarks Attribute-only, not to be used as a property. Use `rowId` getter instead.
|
|
1682
|
-
*/
|
|
1683
|
-
rowIdAttr: any;
|
|
1684
1711
|
restartOnReconnection: boolean;
|
|
1685
|
-
/**
|
|
1686
|
-
* Allows grid data updates to be processed via and external function before applying in grid
|
|
1687
|
-
*/
|
|
1688
|
-
rowDataMapper: Function;
|
|
1689
1712
|
private dataSub;
|
|
1690
1713
|
private updateSub;
|
|
1691
1714
|
private connectionSub;
|
|
1692
|
-
private isRequestServer;
|
|
1693
1715
|
private requiresFullRowDataAndColDefs;
|
|
1694
|
-
private dataSubWasLoggedOff;
|
|
1695
|
-
private rows;
|
|
1696
|
-
private agTransaction;
|
|
1697
1716
|
private sourceRef;
|
|
1698
1717
|
private criteriaFromFilters;
|
|
1699
1718
|
private update;
|
|
1700
1719
|
connectedCallback(): void;
|
|
1701
1720
|
disconnectedCallback(): void;
|
|
1702
1721
|
deepClone(): Node;
|
|
1703
|
-
private get agGrid();
|
|
1704
|
-
/**
|
|
1705
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
1706
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
1707
|
-
* @internal
|
|
1708
|
-
*/
|
|
1709
|
-
private get rowId();
|
|
1710
|
-
/**
|
|
1711
|
-
* Returns whether the `row-id` attribute is the default one, depending on the resource type.
|
|
1712
|
-
* @internal
|
|
1713
|
-
*/
|
|
1714
|
-
private get hasDefaultRowId();
|
|
1715
|
-
private get defaultRowIdByResourceType();
|
|
1716
1722
|
/**
|
|
1717
1723
|
* Initializes the datasource.
|
|
1718
1724
|
* @public
|
|
@@ -1779,23 +1785,12 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
1779
1785
|
private handleStreamResult;
|
|
1780
1786
|
private applyRequestServerData;
|
|
1781
1787
|
private applyDataserverData;
|
|
1782
|
-
private applyAllAgTransactions;
|
|
1783
|
-
private flashAddedCells;
|
|
1784
|
-
private applyMappedAgTransaction;
|
|
1785
|
-
/**
|
|
1786
|
-
* Maps the transaction data to the row data mapper function, if it exists.
|
|
1787
|
-
* @param transaction - The transaction data to be mapped.
|
|
1788
|
-
* @param operations - The operations to be mapped. Can be 'add', 'update' or 'remove'.
|
|
1789
|
-
* @returns The mapped transaction (if the row data mapper function exists), or the original transaction.
|
|
1790
|
-
*/
|
|
1791
|
-
private mapTransaction;
|
|
1792
|
-
private handleStreamInserts;
|
|
1793
|
-
private handleStreamDeletes;
|
|
1794
|
-
private handleStreamUpdates;
|
|
1795
1788
|
private getAgColumnDefs;
|
|
1796
1789
|
private buildCriteria;
|
|
1797
1790
|
setFilter(fieldName: string, newFilter: string): void;
|
|
1798
1791
|
removeFilter(fieldName: string): void;
|
|
1792
|
+
applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
|
|
1793
|
+
applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
|
|
1799
1794
|
}
|
|
1800
1795
|
|
|
1801
1796
|
declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
@@ -1813,11 +1808,6 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1813
1808
|
connectedCallback(): void;
|
|
1814
1809
|
readonly $fastController: Controller;
|
|
1815
1810
|
$emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
|
|
1816
|
-
/**
|
|
1817
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
1818
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
1819
|
-
* @internal
|
|
1820
|
-
*/
|
|
1821
1811
|
disconnectedCallback(): void;
|
|
1822
1812
|
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
1823
1813
|
accessKey: string;
|
|
@@ -1886,23 +1876,13 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1886
1876
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
1887
1877
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
1888
1878
|
hasAttribute(qualifiedName: string): boolean;
|
|
1889
|
-
/**
|
|
1890
|
-
* Sends a DATA_LOGOFF when the resource is an active stream
|
|
1891
|
-
* @remarks Will only happen for streaming DATASERER resources.
|
|
1892
|
-
* @internal
|
|
1893
|
-
*/
|
|
1894
1879
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
1895
1880
|
hasAttributes(): boolean;
|
|
1896
1881
|
hasPointerCapture(pointerId: number): boolean;
|
|
1897
1882
|
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
1898
1883
|
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
1899
1884
|
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
1900
|
-
matches(selectors: string): boolean;
|
|
1901
|
-
* Clears the rowData and columnDefs for the grid.
|
|
1902
|
-
* @remarks This is called when `reloadResourceData` happens, on criteria and filters change or full `reset`.
|
|
1903
|
-
* @param withColumnDefs - Whether to clear the columnDefs as well. Defaults to true.
|
|
1904
|
-
* @internal
|
|
1905
|
-
*/
|
|
1885
|
+
matches(selectors: string): boolean;
|
|
1906
1886
|
releasePointerCapture(pointerId: number): void;
|
|
1907
1887
|
removeAttribute(qualifiedName: string): void;
|
|
1908
1888
|
removeAttributeNS(namespace: string, localName: string): void;
|
|
@@ -2163,12 +2143,13 @@ export declare enum GridProRendererTypes {
|
|
|
2163
2143
|
* @alpha
|
|
2164
2144
|
*/
|
|
2165
2145
|
export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
|
|
2146
|
+
applyFuncName: string;
|
|
2147
|
+
applyAsyncFuncName: string;
|
|
2166
2148
|
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
2167
2149
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
2168
2150
|
pagination: boolean;
|
|
2169
|
-
rowId: string;
|
|
2170
2151
|
private indexes;
|
|
2171
|
-
private
|
|
2152
|
+
private ssrmDatasource;
|
|
2172
2153
|
private originalFieldDef;
|
|
2173
2154
|
connectedCallback(): void;
|
|
2174
2155
|
disconnectedCallback(): void;
|
|
@@ -2176,12 +2157,15 @@ export declare class GridProServerSideDatasource extends GridProServerSideDataso
|
|
|
2176
2157
|
init(): void;
|
|
2177
2158
|
reset(): void;
|
|
2178
2159
|
restart(): void;
|
|
2179
|
-
private get agGrid();
|
|
2180
2160
|
private clearRowData;
|
|
2181
2161
|
private getResourceIndexes;
|
|
2182
2162
|
get params(): any;
|
|
2163
|
+
get rowModel(): IServerSideRowModel;
|
|
2183
2164
|
private createDataserverStream;
|
|
2165
|
+
private handleStreamDeletesTemp;
|
|
2184
2166
|
private getAgColumnDefs;
|
|
2167
|
+
applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
|
|
2168
|
+
applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
|
|
2185
2169
|
}
|
|
2186
2170
|
|
|
2187
2171
|
declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
@@ -2335,6 +2319,11 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
2335
2319
|
readonly DOCUMENT_TYPE_NODE: number;
|
|
2336
2320
|
readonly ELEMENT_NODE: number;
|
|
2337
2321
|
readonly ENTITY_NODE: number;
|
|
2322
|
+
/**
|
|
2323
|
+
* A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
|
|
2324
|
+
* @remarks Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
|
|
2325
|
+
* @alpha
|
|
2326
|
+
*/
|
|
2338
2327
|
readonly ENTITY_REFERENCE_NODE: number;
|
|
2339
2328
|
readonly NOTATION_NODE: number;
|
|
2340
2329
|
readonly PROCESSING_INSTRUCTION_NODE: number;
|
|
@@ -2593,16 +2582,6 @@ export declare interface NumberEditorParams extends ICellEditorParams {
|
|
|
2593
2582
|
disabled: boolean;
|
|
2594
2583
|
}
|
|
2595
2584
|
|
|
2596
|
-
/**
|
|
2597
|
-
* The operation type for the {@link @genesislcap/grid-pro#GridProGenesisDatasource.mapTransaction} method.
|
|
2598
|
-
* @internal
|
|
2599
|
-
*/
|
|
2600
|
-
export declare enum OperationType {
|
|
2601
|
-
Add = "add",
|
|
2602
|
-
Update = "update",
|
|
2603
|
-
Remove = "remove"
|
|
2604
|
-
}
|
|
2605
|
-
|
|
2606
2585
|
declare interface SelectCellRendererParams extends ICellRendererParams {
|
|
2607
2586
|
accessor: string;
|
|
2608
2587
|
defaultValue?: string;
|
|
@@ -2663,11 +2642,16 @@ export declare class SelectRenderer extends FoundationElement implements ICellRe
|
|
|
2663
2642
|
selectionChanged: (e: any) => void;
|
|
2664
2643
|
}
|
|
2665
2644
|
|
|
2645
|
+
declare class StreamBaseDatasource {
|
|
2646
|
+
protected rowId: string;
|
|
2647
|
+
rowData: Map<string, any>;
|
|
2648
|
+
}
|
|
2649
|
+
|
|
2666
2650
|
/**
|
|
2667
2651
|
* The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
|
|
2668
2652
|
* @alpha
|
|
2669
2653
|
*/
|
|
2670
|
-
export declare class StreamDatasource implements IServerSideDatasource {
|
|
2654
|
+
export declare class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
|
|
2671
2655
|
auth: Auth;
|
|
2672
2656
|
connect: Connect;
|
|
2673
2657
|
dataserverStream: SocketObservable<FilteredDataServerResult>;
|
|
@@ -2683,27 +2667,25 @@ export declare class StreamDatasource implements IServerSideDatasource {
|
|
|
2683
2667
|
* The number of rows in the grid. THIS DO NOT CONSIDER CRITERIA_MATCH scenarios.
|
|
2684
2668
|
* @internal
|
|
2685
2669
|
*/
|
|
2686
|
-
|
|
2670
|
+
server_ROWS_COUNT: number;
|
|
2687
2671
|
/**
|
|
2688
2672
|
* The number of rows in the grid. THIS IS A LOCAL COUNT CONSIDERING CONSIDER CRITERIA_MATCH scenarios.
|
|
2689
2673
|
* @internal
|
|
2690
2674
|
*/
|
|
2691
|
-
|
|
2675
|
+
client_ROWS_COUNT: number;
|
|
2692
2676
|
private moreRows;
|
|
2693
2677
|
private calculatedRowsCount;
|
|
2694
2678
|
private lastSequenceId;
|
|
2695
2679
|
private currentFilterModel;
|
|
2696
2680
|
private originalCriteriaMatch;
|
|
2697
2681
|
private currentSortModel;
|
|
2698
|
-
private rowData;
|
|
2699
|
-
private agTransaction;
|
|
2700
|
-
private rowId;
|
|
2701
2682
|
constructor(options: StreamDatasourceOptions);
|
|
2702
2683
|
getRows(params: IServerSideGetRowsParams): Promise<void>;
|
|
2684
|
+
private sortMapByNumericKey;
|
|
2703
2685
|
private dataLogoff;
|
|
2704
2686
|
private restartSubscription;
|
|
2705
2687
|
private getOrderByAndToBeSortedColIds;
|
|
2706
|
-
private
|
|
2688
|
+
private handleCurrentStreamLoad;
|
|
2707
2689
|
private buildCriteriaMatchFromFilters;
|
|
2708
2690
|
private criteriaFromFilters;
|
|
2709
2691
|
private getFiltersByType;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) > [applyAsyncFuncName](./grid-pro.gridprogenesisdatasource.applyasyncfuncname.md)
|
|
4
|
+
|
|
5
|
+
## GridProGenesisDatasource.applyAsyncFuncName property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
applyAsyncFuncName: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) > [applyFuncName](./grid-pro.gridprogenesisdatasource.applyfuncname.md)
|
|
4
|
+
|
|
5
|
+
## GridProGenesisDatasource.applyFuncName property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
applyFuncName: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) > [applyTransaction](./grid-pro.gridprogenesisdatasource.applytransaction.md)
|
|
4
|
+
|
|
5
|
+
## GridProGenesisDatasource.applyTransaction() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| agTransaction | RowDataTransaction | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
RowNodeTransaction \| null \| undefined
|
|
22
|
+
|