@adaptabletools/adaptable-plugin-master-detail-aggrid 18.0.7 → 18.0.9
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 +9 -61
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -14,69 +14,13 @@ The `masterDetailAgGridPlugin` has 2 properties:
|
|
|
14
14
|
|
|
15
15
|
- *onDetailInit: (api: AdaptableApi) => void* - an optional function which will be called whenever a Detail grid is opened (essentially initialised), providing you with the AdaptableApi instance for full programmatic access to all Adaptable features.
|
|
16
16
|
|
|
17
|
-
### Example
|
|
18
|
-
|
|
19
|
-
We have set up a Master-Detail grid in AG Grid and the Adaptable Options object for the Master grid in the normal way.
|
|
20
|
-
|
|
21
|
-
And we have supplied the detail grid Adaptable Options in the plugins section. Here we create a Format Column in Predefined Config to be used in all Detail grids.
|
|
22
|
-
|
|
23
|
-
```ts
|
|
24
|
-
// typical AG Grid GridOptions object but popuplated for use in a Master-Detail grid
|
|
25
|
-
// for more information see: https://www.ag-grid.com/javascript-grid-master-detail/
|
|
26
|
-
const gridOptions: GridOptions = {
|
|
27
|
-
columnDefs,
|
|
28
|
-
rowData,
|
|
29
|
-
masterDetail: true,
|
|
30
|
-
detailCellRendererParams: {
|
|
31
|
-
detailGridOptions: {
|
|
32
|
-
columnDefs: detailColumnDefs,
|
|
33
|
-
},
|
|
34
|
-
getDetailRowData: function(params: any) {
|
|
35
|
-
params.successCallback(params.data.squad);
|
|
36
|
-
},
|
|
37
|
-
},
|
|
38
|
-
isRowMaster: function(dataItem) {
|
|
39
|
-
return dataItem ? dataItem.squad.length > 0 : false;
|
|
40
|
-
},
|
|
41
|
-
.......
|
|
42
|
-
};
|
|
43
|
-
|
|
44
|
-
const adaptableOptions: AdaptableOptions = {
|
|
45
|
-
primaryKey: 'name',
|
|
46
|
-
userName: 'Demo User',
|
|
47
|
-
adaptableId: 'Master Detail Demo - Master Grid',
|
|
48
|
-
predefinedConfig: demoConfig,
|
|
49
|
-
gridOptions: { ...gridOptions, modules: AllEnterpriseModules },
|
|
50
|
-
plugins: [
|
|
51
|
-
masterDetailAgGridPlugin({
|
|
52
|
-
detailAdaptableOptions: {
|
|
53
|
-
primaryKey: 'name',
|
|
54
|
-
adaptableId: 'Master Detail Demo - Detail Grid',
|
|
55
|
-
predefinedConfig: {
|
|
56
|
-
FormatColumn: {
|
|
57
|
-
FormatColumns: [
|
|
58
|
-
{
|
|
59
|
-
Scope: {
|
|
60
|
-
ColumnIds: ['age'],
|
|
61
|
-
},
|
|
62
|
-
Style: {
|
|
63
|
-
BackColor: '#ffffe0',
|
|
64
|
-
},
|
|
65
|
-
Rule: { BooleanExpression: '[age]> 30'}
|
|
66
|
-
},
|
|
67
|
-
],
|
|
68
|
-
},
|
|
69
|
-
},
|
|
70
|
-
},
|
|
71
|
-
}),
|
|
72
|
-
],
|
|
73
|
-
};
|
|
74
|
-
adaptableApi = await Adaptable.init(adaptableOptions);
|
|
75
|
-
```
|
|
76
|
-
|
|
77
17
|
## Requirements
|
|
78
18
|
|
|
79
|
-
This plugin depends on the AG Grid `@ag-grid-enterprise/master-detail` Module
|
|
19
|
+
This plugin depends on the AG Grid `@ag-grid-enterprise/master-detail` Module being present.
|
|
20
|
+
|
|
21
|
+
## Documentation & Demos
|
|
22
|
+
|
|
23
|
+
Full details of how to install and use the Master Detail plugin, together with many demos, can be found at [AdapTable Master / Detail Documentation](https://docs.adaptabletools.com/guide/handbook-master-detail)
|
|
80
24
|
|
|
81
25
|
|
|
82
26
|
## Help
|
|
@@ -90,3 +34,7 @@ General information about Adaptable Tools is available at our [Website](http://w
|
|
|
90
34
|
## Support
|
|
91
35
|
|
|
92
36
|
For all support enquiries please email [`support@adaptabletools.com`](mailto:support@adaptabletools.com) or [raise a Support Ticket](https://adaptabletools.zendesk.com/hc/en-us/requests/new).
|
|
37
|
+
|
|
38
|
+
## Licences
|
|
39
|
+
|
|
40
|
+
Information on AdapTable Licences can be found at [Licensing AdapTable for AG Grid](https://docs.adaptabletools.com/guide/licensing).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adaptabletools/adaptable-plugin-master-detail-aggrid",
|
|
3
|
-
"version": "18.0.
|
|
3
|
+
"version": "18.0.9",
|
|
4
4
|
"description": "",
|
|
5
5
|
"homepage": "http://www.adaptabletools.com/",
|
|
6
6
|
"author": {
|
|
@@ -10,10 +10,10 @@
|
|
|
10
10
|
"typings": "src/index.d.ts",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"tslib": "^2.3.0",
|
|
13
|
-
"@adaptabletools/adaptable": "18.0.
|
|
13
|
+
"@adaptabletools/adaptable": "18.0.9"
|
|
14
14
|
},
|
|
15
15
|
"peerDependencies": {
|
|
16
|
-
"@ag-grid-enterprise/master-detail": ">=31.1
|
|
16
|
+
"@ag-grid-enterprise/master-detail": ">=31.3.1"
|
|
17
17
|
},
|
|
18
18
|
"type": "module",
|
|
19
19
|
"module": "src/index.js"
|