@genesislcap/grid-pro 14.149.0 → 14.150.1-alpha-28e6b6f.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 +72 -0
- package/dist/dts/datasource/server-side.datasource.d.ts +0 -5
- package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
- package/dist/dts/utils/index.d.ts +1 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/dts/utils/map.d.ts +17 -0
- package/dist/dts/utils/map.d.ts.map +1 -0
- package/dist/esm/datasource/server-side.datasource.js +27 -19
- package/dist/esm/utils/index.js +1 -0
- package/dist/esm/utils/map.js +39 -0
- package/dist/grid-pro.api.json +100 -0
- package/dist/grid-pro.d.ts +18 -5
- package/docs/api/grid-pro.getavailableindexes.md +30 -0
- package/docs/api/grid-pro.getavailableindexfields.md +30 -0
- package/docs/api/grid-pro.md +2 -0
- package/docs/api-report.md +6 -0
- package/package.json +13 -13
|
@@ -10623,6 +10623,14 @@
|
|
|
10623
10623
|
"package": "./logger"
|
|
10624
10624
|
}
|
|
10625
10625
|
},
|
|
10626
|
+
{
|
|
10627
|
+
"kind": "js",
|
|
10628
|
+
"name": "*",
|
|
10629
|
+
"declaration": {
|
|
10630
|
+
"name": "*",
|
|
10631
|
+
"package": "./map"
|
|
10632
|
+
}
|
|
10633
|
+
},
|
|
10626
10634
|
{
|
|
10627
10635
|
"kind": "js",
|
|
10628
10636
|
"name": "*",
|
|
@@ -10655,6 +10663,70 @@
|
|
|
10655
10663
|
}
|
|
10656
10664
|
]
|
|
10657
10665
|
},
|
|
10666
|
+
{
|
|
10667
|
+
"kind": "javascript-module",
|
|
10668
|
+
"path": "src/utils/map.ts",
|
|
10669
|
+
"declarations": [
|
|
10670
|
+
{
|
|
10671
|
+
"kind": "function",
|
|
10672
|
+
"name": "getAvailableIndexes",
|
|
10673
|
+
"return": {
|
|
10674
|
+
"type": {
|
|
10675
|
+
"text": ""
|
|
10676
|
+
}
|
|
10677
|
+
},
|
|
10678
|
+
"parameters": [
|
|
10679
|
+
{
|
|
10680
|
+
"name": "data",
|
|
10681
|
+
"type": {
|
|
10682
|
+
"text": "Map<string, [string]>"
|
|
10683
|
+
},
|
|
10684
|
+
"description": "the map data to have the keys extracted from"
|
|
10685
|
+
}
|
|
10686
|
+
],
|
|
10687
|
+
"description": "Get the keys of the Metadata indexes map",
|
|
10688
|
+
"privacy": "public"
|
|
10689
|
+
},
|
|
10690
|
+
{
|
|
10691
|
+
"kind": "function",
|
|
10692
|
+
"name": "getAvailableIndexFields",
|
|
10693
|
+
"return": {
|
|
10694
|
+
"type": {
|
|
10695
|
+
"text": ""
|
|
10696
|
+
}
|
|
10697
|
+
},
|
|
10698
|
+
"parameters": [
|
|
10699
|
+
{
|
|
10700
|
+
"name": "data",
|
|
10701
|
+
"type": {
|
|
10702
|
+
"text": "Map<string, [string]>"
|
|
10703
|
+
},
|
|
10704
|
+
"description": "the map data to have the values extracted from"
|
|
10705
|
+
}
|
|
10706
|
+
],
|
|
10707
|
+
"description": "Get the values of the Metadata indexes map",
|
|
10708
|
+
"privacy": "public"
|
|
10709
|
+
}
|
|
10710
|
+
],
|
|
10711
|
+
"exports": [
|
|
10712
|
+
{
|
|
10713
|
+
"kind": "js",
|
|
10714
|
+
"name": "getAvailableIndexes",
|
|
10715
|
+
"declaration": {
|
|
10716
|
+
"name": "getAvailableIndexes",
|
|
10717
|
+
"module": "src/utils/map.ts"
|
|
10718
|
+
}
|
|
10719
|
+
},
|
|
10720
|
+
{
|
|
10721
|
+
"kind": "js",
|
|
10722
|
+
"name": "getAvailableIndexFields",
|
|
10723
|
+
"declaration": {
|
|
10724
|
+
"name": "getAvailableIndexFields",
|
|
10725
|
+
"module": "src/utils/map.ts"
|
|
10726
|
+
}
|
|
10727
|
+
}
|
|
10728
|
+
]
|
|
10729
|
+
},
|
|
10658
10730
|
{
|
|
10659
10731
|
"kind": "javascript-module",
|
|
10660
10732
|
"path": "src/utils/sanitasations.ts",
|
|
@@ -212,11 +212,6 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
212
212
|
readonly DOCUMENT_TYPE_NODE: number;
|
|
213
213
|
readonly ELEMENT_NODE: number;
|
|
214
214
|
readonly ENTITY_NODE: number;
|
|
215
|
-
/**
|
|
216
|
-
* A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
|
|
217
|
-
* @remarks Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
|
|
218
|
-
* @alpha
|
|
219
|
-
*/
|
|
220
215
|
readonly ENTITY_REFERENCE_NODE: number;
|
|
221
216
|
readonly NOTATION_NODE: number;
|
|
222
217
|
readonly PROCESSING_INSTRUCTION_NODE: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server-side.datasource.d.ts","sourceRoot":"","sources":["../../../src/datasource/server-side.datasource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EAEnB,kBAAkB,EAClB,2BAA2B,EAG5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,IAAI,EACJ,OAAO,EAKP,wBAAwB,EAIxB,cAAc,EAGd,gBAAgB,EAEjB,MAAM,+BAA+B,CAAC;AAQvC,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAOhF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IACxC,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IAEnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,oBAAqB,YAAW,qBAAqB;IACnF,IAAI,EAAG,IAAI,CAAC;IACT,OAAO,EAAG,OAAO,CAAC;IAE3B,gBAAgB,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;IAC7D,OAAO,CAAC,YAAY,CAAS;IAC7B,cAAc,EAAE,GAAG,CAAC;IACpB,OAAO,CAAC,eAAe,CAAwB;IAC/C,OAAO,CAAC,eAAe,CAAmB;IAE1C,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAU;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,SAAK;IAEtB;;;OAGG;IACH,iBAAiB,SAAK;IAEtB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,cAAc,CAAK;IAE3B,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,qBAAqB,CAAoB;IACjD,OAAO,CAAC,gBAAgB,CAAkB;gBAE9B,OAAO,EAAE,uBAAuB;IAiBtC,OAAO,CAAC,MAAM,EAAE,wBAAwB;
|
|
1
|
+
{"version":3,"file":"server-side.datasource.d.ts","sourceRoot":"","sources":["../../../src/datasource/server-side.datasource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EAEnB,kBAAkB,EAClB,2BAA2B,EAG5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,IAAI,EACJ,OAAO,EAKP,wBAAwB,EAIxB,cAAc,EAGd,gBAAgB,EAEjB,MAAM,+BAA+B,CAAC;AAQvC,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAOhF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IACxC,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IAEnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,oBAAqB,YAAW,qBAAqB;IACnF,IAAI,EAAG,IAAI,CAAC;IACT,OAAO,EAAG,OAAO,CAAC;IAE3B,gBAAgB,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;IAC7D,OAAO,CAAC,YAAY,CAAS;IAC7B,cAAc,EAAE,GAAG,CAAC;IACpB,OAAO,CAAC,eAAe,CAAwB;IAC/C,OAAO,CAAC,eAAe,CAAmB;IAE1C,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAU;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,SAAK;IAEtB;;;OAGG;IACH,iBAAiB,SAAK;IAEtB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,cAAc,CAAK;IAE3B,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,qBAAqB,CAAoB;IACjD,OAAO,CAAC,gBAAgB,CAAkB;gBAE9B,OAAO,EAAE,uBAAuB;IAiBtC,OAAO,CAAC,MAAM,EAAE,wBAAwB;IA+H9C,OAAO,CAAC,mBAAmB;IAU3B,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,6BAA6B;IAWrC,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,6BAA6B;IAmBrC,OAAO,CAAC,mBAAmB;IA6D3B,OAAO,CAAC,gBAAgB;CAKzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAID;;;;GAIG;AACH,qBAGa,2BAA4B,SAAQ,gCAAqC;IACpF,aAAa,SAAgC;IAC7C,kBAAkB,SAAqC;IAEvD,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAWxD,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAK3B,UAAU,UAAS;IAE9C,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,cAAc,CAAmB;IACzC,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,iBAAiB;IASjB,oBAAoB;IASX,SAAS,IAAI,IAAI;IAO1B,IAAI;IAsEJ,KAAK;IAOL,OAAO;IAKP,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,kBAAkB;IAU1B,IAAI,MAAM,QA2BT;IAED,IAAI,QAAQ,IAAI,mBAAmB,CAElC;YAEa,sBAAsB;IAoCpC,OAAO,CAAC,uBAAuB;IAU/B,OAAO,CAAC,eAAe;IA6Dd,gBAAgB,CAAC,aAAa,EAAE,kBAAkB,GAAG,2BAA2B;IAIhF,qBAAqB,CAC5B,aAAa,EAAE,kBAAkB,EACjC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI;CAIxD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,iBAAiB,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Get the keys of the Metadata indexes map
|
|
3
|
+
* @remarks This function will return a flat string array of all the keys in the "metadata indexes" map
|
|
4
|
+
* @param data - the map data to have the keys extracted from
|
|
5
|
+
* @returns the keys of the map
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export declare function getAvailableIndexes(data: Map<string, [string]>): string[];
|
|
9
|
+
/**
|
|
10
|
+
* Get the values of the Metadata indexes map
|
|
11
|
+
* @remarks This function will return a flat string array of all the values in the "metadata indexes" map
|
|
12
|
+
* @param data - the map data to have the values extracted from
|
|
13
|
+
* @returns the values of the map
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export declare function getAvailableIndexFields(data: Map<string, [string]>): string[];
|
|
17
|
+
//# sourceMappingURL=map.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../../src/utils/map.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAUzE;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,EAAE,CAkB7E"}
|
|
@@ -5,7 +5,7 @@ import { attr, customElement, DOM } from '@microsoft/fast-element';
|
|
|
5
5
|
import { take } from 'rxjs/operators';
|
|
6
6
|
import { dateTimeValueFormatter, dateValueFormatter } from '../grid-pro.definitions';
|
|
7
7
|
import { GridProRendererTypes } from '../grid-pro.types';
|
|
8
|
-
import { logger } from '../utils';
|
|
8
|
+
import { getAvailableIndexes, getAvailableIndexFields, logger } from '../utils';
|
|
9
9
|
import { GridProBaseDatasource, StreamBaseDatasource } from './base.datasource';
|
|
10
10
|
import { getColumnType, getFilterByFieldType, getFilterParamsByFieldType, } from './server-side.grid-definitions';
|
|
11
11
|
/**
|
|
@@ -40,7 +40,7 @@ export class StreamDatasource extends StreamBaseDatasource {
|
|
|
40
40
|
this.pagination = options.pagination;
|
|
41
41
|
}
|
|
42
42
|
getRows(params) {
|
|
43
|
-
var _a;
|
|
43
|
+
var _a, _b;
|
|
44
44
|
return __awaiter(this, void 0, void 0, function* () {
|
|
45
45
|
const filterModelBeingApplied = params.request.filterModel;
|
|
46
46
|
const filtersAreBeingApplied = Object.keys(filterModelBeingApplied).length > 0;
|
|
@@ -72,12 +72,24 @@ export class StreamDatasource extends StreamBaseDatasource {
|
|
|
72
72
|
const coldIdBeingSorted = this.currentSortModel[0].colId; // Not allowing multiple sorts by user
|
|
73
73
|
const sortTypeBeingApplied = this.currentSortModel[0].sort;
|
|
74
74
|
const orderByAndToBeSortedColIds = this.getOrderByAndToBeSortedColIds(this.resourceIndexes, coldIdBeingSorted);
|
|
75
|
-
orderByAndToBeSortedColIds
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
75
|
+
if (!orderByAndToBeSortedColIds) {
|
|
76
|
+
const availableIndexes = getAvailableIndexes(this.resourceIndexes);
|
|
77
|
+
const availableIndexFields = getAvailableIndexFields(this.resourceIndexes);
|
|
78
|
+
logger.warn('The FIELD/column (${coldIdBeingSorted}) being sorted is not part of an INDEX, required for the [orderBy] operation. See https://learn.genesis.global/docs/database/data-types/index-entities/');
|
|
79
|
+
logger.debug('Available indexes:', availableIndexes);
|
|
80
|
+
logger.debug('Columns that can be sorted with the available indexes:', availableIndexFields);
|
|
81
|
+
(_b = params.api) === null || _b === void 0 ? void 0 : _b.refreshServerSide({ purge: true });
|
|
82
|
+
params.fail();
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
orderByAndToBeSortedColIds.toBeSorted.forEach((colId) => {
|
|
87
|
+
this.currentSortModel.push({ sort: sortTypeBeingApplied, colId });
|
|
88
|
+
});
|
|
89
|
+
this.resourceParams.ORDER_BY = orderByAndToBeSortedColIds.orderBy;
|
|
90
|
+
this.resourceParams.REVERSE = sortTypeBeingApplied === 'desc' ? true : false;
|
|
91
|
+
this.restartSubscription();
|
|
92
|
+
}
|
|
81
93
|
}
|
|
82
94
|
}
|
|
83
95
|
if (this.moreRows && params.request.startRow >= Number(this.maxRows)) {
|
|
@@ -108,18 +120,14 @@ export class StreamDatasource extends StreamBaseDatasource {
|
|
|
108
120
|
this.streamSourceRef = result.SOURCE_REF;
|
|
109
121
|
this.server_ROWS_COUNT = (_a = result.ROWS_COUNT) !== null && _a !== void 0 ? _a : this.rowData.size;
|
|
110
122
|
}
|
|
111
|
-
if (!this.moreRows && this.server_ROWS_COUNT >= this.client_ROWS_COUNT) {
|
|
112
|
-
this.calculatedRowsCount = this.client_ROWS_COUNT;
|
|
113
|
-
}
|
|
114
|
-
else {
|
|
115
|
-
this.calculatedRowsCount += (_b = this.rowData.size) !== null && _b !== void 0 ? _b : 0;
|
|
116
|
-
}
|
|
117
123
|
const successRowData = {
|
|
118
124
|
rowData: Array.from(this.sortMapByNumericKey(this.rowData).values()),
|
|
125
|
+
rowCount: this.pagination ? Math.min(this.server_ROWS_COUNT, this.maxView) : undefined,
|
|
119
126
|
};
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
127
|
+
this.calculatedRowsCount +=
|
|
128
|
+
!this.moreRows && this.server_ROWS_COUNT >= this.client_ROWS_COUNT
|
|
129
|
+
? this.client_ROWS_COUNT || this.rowData.size
|
|
130
|
+
: (_b = this.rowData.size) !== null && _b !== void 0 ? _b : 0;
|
|
123
131
|
if (params.request.endRow > this.maxView ||
|
|
124
132
|
params.request.endRow > this.calculatedRowsCount) {
|
|
125
133
|
successRowData.rowCount = this.calculatedRowsCount;
|
|
@@ -338,8 +346,8 @@ let GridProServerSideDatasource = class GridProServerSideDatasource extends Life
|
|
|
338
346
|
resourceParams: this.params,
|
|
339
347
|
resourceIndexes: this.indexes,
|
|
340
348
|
resourceColDefs: this.originalFieldDef,
|
|
341
|
-
maxRows: this.maxRows,
|
|
342
|
-
maxView: this.maxView,
|
|
349
|
+
maxRows: +this.maxRows,
|
|
350
|
+
maxView: +this.maxView,
|
|
343
351
|
rowId: this.rowId,
|
|
344
352
|
pagination: this.pagination,
|
|
345
353
|
});
|
package/dist/esm/utils/index.js
CHANGED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Get the keys of the Metadata indexes map
|
|
3
|
+
* @remarks This function will return a flat string array of all the keys in the "metadata indexes" map
|
|
4
|
+
* @param data - the map data to have the keys extracted from
|
|
5
|
+
* @returns the keys of the map
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export function getAvailableIndexes(data) {
|
|
9
|
+
const availabeIndexes = [];
|
|
10
|
+
for (const [key] of data) {
|
|
11
|
+
if (key) {
|
|
12
|
+
availabeIndexes.push(key);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
return availabeIndexes;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Get the values of the Metadata indexes map
|
|
19
|
+
* @remarks This function will return a flat string array of all the values in the "metadata indexes" map
|
|
20
|
+
* @param data - the map data to have the values extracted from
|
|
21
|
+
* @returns the values of the map
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export function getAvailableIndexFields(data) {
|
|
25
|
+
const availableIndexFields = [];
|
|
26
|
+
function traverse(items) {
|
|
27
|
+
for (const item of items) {
|
|
28
|
+
if (item !== null) {
|
|
29
|
+
availableIndexFields.push(item);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
for (const [key, value] of data) {
|
|
34
|
+
if (key !== null && value !== null) {
|
|
35
|
+
traverse(value);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return availableIndexFields;
|
|
39
|
+
}
|
package/dist/grid-pro.api.json
CHANGED
|
@@ -6879,6 +6879,106 @@
|
|
|
6879
6879
|
"endIndex": 6
|
|
6880
6880
|
}
|
|
6881
6881
|
},
|
|
6882
|
+
{
|
|
6883
|
+
"kind": "Function",
|
|
6884
|
+
"canonicalReference": "@genesislcap/grid-pro!getAvailableIndexes:function(1)",
|
|
6885
|
+
"docComment": "/**\n * Get the keys of the Metadata indexes map\n *\n * @remarks\n *\n * This function will return a flat string array of all the keys in the \"metadata indexes\" map\n *\n * @param data - the map data to have the keys extracted from\n *\n * @returns the keys of the map\n *\n * @public\n */\n",
|
|
6886
|
+
"excerptTokens": [
|
|
6887
|
+
{
|
|
6888
|
+
"kind": "Content",
|
|
6889
|
+
"text": "export declare function getAvailableIndexes(data: "
|
|
6890
|
+
},
|
|
6891
|
+
{
|
|
6892
|
+
"kind": "Reference",
|
|
6893
|
+
"text": "Map",
|
|
6894
|
+
"canonicalReference": "!Map:interface"
|
|
6895
|
+
},
|
|
6896
|
+
{
|
|
6897
|
+
"kind": "Content",
|
|
6898
|
+
"text": "<string, [string]>"
|
|
6899
|
+
},
|
|
6900
|
+
{
|
|
6901
|
+
"kind": "Content",
|
|
6902
|
+
"text": "): "
|
|
6903
|
+
},
|
|
6904
|
+
{
|
|
6905
|
+
"kind": "Content",
|
|
6906
|
+
"text": "string[]"
|
|
6907
|
+
},
|
|
6908
|
+
{
|
|
6909
|
+
"kind": "Content",
|
|
6910
|
+
"text": ";"
|
|
6911
|
+
}
|
|
6912
|
+
],
|
|
6913
|
+
"fileUrlPath": "src/utils/map.ts",
|
|
6914
|
+
"returnTypeTokenRange": {
|
|
6915
|
+
"startIndex": 4,
|
|
6916
|
+
"endIndex": 5
|
|
6917
|
+
},
|
|
6918
|
+
"releaseTag": "Public",
|
|
6919
|
+
"overloadIndex": 1,
|
|
6920
|
+
"parameters": [
|
|
6921
|
+
{
|
|
6922
|
+
"parameterName": "data",
|
|
6923
|
+
"parameterTypeTokenRange": {
|
|
6924
|
+
"startIndex": 1,
|
|
6925
|
+
"endIndex": 3
|
|
6926
|
+
},
|
|
6927
|
+
"isOptional": false
|
|
6928
|
+
}
|
|
6929
|
+
],
|
|
6930
|
+
"name": "getAvailableIndexes"
|
|
6931
|
+
},
|
|
6932
|
+
{
|
|
6933
|
+
"kind": "Function",
|
|
6934
|
+
"canonicalReference": "@genesislcap/grid-pro!getAvailableIndexFields:function(1)",
|
|
6935
|
+
"docComment": "/**\n * Get the values of the Metadata indexes map\n *\n * @remarks\n *\n * This function will return a flat string array of all the values in the \"metadata indexes\" map\n *\n * @param data - the map data to have the values extracted from\n *\n * @returns the values of the map\n *\n * @public\n */\n",
|
|
6936
|
+
"excerptTokens": [
|
|
6937
|
+
{
|
|
6938
|
+
"kind": "Content",
|
|
6939
|
+
"text": "export declare function getAvailableIndexFields(data: "
|
|
6940
|
+
},
|
|
6941
|
+
{
|
|
6942
|
+
"kind": "Reference",
|
|
6943
|
+
"text": "Map",
|
|
6944
|
+
"canonicalReference": "!Map:interface"
|
|
6945
|
+
},
|
|
6946
|
+
{
|
|
6947
|
+
"kind": "Content",
|
|
6948
|
+
"text": "<string, [string]>"
|
|
6949
|
+
},
|
|
6950
|
+
{
|
|
6951
|
+
"kind": "Content",
|
|
6952
|
+
"text": "): "
|
|
6953
|
+
},
|
|
6954
|
+
{
|
|
6955
|
+
"kind": "Content",
|
|
6956
|
+
"text": "string[]"
|
|
6957
|
+
},
|
|
6958
|
+
{
|
|
6959
|
+
"kind": "Content",
|
|
6960
|
+
"text": ";"
|
|
6961
|
+
}
|
|
6962
|
+
],
|
|
6963
|
+
"fileUrlPath": "src/utils/map.ts",
|
|
6964
|
+
"returnTypeTokenRange": {
|
|
6965
|
+
"startIndex": 4,
|
|
6966
|
+
"endIndex": 5
|
|
6967
|
+
},
|
|
6968
|
+
"releaseTag": "Public",
|
|
6969
|
+
"overloadIndex": 1,
|
|
6970
|
+
"parameters": [
|
|
6971
|
+
{
|
|
6972
|
+
"parameterName": "data",
|
|
6973
|
+
"parameterTypeTokenRange": {
|
|
6974
|
+
"startIndex": 1,
|
|
6975
|
+
"endIndex": 3
|
|
6976
|
+
},
|
|
6977
|
+
"isOptional": false
|
|
6978
|
+
}
|
|
6979
|
+
],
|
|
6980
|
+
"name": "getAvailableIndexFields"
|
|
6981
|
+
},
|
|
6882
6982
|
{
|
|
6883
6983
|
"kind": "Variable",
|
|
6884
6984
|
"canonicalReference": "@genesislcap/grid-pro!getDateEditorTemplate:var",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -1023,6 +1023,24 @@ export declare const getAgBooleanRendererTemplate: (designSystem?: string) => Vi
|
|
|
1023
1023
|
*/
|
|
1024
1024
|
export declare const getAgEditableRendererTemplate: (designSystem?: string) => ViewTemplate<EditableRenderer, any>;
|
|
1025
1025
|
|
|
1026
|
+
/**
|
|
1027
|
+
* Get the keys of the Metadata indexes map
|
|
1028
|
+
* @remarks This function will return a flat string array of all the keys in the "metadata indexes" map
|
|
1029
|
+
* @param data - the map data to have the keys extracted from
|
|
1030
|
+
* @returns the keys of the map
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
export declare function getAvailableIndexes(data: Map<string, [string]>): string[];
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
* Get the values of the Metadata indexes map
|
|
1037
|
+
* @remarks This function will return a flat string array of all the values in the "metadata indexes" map
|
|
1038
|
+
* @param data - the map data to have the values extracted from
|
|
1039
|
+
* @returns the values of the map
|
|
1040
|
+
* @public
|
|
1041
|
+
*/
|
|
1042
|
+
export declare function getAvailableIndexFields(data: Map<string, [string]>): string[];
|
|
1043
|
+
|
|
1026
1044
|
/**
|
|
1027
1045
|
* Return a column type base on each field's metadata from the selected resource.
|
|
1028
1046
|
* @param metadataType - The type of the field/column
|
|
@@ -2343,11 +2361,6 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
2343
2361
|
readonly DOCUMENT_TYPE_NODE: number;
|
|
2344
2362
|
readonly ELEMENT_NODE: number;
|
|
2345
2363
|
readonly ENTITY_NODE: number;
|
|
2346
|
-
/**
|
|
2347
|
-
* A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
|
|
2348
|
-
* @remarks Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
|
|
2349
|
-
* @alpha
|
|
2350
|
-
*/
|
|
2351
2364
|
readonly ENTITY_REFERENCE_NODE: number;
|
|
2352
2365
|
readonly NOTATION_NODE: number;
|
|
2353
2366
|
readonly PROCESSING_INSTRUCTION_NODE: number;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [getAvailableIndexes](./grid-pro.getavailableindexes.md)
|
|
4
|
+
|
|
5
|
+
## getAvailableIndexes() function
|
|
6
|
+
|
|
7
|
+
Get the keys of the Metadata indexes map
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function getAvailableIndexes(data: Map<string, [string]>): string[];
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| data | Map<string, \[string\]> | the map data to have the keys extracted from |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
string\[\]
|
|
24
|
+
|
|
25
|
+
the keys of the map
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
This function will return a flat string array of all the keys in the "metadata indexes" map
|
|
30
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [getAvailableIndexFields](./grid-pro.getavailableindexfields.md)
|
|
4
|
+
|
|
5
|
+
## getAvailableIndexFields() function
|
|
6
|
+
|
|
7
|
+
Get the values of the Metadata indexes map
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function getAvailableIndexFields(data: Map<string, [string]>): string[];
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| data | Map<string, \[string\]> | the map data to have the values extracted from |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
string\[\]
|
|
24
|
+
|
|
25
|
+
the values of the map
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
This function will return a flat string array of all the values in the "metadata indexes" map
|
|
30
|
+
|
package/docs/api/grid-pro.md
CHANGED
|
@@ -41,6 +41,8 @@
|
|
|
41
41
|
| --- | --- |
|
|
42
42
|
| [dateTimeValueFormatter({ value })](./grid-pro.datetimevalueformatter.md) | Returns a formatted date time value from the Grid Pro cell value. |
|
|
43
43
|
| [dateValueFormatter({ value })](./grid-pro.datevalueformatter.md) | Returns a formatted date value from the Grid Pro cell value. |
|
|
44
|
+
| [getAvailableIndexes(data)](./grid-pro.getavailableindexes.md) | Get the keys of the Metadata indexes map |
|
|
45
|
+
| [getAvailableIndexFields(data)](./grid-pro.getavailableindexfields.md) | Get the values of the Metadata indexes map |
|
|
44
46
|
| [gridProColumns(itemsBinding, includeRenderers)](./grid-pro.gridprocolumns.md) | A directive that renders a set of grid-pro-column elements from a given input binding |
|
|
45
47
|
| [mergeAndDedupColDefWithColumnState(colDefs, columnStates)](./grid-pro.mergeanddedupcoldefwithcolumnstate.md) | Merges two arrays, one of <code>ColDef</code> and one of <code>ColumnState</code>, and deduplicates them. |
|
|
46
48
|
|
package/docs/api-report.md
CHANGED
|
@@ -723,6 +723,12 @@ export const getAgBooleanRendererTemplate: (designSystem?: string) => ViewTempla
|
|
|
723
723
|
// @public
|
|
724
724
|
export const getAgEditableRendererTemplate: (designSystem?: string) => ViewTemplate<EditableRenderer, any>;
|
|
725
725
|
|
|
726
|
+
// @public
|
|
727
|
+
export function getAvailableIndexes(data: Map<string, [string]>): string[];
|
|
728
|
+
|
|
729
|
+
// @public
|
|
730
|
+
export function getAvailableIndexFields(data: Map<string, [string]>): string[];
|
|
731
|
+
|
|
726
732
|
// @alpha
|
|
727
733
|
export function getColumnType(metadataType: string): string;
|
|
728
734
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/grid-pro",
|
|
3
3
|
"description": "Genesis Foundation AG Grid",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.150.1-alpha-28e6b6f.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -30,20 +30,20 @@
|
|
|
30
30
|
"test:debug": "genx test --debug"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
|
-
"@genesislcap/foundation-testing": "14.
|
|
34
|
-
"@genesislcap/genx": "14.
|
|
35
|
-
"@genesislcap/rollup-builder": "14.
|
|
36
|
-
"@genesislcap/ts-builder": "14.
|
|
37
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
|
38
|
-
"@genesislcap/vite-builder": "14.
|
|
39
|
-
"@genesislcap/webpack-builder": "14.
|
|
33
|
+
"@genesislcap/foundation-testing": "14.150.1-alpha-28e6b6f.0",
|
|
34
|
+
"@genesislcap/genx": "14.150.1-alpha-28e6b6f.0",
|
|
35
|
+
"@genesislcap/rollup-builder": "14.150.1-alpha-28e6b6f.0",
|
|
36
|
+
"@genesislcap/ts-builder": "14.150.1-alpha-28e6b6f.0",
|
|
37
|
+
"@genesislcap/uvu-playwright-builder": "14.150.1-alpha-28e6b6f.0",
|
|
38
|
+
"@genesislcap/vite-builder": "14.150.1-alpha-28e6b6f.0",
|
|
39
|
+
"@genesislcap/webpack-builder": "14.150.1-alpha-28e6b6f.0",
|
|
40
40
|
"rimraf": "^3.0.2"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@genesislcap/foundation-comms": "14.
|
|
44
|
-
"@genesislcap/foundation-logger": "14.
|
|
45
|
-
"@genesislcap/foundation-ui": "14.
|
|
46
|
-
"@genesislcap/foundation-utils": "14.
|
|
43
|
+
"@genesislcap/foundation-comms": "14.150.1-alpha-28e6b6f.0",
|
|
44
|
+
"@genesislcap/foundation-logger": "14.150.1-alpha-28e6b6f.0",
|
|
45
|
+
"@genesislcap/foundation-ui": "14.150.1-alpha-28e6b6f.0",
|
|
46
|
+
"@genesislcap/foundation-utils": "14.150.1-alpha-28e6b6f.0",
|
|
47
47
|
"@microsoft/fast-colors": "^5.3.1",
|
|
48
48
|
"@microsoft/fast-components": "^2.30.6",
|
|
49
49
|
"@microsoft/fast-element": "^1.12.0",
|
|
@@ -68,5 +68,5 @@
|
|
|
68
68
|
"access": "public"
|
|
69
69
|
},
|
|
70
70
|
"customElements": "dist/custom-elements.json",
|
|
71
|
-
"gitHead": "
|
|
71
|
+
"gitHead": "edfcd5d841bae73ff6b3f5c3adb953490bc0d27b"
|
|
72
72
|
}
|