@genesislcap/grid-pro 14.289.1-alpha-fe89166.0 → 14.289.1
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/README.md +14 -99
- package/dist/custom-elements.json +61 -0
- package/dist/dts/datasource/base.datasource.d.ts +6 -20
- package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
- package/dist/esm/datasource/base.datasource.js +2 -3
- package/dist/grid-pro.api.json +30 -0
- package/dist/grid-pro.d.ts +6 -20
- package/docs/api/grid-pro.genesisgriddatasourceelement.md +1 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.rowid.md +11 -0
- package/docs/api-report.md +1 -1
- package/package.json +13 -13
package/README.md
CHANGED
|
@@ -23,26 +23,13 @@ For more detailed information on API and configurations, please refer to the [AP
|
|
|
23
23
|
- **`src/`**: Source code for the package, including cell-editors, cell-renderers, datasources and utility functions.
|
|
24
24
|
- **`cell/`**: The Grid Pro Cell element and template
|
|
25
25
|
- **`cell-editors/`**: predefined custom cell-editors for common data types including `date`, `number`, `string`, `select`, `multiselect`
|
|
26
|
-
- **`cell-renderers/`**: predefined custom cell-renderers
|
|
27
|
-
- **`column
|
|
26
|
+
- **`cell-renderers/`**: predefined custom cell-renderers.
|
|
27
|
+
- **`column/` for a given column.
|
|
28
28
|
- **[`datasource/`](#genesis-datasource)**: Genesis Datasource elements, responsible for fetching data for the Grid Pro element (multiple implementations available, for both client-side and server-side [row models](https://www.ag-grid.com/javascript-data-grid/row-models/)).
|
|
29
29
|
- **`external/`**: External assets such as fonts and styles for themes.
|
|
30
|
-
- **`grid-pro-genesis-datasource/`**: Client-side datasource implementation (CSRM-compatible)
|
|
31
30
|
- **`state-persistence/`**: Classes related to saving and restoring grid state.
|
|
32
|
-
- **`status-bar-components/`**: Status bar components including `load-more`, `pagination`, `label-value`, `reload` (requires AG Grid Enterprise)
|
|
33
31
|
- **`tooltips/`**: Tooltip for errors that happen while syncing data with server after inline editing.
|
|
34
|
-
- **`utils/`**: Utility functions
|
|
35
|
-
|
|
36
|
-
## Enterprise Features and Licensing
|
|
37
|
-
|
|
38
|
-
**Important:** Some Grid Pro features require AG Grid Enterprise licensing and module registration:
|
|
39
|
-
|
|
40
|
-
- **Status Bar Components**: All status bar functionality (`with-status-bar`, `statusBarConfig`) requires AG Grid Enterprise
|
|
41
|
-
- **Server-Side Row Model**: Server-side datasource requires `@ag-grid-enterprise/server-side-row-model`
|
|
42
|
-
- **Advanced Filtering**: Some advanced filtering features may require Enterprise modules
|
|
43
|
-
- **Excel Export**: Excel export functionality requires AG Grid Enterprise
|
|
44
|
-
|
|
45
|
-
For production use, you must obtain appropriate AG Grid Enterprise licenses. Contact [AG Grid](https://www.ag-grid.com/license-pricing/) for licensing information.
|
|
32
|
+
- **`utils/`**: Utility functions.
|
|
46
33
|
|
|
47
34
|
## Getting Started
|
|
48
35
|
|
|
@@ -73,30 +60,6 @@ import { rapidGridComponents } from '@genesislcap/rapid-grid-pro';
|
|
|
73
60
|
provideDesignSystem().register(baseComponents, rapidGridComponents);
|
|
74
61
|
```
|
|
75
62
|
|
|
76
|
-
### Enterprise Module Registration
|
|
77
|
-
|
|
78
|
-
**REQUIRED for Status Bar and Server-Side Datasource Features**
|
|
79
|
-
|
|
80
|
-
If you plan to use Status Bar components (`with-status-bar`) or Server-Side datasource (`<grid-pro-server-side-datasource>`), you **MUST** register the appropriate AG Grid Enterprise modules:
|
|
81
|
-
|
|
82
|
-
```typescript
|
|
83
|
-
import { ModuleRegistry } from '@ag-grid-community/core';
|
|
84
|
-
|
|
85
|
-
// Required for Status Bar components (with-status-bar, statusBarConfig)
|
|
86
|
-
import { StatusBarModule } from '@ag-grid-enterprise/status-bar';
|
|
87
|
-
|
|
88
|
-
// Required for Server-Side datasource (<grid-pro-server-side-datasource>)
|
|
89
|
-
import { ServerSideRowModelModule } from '@ag-grid-enterprise/server-side-row-model';
|
|
90
|
-
|
|
91
|
-
// Register the enterprise modules you need
|
|
92
|
-
ModuleRegistry.registerModules([
|
|
93
|
-
StatusBarModule, // Required for: with-status-bar, statusBarConfig
|
|
94
|
-
ServerSideRowModelModule, // Required for: <grid-pro-server-side-datasource>
|
|
95
|
-
]);
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
**Note:** These modules require a valid AG Grid Enterprise license for production use.
|
|
99
|
-
|
|
100
63
|
### Grid Pro Element Attributes
|
|
101
64
|
|
|
102
65
|
The `<grid-pro>` element supports the following attributes and properties:
|
|
@@ -133,7 +96,7 @@ The `<grid-pro>` element supports the following attributes and properties:
|
|
|
133
96
|
|
|
134
97
|
#### Status Bar Configuration
|
|
135
98
|
|
|
136
|
-
**Enterprise License Required**: Status bar functionality requires the AG Grid Enterprise
|
|
99
|
+
**Enterprise License Required**: Status bar functionality requires the AG Grid Enterprise module. Status bar components will only be displayed if the Enterprise module is properly licensed and configured.
|
|
137
100
|
|
|
138
101
|
**Important Datasource Behavior:**
|
|
139
102
|
|
|
@@ -142,7 +105,7 @@ The `<grid-pro>` element supports the following attributes and properties:
|
|
|
142
105
|
|
|
143
106
|
```typescript
|
|
144
107
|
interface GridProStatusBarConfig {
|
|
145
|
-
rows?: boolean; // Enable row count component (default:
|
|
108
|
+
rows?: boolean; // Enable row count component (default: true)
|
|
146
109
|
maxRows?: boolean; // Enable max rows label-value component (default: false)
|
|
147
110
|
loadMore?: boolean | GridProStatusBarLoadMoreConfig; // Enable/configure load more button (CLIENT-SIDE ONLY)
|
|
148
111
|
reload?: boolean | GridProStatusBarReloadConfig; // Enable/configure reload button
|
|
@@ -339,10 +302,10 @@ Some **resource** related attributes are `DATASERVER` or `REQUEST_SERVER` speci
|
|
|
339
302
|
|
|
340
303
|
|Name|Type|Default|Description|
|
|
341
304
|
|----|----|-------|-----------|
|
|
342
|
-
| `resource-name` | `string` | - |
|
|
305
|
+
| `resource-name` | `string` | - | The name of the target [Data Server](https://learn.genesis.global/docs/server/data-server/introduction/) `query` or [Request Server](https://learn.genesis.global/docs/server/request-server/introduction/) `requestReply`. |
|
|
343
306
|
| `is-snapshot` | `boolean` | `false` | Request a snapshot from the server. |
|
|
344
307
|
| `criteria` |`string`| - |Clients can send a Groovy expression to perform filters on the query server; these remain active for the life of the subscription.|
|
|
345
|
-
| `max-rows` | `number` |
|
|
308
|
+
| `max-rows` | `number` | - | Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages. **This will not affect the number of rows displayed**|
|
|
346
309
|
| `view-number` | `number` | - | The desired view/page you want data from. |
|
|
347
310
|
|
|
348
311
|
##### DATASERVER only attributes
|
|
@@ -350,7 +313,7 @@ Some **resource** related attributes are `DATASERVER` or `REQUEST_SERVER` speci
|
|
|
350
313
|
|Name|Type|Default|Description|
|
|
351
314
|
|----|----|-------|-----------|
|
|
352
315
|
| `fields` | `string` | - | This optional parameter allows you to select a subset of fields from the query if the client is not interested in receiving all of them. |
|
|
353
|
-
| `max-view` | `number` |
|
|
316
|
+
| `max-view` | `number` | - | Maximum number of rows to track as part of a client "view" |
|
|
354
317
|
| `moving-view` | `boolean` | `false` | 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. 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.|
|
|
355
318
|
| `order-by` | `string` | - | This option can be used to select a [Data Server index](https://learn.genesis.global/docs/database/data-types/index-entities/) (defined in the Data Server `query`), which is especially useful if you want the data to be sorted in a specific way. By default, Data Server rows are returned in order of creation (from oldest database record to newest).|
|
|
356
319
|
| `reverse` | `boolean` | `false` | This option changes the [Data Server index](https://learn.genesis.global/docs/database/data-types/index-entities/) iteration. For example, if you are using the default index, the query will return rows in order from the newest database records to the oldest.|
|
|
@@ -360,9 +323,9 @@ Some **resource** related attributes are `DATASERVER` or `REQUEST_SERVER` speci
|
|
|
360
323
|
|Name|Type|Default|Description|
|
|
361
324
|
|----|----|-------|-----------|
|
|
362
325
|
| `disable-polling` | `boolean` | `false` | This option disables polling if set to true (data updates for the grid will not be fetched automatically).|
|
|
363
|
-
| `polling-interval` | `number` |
|
|
364
|
-
|`request`| `
|
|
365
|
-
|`request-auto-setup`| `boolean` | `
|
|
326
|
+
| `polling-interval` | `number` | - | This option enables you to set a custom polling frequency (in milliseconds) for a [Request Server](https://learn.genesis.global/docs/server/request-server/introduction/) resource. 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. |
|
|
327
|
+
|`request`| `string` | - | Similar to `fields` but for [Request Server](https://learn.genesis.global/docs/server/request-server/introduction/) scenarios. This optional parameter enables you to specify request fields, which can include wildcards.|
|
|
328
|
+
|`request-auto-setup`| `boolean` | `false` | This option, if set to true, will automatically set up the `request` based on the datasources's metadata.|
|
|
366
329
|
|
|
367
330
|
#### Component Attributes
|
|
368
331
|
|
|
@@ -372,7 +335,7 @@ There are additional attributes that can affect the behavior of a datasource com
|
|
|
372
335
|
|
|
373
336
|
|Name|Type|Default|Description|
|
|
374
337
|
|----|----|-------|-----------|
|
|
375
|
-
| `restart-on-reconnection` | `boolean` | `
|
|
338
|
+
| `restart-on-reconnection` | `boolean` | `false` | This option, if set to true, will force the resource data to be reloaded upon a reconnection event.|
|
|
376
339
|
| `keep-col-defs-on-clear-row-data` | `boolean` | `false` | This option, if set to true, will retain column definitions upon a `restart` or `clearRowData` event. |
|
|
377
340
|
|
|
378
341
|
##### `<grid-pro-server-side-datasource>`
|
|
@@ -571,8 +534,6 @@ This document outlines the available features of our two "Grid Pro" datasources:
|
|
|
571
534
|
|
|
572
535
|
## \<grid-pro-server-side-datasource\>
|
|
573
536
|
|
|
574
|
-
**Enterprise License Required**: Server-side datasource requires AG Grid Enterprise licensing and the `ServerSideRowModelModule` to be registered (see [Enterprise Module Registration](#enterprise-module-registration) above).
|
|
575
|
-
|
|
576
537
|
### Server-Side Features
|
|
577
538
|
|
|
578
539
|
- **Sorting**: Order by any INDEX column/field, ASC or DESC.
|
|
@@ -612,7 +573,7 @@ This document outlines the available features of our two "Grid Pro" datasources:
|
|
|
612
573
|
|
|
613
574
|
- Operations like sorting and filtering are pushed to the backend.
|
|
614
575
|
- Filtering uses `CRITERIA_MATCH` param
|
|
615
|
-
- Sorting uses `
|
|
576
|
+
- Sorting uses `ORDERY_BY` param
|
|
616
577
|
- Both work the same way, once filtering/sorting is applied the datasource component "resets itself", basically starting a new stream with the updated params.
|
|
617
578
|
- **LIMITATIONS**
|
|
618
579
|
- Sorting can only be applied to "index" fields/columns. Also mentioned [here](https://www.notion.so/Grid-Pro-Datasource-Inventory-d11ca7570ee94847bbcb3e7362025b0a?pvs=21). More details [here](https://genesisglobal.atlassian.net/jira/polaris/projects/GPR/ideas/view/4721227?selectedIssue=GPR-171&focusedCommentId=143757) and [here](https://genesis-global-talk.slack.com/archives/C0416MFG360/p1696456988606789).
|
|
@@ -669,7 +630,7 @@ It's important to note that any client app can implement the other Row Models to
|
|
|
669
630
|
### Summary
|
|
670
631
|
|
|
671
632
|
- **Client-Side Datasource**: Suitable for smaller datasets where all data can be loaded into the client. Operations like sorting and filtering are performed on the client-side.
|
|
672
|
-
- **Server-Side Datasource**: Ideal for large datasets, where operations are pushed to the backend to ensure performance and consistency. Data is fetched as needed based on user interactions.
|
|
633
|
+
- **Server-Side Datasource**: Ideal for large datasets, where operations are pushed to the backend to ensure performance and consistency. Data is fetched as needed based on user interactions.
|
|
673
634
|
|
|
674
635
|
## Performance
|
|
675
636
|
|
|
@@ -703,52 +664,6 @@ By leveraging both DOM Virtualisation and Pagination, our "grid components" can
|
|
|
703
664
|
- **Scrolling**: As users scroll, DOM Virtualisation ensures only the visible rows and columns are rendered, maintaining performance.
|
|
704
665
|
- **Page Navigation**: Users can navigate through pages to access the full dataset without overwhelming the client.
|
|
705
666
|
|
|
706
|
-
## Cell Renderers
|
|
707
|
-
|
|
708
|
-
Grid Pro provides a comprehensive set of built-in cell renderers for common data types and use cases:
|
|
709
|
-
|
|
710
|
-
### Available Renderers
|
|
711
|
-
|
|
712
|
-
- **ActionRenderer**: Renders action buttons for row operations (edit, delete, custom actions)
|
|
713
|
-
- **ActionsMenuRenderer**: Renders a dropdown menu with multiple actions
|
|
714
|
-
- **BooleanRenderer**: Displays boolean values as checkboxes or toggle switches
|
|
715
|
-
- **EditableRenderer**: Provides inline editing capabilities for cells
|
|
716
|
-
- **TextRenderer**: Basic text display with optional formatting
|
|
717
|
-
- **TextFieldRenderer**: Text input field for editing
|
|
718
|
-
- **StatusPillRenderer**: Displays status values as colored pills/badges
|
|
719
|
-
- **SelectRenderer**: Dropdown selection for predefined options
|
|
720
|
-
|
|
721
|
-
### Custom Renderers
|
|
722
|
-
|
|
723
|
-
You can create custom cell renderers by implementing the AG Grid ICellRenderer interface and registering them via the `gridComponents` property.
|
|
724
|
-
|
|
725
|
-
## Cell Editors
|
|
726
|
-
|
|
727
|
-
Grid Pro includes predefined cell editors for common data types:
|
|
728
|
-
|
|
729
|
-
### Available Editors
|
|
730
|
-
|
|
731
|
-
- **DateEditor**: Date picker with configurable format and validation
|
|
732
|
-
- **NumberEditor**: Numeric input with formatting and validation options
|
|
733
|
-
- **StringEditor**: Text input with optional validation and placeholder
|
|
734
|
-
- **SelectEditor**: Dropdown selection with support for dynamic options
|
|
735
|
-
- **MultiselectEditor**: Multi-selection dropdown for multiple values
|
|
736
|
-
|
|
737
|
-
### Editor Configuration
|
|
738
|
-
|
|
739
|
-
Each editor supports extensive configuration through editor parameters, allowing customization of appearance, validation, and behavior.
|
|
740
|
-
|
|
741
|
-
## Status Bar Components
|
|
742
|
-
|
|
743
|
-
**Enterprise Feature**: Status bar components require AG Grid Enterprise licensing and the StatusBarModule to be registered.
|
|
744
|
-
|
|
745
|
-
### Available Components
|
|
746
|
-
|
|
747
|
-
- **LabelValueStatusBarComponent**: Displays key-value pairs in the status bar
|
|
748
|
-
- **LoadMoreStatusBarComponent**: Provides load more functionality (client-side only)
|
|
749
|
-
- **PaginationStatusBarComponent**: Shows pagination controls and information
|
|
750
|
-
- **ReloadStatusBarComponent**: Adds reload/refresh button
|
|
751
|
-
|
|
752
667
|
## License
|
|
753
668
|
|
|
754
669
|
Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
|
|
@@ -6437,6 +6437,15 @@
|
|
|
6437
6437
|
"default": "true",
|
|
6438
6438
|
"description": "Attribute to set whether the datasource should restart when it reconnects."
|
|
6439
6439
|
},
|
|
6440
|
+
{
|
|
6441
|
+
"kind": "field",
|
|
6442
|
+
"name": "rowId",
|
|
6443
|
+
"type": {
|
|
6444
|
+
"text": "string"
|
|
6445
|
+
},
|
|
6446
|
+
"privacy": "protected",
|
|
6447
|
+
"readonly": true
|
|
6448
|
+
},
|
|
6440
6449
|
{
|
|
6441
6450
|
"kind": "field",
|
|
6442
6451
|
"name": "defaultRowIdByResourceType",
|
|
@@ -7364,6 +7373,19 @@
|
|
|
7364
7373
|
"module": "src/datasource/base.datasource.ts"
|
|
7365
7374
|
}
|
|
7366
7375
|
},
|
|
7376
|
+
{
|
|
7377
|
+
"kind": "field",
|
|
7378
|
+
"name": "rowId",
|
|
7379
|
+
"type": {
|
|
7380
|
+
"text": "string"
|
|
7381
|
+
},
|
|
7382
|
+
"privacy": "protected",
|
|
7383
|
+
"readonly": true,
|
|
7384
|
+
"inheritedFrom": {
|
|
7385
|
+
"name": "GenesisGridDatasourceElement",
|
|
7386
|
+
"module": "src/datasource/base.datasource.ts"
|
|
7387
|
+
}
|
|
7388
|
+
},
|
|
7367
7389
|
{
|
|
7368
7390
|
"kind": "field",
|
|
7369
7391
|
"name": "defaultRowIdByResourceType",
|
|
@@ -9088,6 +9110,19 @@
|
|
|
9088
9110
|
"module": "src/datasource/base.datasource.ts"
|
|
9089
9111
|
}
|
|
9090
9112
|
},
|
|
9113
|
+
{
|
|
9114
|
+
"kind": "field",
|
|
9115
|
+
"name": "rowId",
|
|
9116
|
+
"type": {
|
|
9117
|
+
"text": "string"
|
|
9118
|
+
},
|
|
9119
|
+
"privacy": "protected",
|
|
9120
|
+
"readonly": true,
|
|
9121
|
+
"inheritedFrom": {
|
|
9122
|
+
"name": "GenesisGridDatasourceElement",
|
|
9123
|
+
"module": "src/datasource/base.datasource.ts"
|
|
9124
|
+
}
|
|
9125
|
+
},
|
|
9091
9126
|
{
|
|
9092
9127
|
"kind": "field",
|
|
9093
9128
|
"name": "defaultRowIdByResourceType",
|
|
@@ -10637,6 +10672,19 @@
|
|
|
10637
10672
|
"module": "src/datasource/base.datasource.ts"
|
|
10638
10673
|
}
|
|
10639
10674
|
},
|
|
10675
|
+
{
|
|
10676
|
+
"kind": "field",
|
|
10677
|
+
"name": "rowId",
|
|
10678
|
+
"type": {
|
|
10679
|
+
"text": "string"
|
|
10680
|
+
},
|
|
10681
|
+
"privacy": "protected",
|
|
10682
|
+
"readonly": true,
|
|
10683
|
+
"inheritedFrom": {
|
|
10684
|
+
"name": "GenesisGridDatasourceElement",
|
|
10685
|
+
"module": "src/datasource/base.datasource.ts"
|
|
10686
|
+
}
|
|
10687
|
+
},
|
|
10640
10688
|
{
|
|
10641
10689
|
"kind": "field",
|
|
10642
10690
|
"name": "defaultRowIdByResourceType",
|
|
@@ -14018,6 +14066,19 @@
|
|
|
14018
14066
|
"module": "src/datasource/base.datasource.ts"
|
|
14019
14067
|
}
|
|
14020
14068
|
},
|
|
14069
|
+
{
|
|
14070
|
+
"kind": "field",
|
|
14071
|
+
"name": "rowId",
|
|
14072
|
+
"type": {
|
|
14073
|
+
"text": "string"
|
|
14074
|
+
},
|
|
14075
|
+
"privacy": "protected",
|
|
14076
|
+
"readonly": true,
|
|
14077
|
+
"inheritedFrom": {
|
|
14078
|
+
"name": "GenesisGridDatasourceElement",
|
|
14079
|
+
"module": "src/datasource/base.datasource.ts"
|
|
14080
|
+
}
|
|
14081
|
+
},
|
|
14021
14082
|
{
|
|
14022
14083
|
"kind": "field",
|
|
14023
14084
|
"name": "defaultRowIdByResourceType",
|
|
@@ -45,11 +45,7 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
45
45
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
46
46
|
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
|
47
47
|
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
48
|
-
readonly attributes: NamedNodeMap;
|
|
49
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
50
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
51
|
-
* @internal
|
|
52
|
-
*/
|
|
48
|
+
readonly attributes: NamedNodeMap;
|
|
53
49
|
readonly classList: DOMTokenList;
|
|
54
50
|
className: string;
|
|
55
51
|
readonly clientHeight: number;
|
|
@@ -127,10 +123,6 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
127
123
|
readonly nodeName: string;
|
|
128
124
|
readonly nodeType: number;
|
|
129
125
|
nodeValue: string;
|
|
130
|
-
/**
|
|
131
|
-
* Override datasource initialization to handle errors properly.
|
|
132
|
-
* @internal
|
|
133
|
-
*/
|
|
134
126
|
readonly parentElement: HTMLElement;
|
|
135
127
|
readonly parentNode: ParentNode;
|
|
136
128
|
readonly previousSibling: ChildNode;
|
|
@@ -183,17 +175,16 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
183
175
|
ariaHasPopup: string;
|
|
184
176
|
ariaHidden: string;
|
|
185
177
|
ariaInvalid: string;
|
|
186
|
-
ariaKeyShortcuts: string;
|
|
187
|
-
* The operation type for the `GridProBaseDatasource.mapTransaction` method.
|
|
188
|
-
* @internal
|
|
189
|
-
*/
|
|
178
|
+
ariaKeyShortcuts: string;
|
|
190
179
|
ariaLabel: string;
|
|
191
180
|
ariaLevel: string;
|
|
192
181
|
ariaLive: string;
|
|
193
182
|
ariaModal: string;
|
|
194
183
|
ariaMultiLine: string;
|
|
195
184
|
ariaMultiSelectable: string;
|
|
196
|
-
ariaOrientation: string;
|
|
185
|
+
ariaOrientation: string; /**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
197
188
|
ariaPlaceholder: string;
|
|
198
189
|
ariaPosInSet: string;
|
|
199
190
|
ariaPressed: string;
|
|
@@ -389,11 +380,6 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
|
|
|
389
380
|
* @privateRemarks This attribute is shared across all datasources to ensure consistent behavior.
|
|
390
381
|
*/
|
|
391
382
|
restartOnReconnection: boolean;
|
|
392
|
-
/**
|
|
393
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
394
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
395
|
-
* @internal
|
|
396
|
-
*/
|
|
397
383
|
protected get rowId(): string;
|
|
398
384
|
/**
|
|
399
385
|
* Returns whether the `row-id` attribute is the default one, depending on the resource type.
|
|
@@ -429,7 +415,7 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
|
|
|
429
415
|
protected initializeDatasource(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
|
|
430
416
|
}
|
|
431
417
|
/**
|
|
432
|
-
* The operation type for the
|
|
418
|
+
* The operation type for the {@link @genesislcap/grid-pro#GridProBaseDatasource.mapTransaction} method.
|
|
433
419
|
* @internal
|
|
434
420
|
*/
|
|
435
421
|
export declare enum OperationType {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.datasource.d.ts","sourceRoot":"","sources":["../../../src/datasource/base.datasource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EACN,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,UAAU,EAGV,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EAKd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAGxD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAErD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAS3C,OAAO,EAAE,KAAK,8BAA8B,EAA4B,MAAM,cAAc,CAAC;AAE7F;;;GAGG;AACH,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAS,CAAC
|
|
1
|
+
{"version":3,"file":"base.datasource.d.ts","sourceRoot":"","sources":["../../../src/datasource/base.datasource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EACN,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,UAAU,EAGV,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EAKd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAGxD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAErD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAS3C,OAAO,EAAE,KAAK,8BAA8B,EAA4B,MAAM,cAAc,CAAC;AAE7F;;;GAGG;AACH,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BA0QnC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA1QH;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,iCAAyC;IAChF,OAAO,EAAG,OAAO,CAAC;IACf,UAAU,EAAG,UAAU,CAAC;IAExB,mBAAmB,EAAE,WAAW,CAAC;IACjC,oBAAoB,EAAE,WAAW,EAAE,CAAC;IAEhD;;OAEG;IACS,aAAa,EAAE,QAAQ,CAAC;IAE9B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACgC,UAAU,UAAS;IACvC,OAAO,EAAE,MAAM,CAAmC;IAClD,OAAO,EAAE,MAAM,CAAoC;IAC/B,UAAU,UAAS;IACvC,OAAO,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IAChC,OAAO,UAAS;IACP,UAAU,EAAE,MAAM,CAAC;IAEd,eAAe,EAAE,MAAM,CACf;IACQ,cAAc,EAAE,OAAO,CAAS;IAC7E,OAAO,EAAE,GAAG,CAAC;IAEzB;;;;OAIG;IACyD,gBAAgB,UAAQ;IAEpF;;;;;OAKG;IAC4B,SAAS,MAAC;IAEzC;;;;OAIG;IAC8D,qBAAqB,UAAQ;IAM9F,SAAS,KAAK,KAAK,IAAI,MAAM,CAI5B;IAED;;;OAGG;IACH,SAAS,KAAK,eAAe,IAAI,OAAO,CAMvC;IAED,SAAS,KAAK,0BAA0B,IAAI,MAAM,CAIjD;IAED,SAAS,CAAC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAa;IAC/D,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAkC;IAExF,SAAS,CAAC,iBAAiB,IAAI,iBAAiB;IAyBhD,OAAO,CAAC,aAAa;IAOd,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAK9C,YAAY,CAAC,SAAS,EAAE,MAAM;IAKrC,IACI,eAAe,IAAI,OAAO,CAE7B;IAID,uBAAuB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,gBAAgB;IAKtE,SAAS,KAAK,MAAM,IAAI,OAAO,GAAG,IAAI,CAErC;IAED;;;;;OAKG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE,EAAE,IAAI,GAAE,8BAA8B,CAAC,MAAM,CAAa;IA+B7F;;;OAGG;IACH,WAAW;IAOX;;;OAGG;cACa,oBAAoB,CAClC,OAAO,EAAE,iBAAiB,EAC1B,SAAS,GAAE,OAAc,EACzB,WAAW,GAAE,OAAc,GAC1B,OAAO,CAAC,OAAO,CAAC;CAqDpB;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,4BAA4B;IACrE,SAAS,CAAC,mBAAmB,UAAS;IAEtC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAa;IAEtC,SAAS,CAAC,aAAa,EAAE,kBAAkB,GAAG,qBAAqB,CAIjE;IAEF,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAGrC,SAAS,CAAC,aAAa,EAAE,YAAY,GAAG,SAAS,CAAC;IAElD,iBAAiB;IAKjB,oBAAoB;IAKpB,SAAS,CAAC,qBAAqB;IAgB/B,SAAS,CAAC,yBAAyB;IAKnC,SAAS,CAAC,8BAA8B,CACtC,cAAc,EAAE,aAAa,EAAE,EAC/B,0BAA0B,EAAE,QAAQ,GACnC,MAAM,EAAE;IAsEX,SAAS,CAAC,mBAAmB,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE,QAAQ,GAAE,MAAU;IAmCvE,SAAS,CAAC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE;IAgBhD,SAAS,CAAC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE;IAuBhD,SAAS,CAAC,sBAAsB;IAyChC,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,wBAAwB;IAkBhC,SAAS,CAAC,gBAAgB,CAAC,aAAa,EAAE,kBAAkB,GAAG,GAAG;IAIlE,SAAS,CAAC,qBAAqB,CAAC,aAAa,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI;IAI3F;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAyBtB,SAAS,KAAK,UAAU,IAAI,OAAO,CAGlC;IAED,QAAQ;IAIR,OAAO;IAIP,kBAAkB;IAIlB,OAAO;IAIP;;;OAGG;IACI,eAAe,CAAC,YAAY,EAAE,OAAO;IAS5C;;OAEG;IACI,cAAc,IAAI,OAAO;IAIhC;;;OAGG;IACH,SAAS,CAAC,wBAAwB,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,GAAG,CAAC,GAAG,SAAS,GAAG;QAC3E,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,CAAC,CAAC;KACZ;IAaD;;;;OAIG;IACI,4BAA4B,CAAC,YAAY,EAAE,OAAO,GAAG,GAAG,EAAE;CAiElE"}
|
|
@@ -46,8 +46,7 @@ export class GenesisGridDatasourceElement extends DatasourceEventHandler(Foundat
|
|
|
46
46
|
this.criteriaFromFilters = new Map();
|
|
47
47
|
this.update = new BehaviorSubject(new Map());
|
|
48
48
|
}
|
|
49
|
-
|
|
50
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
49
|
+
/* Returns the `row-id` attribute, depending on the resource type.
|
|
51
50
|
* @remarks Will favour the `row-id` attribute if set.
|
|
52
51
|
* @internal
|
|
53
52
|
*/
|
|
@@ -296,7 +295,7 @@ __decorate([
|
|
|
296
295
|
volatile
|
|
297
296
|
], GenesisGridDatasourceElement.prototype, "isRequestServer", null);
|
|
298
297
|
/**
|
|
299
|
-
* The operation type for the
|
|
298
|
+
* The operation type for the {@link @genesislcap/grid-pro#GridProBaseDatasource.mapTransaction} method.
|
|
300
299
|
* @internal
|
|
301
300
|
*/
|
|
302
301
|
export var OperationType;
|
package/dist/grid-pro.api.json
CHANGED
|
@@ -8104,6 +8104,36 @@
|
|
|
8104
8104
|
"isProtected": false,
|
|
8105
8105
|
"isAbstract": false
|
|
8106
8106
|
},
|
|
8107
|
+
{
|
|
8108
|
+
"kind": "Property",
|
|
8109
|
+
"canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#rowId:member",
|
|
8110
|
+
"docComment": "",
|
|
8111
|
+
"excerptTokens": [
|
|
8112
|
+
{
|
|
8113
|
+
"kind": "Content",
|
|
8114
|
+
"text": "protected get rowId(): "
|
|
8115
|
+
},
|
|
8116
|
+
{
|
|
8117
|
+
"kind": "Content",
|
|
8118
|
+
"text": "string"
|
|
8119
|
+
},
|
|
8120
|
+
{
|
|
8121
|
+
"kind": "Content",
|
|
8122
|
+
"text": ";"
|
|
8123
|
+
}
|
|
8124
|
+
],
|
|
8125
|
+
"isReadonly": true,
|
|
8126
|
+
"isOptional": false,
|
|
8127
|
+
"releaseTag": "Public",
|
|
8128
|
+
"name": "rowId",
|
|
8129
|
+
"propertyTypeTokenRange": {
|
|
8130
|
+
"startIndex": 1,
|
|
8131
|
+
"endIndex": 2
|
|
8132
|
+
},
|
|
8133
|
+
"isStatic": false,
|
|
8134
|
+
"isProtected": true,
|
|
8135
|
+
"isAbstract": false
|
|
8136
|
+
},
|
|
8107
8137
|
{
|
|
8108
8138
|
"kind": "Property",
|
|
8109
8139
|
"canonicalReference": "@genesislcap/grid-pro!GenesisGridDatasourceElement#rowIdAttr:member",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -1088,11 +1088,6 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
|
|
|
1088
1088
|
* @privateRemarks This attribute is shared across all datasources to ensure consistent behavior.
|
|
1089
1089
|
*/
|
|
1090
1090
|
restartOnReconnection: boolean;
|
|
1091
|
-
/**
|
|
1092
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
1093
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
1094
|
-
* @internal
|
|
1095
|
-
*/
|
|
1096
1091
|
protected get rowId(): string;
|
|
1097
1092
|
/**
|
|
1098
1093
|
* Returns whether the `row-id` attribute is the default one, depending on the resource type.
|
|
@@ -1159,11 +1154,7 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
1159
1154
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
1160
1155
|
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
|
1161
1156
|
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
1162
|
-
readonly attributes: NamedNodeMap;
|
|
1163
|
-
* Returns the `row-id` attribute, depending on the resource type.
|
|
1164
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
1165
|
-
* @internal
|
|
1166
|
-
*/
|
|
1157
|
+
readonly attributes: NamedNodeMap;
|
|
1167
1158
|
readonly classList: DOMTokenList;
|
|
1168
1159
|
className: string;
|
|
1169
1160
|
readonly clientHeight: number;
|
|
@@ -1241,10 +1232,6 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
1241
1232
|
readonly nodeName: string;
|
|
1242
1233
|
readonly nodeType: number;
|
|
1243
1234
|
nodeValue: string;
|
|
1244
|
-
/**
|
|
1245
|
-
* Override datasource initialization to handle errors properly.
|
|
1246
|
-
* @internal
|
|
1247
|
-
*/
|
|
1248
1235
|
readonly parentElement: HTMLElement;
|
|
1249
1236
|
readonly parentNode: ParentNode;
|
|
1250
1237
|
readonly previousSibling: ChildNode;
|
|
@@ -1297,17 +1284,16 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
1297
1284
|
ariaHasPopup: string;
|
|
1298
1285
|
ariaHidden: string;
|
|
1299
1286
|
ariaInvalid: string;
|
|
1300
|
-
ariaKeyShortcuts: string;
|
|
1301
|
-
* The operation type for the `GridProBaseDatasource.mapTransaction` method.
|
|
1302
|
-
* @internal
|
|
1303
|
-
*/
|
|
1287
|
+
ariaKeyShortcuts: string;
|
|
1304
1288
|
ariaLabel: string;
|
|
1305
1289
|
ariaLevel: string;
|
|
1306
1290
|
ariaLive: string;
|
|
1307
1291
|
ariaModal: string;
|
|
1308
1292
|
ariaMultiLine: string;
|
|
1309
1293
|
ariaMultiSelectable: string;
|
|
1310
|
-
ariaOrientation: string;
|
|
1294
|
+
ariaOrientation: string; /**
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1311
1297
|
ariaPlaceholder: string;
|
|
1312
1298
|
ariaPosInSet: string;
|
|
1313
1299
|
ariaPressed: string;
|
|
@@ -3946,7 +3932,7 @@ declare type OnlyFunctions<T> = {
|
|
|
3946
3932
|
};
|
|
3947
3933
|
|
|
3948
3934
|
/**
|
|
3949
|
-
* The operation type for the
|
|
3935
|
+
* The operation type for the {@link @genesislcap/grid-pro#GridProBaseDatasource.mapTransaction} method.
|
|
3950
3936
|
* @internal
|
|
3951
3937
|
*/
|
|
3952
3938
|
export declare enum OperationType {
|
|
@@ -40,6 +40,7 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
|
|
|
40
40
|
| [restartOnReconnection](./grid-pro.genesisgriddatasourceelement.restartonreconnection.md) | | boolean | Attribute to set whether the datasource should restart when it reconnects. |
|
|
41
41
|
| [reverse](./grid-pro.genesisgriddatasourceelement.reverse.md) | | boolean | |
|
|
42
42
|
| [rowDataMapper](./grid-pro.genesisgriddatasourceelement.rowdatamapper.md) | | Function | Allows grid data updates to be processed via and external function before applying in grid |
|
|
43
|
+
| [rowId](./grid-pro.genesisgriddatasourceelement.rowid.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | |
|
|
43
44
|
| [rowIdAttr](./grid-pro.genesisgriddatasourceelement.rowidattr.md) | | any | <p>Attribute to set an unique identifier for the row.</p><p>Defaults to <code>ROW_REF</code> or <code>RECORD_ID</code> depending on the resource type.</p> |
|
|
44
45
|
| [update](./grid-pro.genesisgriddatasourceelement.update.md) | <code>protected</code> | BehaviorSubject<Map<string, string>> | |
|
|
45
46
|
| [viewNumber](./grid-pro.genesisgriddatasourceelement.viewnumber.md) | | number | |
|
|
@@ -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) > [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) > [rowId](./grid-pro.genesisgriddatasourceelement.rowid.md)
|
|
4
|
+
|
|
5
|
+
## GenesisGridDatasourceElement.rowId property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected get rowId(): string;
|
|
11
|
+
```
|
package/docs/api-report.md
CHANGED
|
@@ -834,7 +834,7 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
|
|
|
834
834
|
// (undocumented)
|
|
835
835
|
reverse: boolean;
|
|
836
836
|
rowDataMapper: Function;
|
|
837
|
-
//
|
|
837
|
+
// (undocumented)
|
|
838
838
|
protected get rowId(): string;
|
|
839
839
|
rowIdAttr: any;
|
|
840
840
|
// (undocumented)
|
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.289.1
|
|
4
|
+
"version": "14.289.1",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -38,20 +38,20 @@
|
|
|
38
38
|
}
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@genesislcap/foundation-testing": "14.289.1
|
|
42
|
-
"@genesislcap/genx": "14.289.1
|
|
43
|
-
"@genesislcap/rollup-builder": "14.289.1
|
|
44
|
-
"@genesislcap/ts-builder": "14.289.1
|
|
45
|
-
"@genesislcap/uvu-playwright-builder": "14.289.1
|
|
46
|
-
"@genesislcap/vite-builder": "14.289.1
|
|
47
|
-
"@genesislcap/webpack-builder": "14.289.1
|
|
41
|
+
"@genesislcap/foundation-testing": "14.289.1",
|
|
42
|
+
"@genesislcap/genx": "14.289.1",
|
|
43
|
+
"@genesislcap/rollup-builder": "14.289.1",
|
|
44
|
+
"@genesislcap/ts-builder": "14.289.1",
|
|
45
|
+
"@genesislcap/uvu-playwright-builder": "14.289.1",
|
|
46
|
+
"@genesislcap/vite-builder": "14.289.1",
|
|
47
|
+
"@genesislcap/webpack-builder": "14.289.1",
|
|
48
48
|
"rimraf": "^5.0.0"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@genesislcap/foundation-comms": "14.289.1
|
|
52
|
-
"@genesislcap/foundation-logger": "14.289.1
|
|
53
|
-
"@genesislcap/foundation-ui": "14.289.1
|
|
54
|
-
"@genesislcap/foundation-utils": "14.289.1
|
|
51
|
+
"@genesislcap/foundation-comms": "14.289.1",
|
|
52
|
+
"@genesislcap/foundation-logger": "14.289.1",
|
|
53
|
+
"@genesislcap/foundation-ui": "14.289.1",
|
|
54
|
+
"@genesislcap/foundation-utils": "14.289.1",
|
|
55
55
|
"@microsoft/fast-colors": "5.3.1",
|
|
56
56
|
"@microsoft/fast-components": "2.30.6",
|
|
57
57
|
"@microsoft/fast-element": "1.14.0",
|
|
@@ -77,5 +77,5 @@
|
|
|
77
77
|
"access": "public"
|
|
78
78
|
},
|
|
79
79
|
"customElements": "dist/custom-elements.json",
|
|
80
|
-
"gitHead": "
|
|
80
|
+
"gitHead": "db2f7a2aba6d628296a52a0eebb8b4cadcc829aa"
|
|
81
81
|
}
|