@genesislcap/foundation-entity-management 14.19.0 → 14.20.0-bny.19
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 +137 -37
- package/dist/dts/entities/entities.d.ts +18 -12
- package/dist/dts/entities/entities.d.ts.map +1 -1
- package/dist/dts/entities/entities.styles.d.ts.map +1 -1
- package/dist/dts/entities/entities.template.d.ts.map +1 -1
- package/dist/dts/list/list.d.ts +0 -2
- package/dist/dts/list/list.d.ts.map +1 -1
- package/dist/dts/list/list.styles.d.ts.map +1 -1
- package/dist/dts/list/list.template.d.ts +0 -23
- package/dist/dts/list/list.template.d.ts.map +1 -1
- package/dist/dts/utils/index.d.ts +26 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/esm/entities/entities.js +27 -5
- package/dist/esm/entities/entities.styles.js +6 -0
- package/dist/esm/entities/entities.template.js +16 -3
- package/dist/esm/list/list.js +2 -7
- package/dist/esm/list/list.styles.js +0 -6
- package/dist/esm/list/list.template.js +0 -35
- package/dist/esm/utils/index.js +25 -0
- package/dist/foundation-entity-management.api.json +167 -0
- package/dist/foundation-entity-management.d.ts +45 -12
- package/docs/api/foundation-entity-management.buttoncellrenderer.md +34 -0
- package/docs/api/foundation-entity-management.entitymanagement.create.md +17 -0
- package/docs/api/foundation-entity-management.entitymanagement.criteriachanged.md +22 -0
- package/docs/api/foundation-entity-management.entitymanagement.defaultentityvalues.md +11 -0
- package/docs/api/foundation-entity-management.entitymanagement.md +4 -0
- package/docs/api/foundation-entity-management.entitymanagement.modalposition.md +13 -0
- package/docs/api/foundation-entity-management.md +1 -0
- package/docs/api-report.md +31 -0
- package/package.json +13 -13
package/dist/esm/list/list.js
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { __awaiter, __decorate } from "tslib";
|
|
2
2
|
import { Events } from '@ag-grid-community/core';
|
|
3
3
|
import { attr, customElement, FASTElement, observable } from '@microsoft/fast-element';
|
|
4
|
+
import { buttonCellRenderer } from '../utils';
|
|
4
5
|
import { listStyles } from './list.styles';
|
|
5
|
-
import {
|
|
6
|
+
import { listTemplate } from './list.template';
|
|
6
7
|
let List = class List extends FASTElement {
|
|
7
8
|
constructor() {
|
|
8
9
|
super(...arguments);
|
|
@@ -56,9 +57,6 @@ let List = class List extends FASTElement {
|
|
|
56
57
|
select(e) {
|
|
57
58
|
this.$emit('rowSelected', e);
|
|
58
59
|
}
|
|
59
|
-
create() {
|
|
60
|
-
this.$emit('edit-entity');
|
|
61
|
-
}
|
|
62
60
|
delete(e) {
|
|
63
61
|
return __awaiter(this, void 0, void 0, function* () {
|
|
64
62
|
this.$emit('delete-entity', e);
|
|
@@ -92,9 +90,6 @@ __decorate([
|
|
|
92
90
|
__decorate([
|
|
93
91
|
observable
|
|
94
92
|
], List.prototype, "actionButtonsConfig", void 0);
|
|
95
|
-
__decorate([
|
|
96
|
-
observable
|
|
97
|
-
], List.prototype, "createEvent", void 0);
|
|
98
93
|
__decorate([
|
|
99
94
|
observable
|
|
100
95
|
], List.prototype, "deleteEvent", void 0);
|
|
@@ -1,40 +1,5 @@
|
|
|
1
1
|
import { html, ref, repeat, when } from '@microsoft/fast-element';
|
|
2
|
-
export const buttonCellRenderer = (title, clickHandler) => ({
|
|
3
|
-
width: 100,
|
|
4
|
-
pinned: 'right',
|
|
5
|
-
enableCellChangeFlash: false,
|
|
6
|
-
cellStyle: { padding: '0', lineHeight: '25px' },
|
|
7
|
-
filter: false,
|
|
8
|
-
suppressFiltersToolPanel: true,
|
|
9
|
-
suppressColumnsToolPanel: true,
|
|
10
|
-
headerName: '',
|
|
11
|
-
minWidth: 100,
|
|
12
|
-
maxWidth: 100,
|
|
13
|
-
cellRendererSelector: (params) => params.node.group
|
|
14
|
-
? undefined
|
|
15
|
-
: {
|
|
16
|
-
component: 'action',
|
|
17
|
-
params: {
|
|
18
|
-
actionClick: clickHandler,
|
|
19
|
-
actionName: title,
|
|
20
|
-
appearance: 'accent',
|
|
21
|
-
},
|
|
22
|
-
},
|
|
23
|
-
});
|
|
24
2
|
export const listTemplate = html `
|
|
25
|
-
<div class="heading">
|
|
26
|
-
<h3 data-test-id="title">${(x) => x.title}</h3>
|
|
27
|
-
${when((x) => x.createEvent, html `
|
|
28
|
-
<zero-button
|
|
29
|
-
appearance="accent"
|
|
30
|
-
@click=${(x) => x.create()}
|
|
31
|
-
?disabled="${(x) => x.addDisabled}"
|
|
32
|
-
data-test-id="button-create"
|
|
33
|
-
>
|
|
34
|
-
Add
|
|
35
|
-
</zero-button>
|
|
36
|
-
`)}
|
|
37
|
-
</div>
|
|
38
3
|
<div class="container">
|
|
39
4
|
${when((x) => x.enableFilterBar, html `
|
|
40
5
|
<zero-filter-bar
|
package/dist/esm/utils/index.js
CHANGED
|
@@ -1,2 +1,27 @@
|
|
|
1
1
|
export * from './formatting';
|
|
2
2
|
export * from './logger';
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export const buttonCellRenderer = (title, clickHandler) => ({
|
|
7
|
+
width: 100,
|
|
8
|
+
pinned: 'right',
|
|
9
|
+
enableCellChangeFlash: false,
|
|
10
|
+
cellStyle: { padding: '0', lineHeight: '25px' },
|
|
11
|
+
filter: false,
|
|
12
|
+
suppressFiltersToolPanel: true,
|
|
13
|
+
suppressColumnsToolPanel: true,
|
|
14
|
+
headerName: '',
|
|
15
|
+
minWidth: 100,
|
|
16
|
+
maxWidth: 100,
|
|
17
|
+
cellRendererSelector: (params) => params.node.group
|
|
18
|
+
? undefined
|
|
19
|
+
: {
|
|
20
|
+
component: 'action',
|
|
21
|
+
params: {
|
|
22
|
+
actionClick: clickHandler,
|
|
23
|
+
actionName: title,
|
|
24
|
+
appearance: 'accent',
|
|
25
|
+
},
|
|
26
|
+
},
|
|
27
|
+
});
|
|
@@ -172,6 +172,29 @@
|
|
|
172
172
|
"name": "",
|
|
173
173
|
"preserveMemberOrder": false,
|
|
174
174
|
"members": [
|
|
175
|
+
{
|
|
176
|
+
"kind": "Variable",
|
|
177
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!buttonCellRenderer:var",
|
|
178
|
+
"docComment": "/**\n * @public\n */\n",
|
|
179
|
+
"excerptTokens": [
|
|
180
|
+
{
|
|
181
|
+
"kind": "Content",
|
|
182
|
+
"text": "buttonCellRenderer: "
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"kind": "Content",
|
|
186
|
+
"text": "(title: any, clickHandler: any) => {\n width: number;\n pinned: string;\n enableCellChangeFlash: boolean;\n cellStyle: {\n padding: string;\n lineHeight: string;\n };\n filter: boolean;\n suppressFiltersToolPanel: boolean;\n suppressColumnsToolPanel: boolean;\n headerName: string;\n minWidth: number;\n maxWidth: number;\n cellRendererSelector: (params: any) => {\n component: string;\n params: {\n actionClick: any;\n actionName: any;\n appearance: string;\n };\n };\n}"
|
|
187
|
+
}
|
|
188
|
+
],
|
|
189
|
+
"fileUrlPath": "src/utils/index.ts",
|
|
190
|
+
"isReadonly": true,
|
|
191
|
+
"releaseTag": "Public",
|
|
192
|
+
"name": "buttonCellRenderer",
|
|
193
|
+
"variableTypeTokenRange": {
|
|
194
|
+
"startIndex": 1,
|
|
195
|
+
"endIndex": 2
|
|
196
|
+
}
|
|
197
|
+
},
|
|
175
198
|
{
|
|
176
199
|
"kind": "TypeAlias",
|
|
177
200
|
"canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type",
|
|
@@ -334,6 +357,37 @@
|
|
|
334
357
|
"isProtected": true,
|
|
335
358
|
"isAbstract": false
|
|
336
359
|
},
|
|
360
|
+
{
|
|
361
|
+
"kind": "Method",
|
|
362
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#create:member(1)",
|
|
363
|
+
"docComment": "/**\n * Show the entity create form\n *\n * @public\n */\n",
|
|
364
|
+
"excerptTokens": [
|
|
365
|
+
{
|
|
366
|
+
"kind": "Content",
|
|
367
|
+
"text": "create(): "
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"kind": "Content",
|
|
371
|
+
"text": "void"
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"kind": "Content",
|
|
375
|
+
"text": ";"
|
|
376
|
+
}
|
|
377
|
+
],
|
|
378
|
+
"isStatic": false,
|
|
379
|
+
"returnTypeTokenRange": {
|
|
380
|
+
"startIndex": 1,
|
|
381
|
+
"endIndex": 2
|
|
382
|
+
},
|
|
383
|
+
"releaseTag": "Public",
|
|
384
|
+
"isProtected": false,
|
|
385
|
+
"overloadIndex": 1,
|
|
386
|
+
"parameters": [],
|
|
387
|
+
"isOptional": false,
|
|
388
|
+
"isAbstract": false,
|
|
389
|
+
"name": "create"
|
|
390
|
+
},
|
|
337
391
|
{
|
|
338
392
|
"kind": "Property",
|
|
339
393
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createEvent:member",
|
|
@@ -394,6 +448,59 @@
|
|
|
394
448
|
"isProtected": false,
|
|
395
449
|
"isAbstract": false
|
|
396
450
|
},
|
|
451
|
+
{
|
|
452
|
+
"kind": "Method",
|
|
453
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#criteriaChanged:member(1)",
|
|
454
|
+
"docComment": "",
|
|
455
|
+
"excerptTokens": [
|
|
456
|
+
{
|
|
457
|
+
"kind": "Content",
|
|
458
|
+
"text": "criteriaChanged(e: "
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"kind": "Reference",
|
|
462
|
+
"text": "CustomEvent",
|
|
463
|
+
"canonicalReference": "!CustomEvent:interface"
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"kind": "Content",
|
|
467
|
+
"text": "<string>"
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"kind": "Content",
|
|
471
|
+
"text": "): "
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"kind": "Content",
|
|
475
|
+
"text": "void"
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"kind": "Content",
|
|
479
|
+
"text": ";"
|
|
480
|
+
}
|
|
481
|
+
],
|
|
482
|
+
"isStatic": false,
|
|
483
|
+
"returnTypeTokenRange": {
|
|
484
|
+
"startIndex": 4,
|
|
485
|
+
"endIndex": 5
|
|
486
|
+
},
|
|
487
|
+
"releaseTag": "Public",
|
|
488
|
+
"isProtected": false,
|
|
489
|
+
"overloadIndex": 1,
|
|
490
|
+
"parameters": [
|
|
491
|
+
{
|
|
492
|
+
"parameterName": "e",
|
|
493
|
+
"parameterTypeTokenRange": {
|
|
494
|
+
"startIndex": 1,
|
|
495
|
+
"endIndex": 3
|
|
496
|
+
},
|
|
497
|
+
"isOptional": false
|
|
498
|
+
}
|
|
499
|
+
],
|
|
500
|
+
"isOptional": false,
|
|
501
|
+
"isAbstract": false,
|
|
502
|
+
"name": "criteriaChanged"
|
|
503
|
+
},
|
|
397
504
|
{
|
|
398
505
|
"kind": "Property",
|
|
399
506
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#datasourceConfig:member",
|
|
@@ -457,6 +564,36 @@
|
|
|
457
564
|
"isAbstract": false,
|
|
458
565
|
"name": "deepClone"
|
|
459
566
|
},
|
|
567
|
+
{
|
|
568
|
+
"kind": "Property",
|
|
569
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#defaultEntityValues:member",
|
|
570
|
+
"docComment": "",
|
|
571
|
+
"excerptTokens": [
|
|
572
|
+
{
|
|
573
|
+
"kind": "Content",
|
|
574
|
+
"text": "defaultEntityValues: "
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"kind": "Content",
|
|
578
|
+
"text": "any"
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"kind": "Content",
|
|
582
|
+
"text": ";"
|
|
583
|
+
}
|
|
584
|
+
],
|
|
585
|
+
"isReadonly": false,
|
|
586
|
+
"isOptional": false,
|
|
587
|
+
"releaseTag": "Public",
|
|
588
|
+
"name": "defaultEntityValues",
|
|
589
|
+
"propertyTypeTokenRange": {
|
|
590
|
+
"startIndex": 1,
|
|
591
|
+
"endIndex": 2
|
|
592
|
+
},
|
|
593
|
+
"isStatic": false,
|
|
594
|
+
"isProtected": false,
|
|
595
|
+
"isAbstract": false
|
|
596
|
+
},
|
|
460
597
|
{
|
|
461
598
|
"kind": "Property",
|
|
462
599
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deleteEvent:member",
|
|
@@ -758,6 +895,36 @@
|
|
|
758
895
|
"isProtected": false,
|
|
759
896
|
"isAbstract": false
|
|
760
897
|
},
|
|
898
|
+
{
|
|
899
|
+
"kind": "Property",
|
|
900
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalPosition:member",
|
|
901
|
+
"docComment": "/**\n * Determines where the modal dialog will appear on screen\n *\n * @public\n */\n",
|
|
902
|
+
"excerptTokens": [
|
|
903
|
+
{
|
|
904
|
+
"kind": "Content",
|
|
905
|
+
"text": "modalPosition: "
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"kind": "Content",
|
|
909
|
+
"text": "'centre' | 'left' | 'right'"
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"kind": "Content",
|
|
913
|
+
"text": ";"
|
|
914
|
+
}
|
|
915
|
+
],
|
|
916
|
+
"isReadonly": false,
|
|
917
|
+
"isOptional": false,
|
|
918
|
+
"releaseTag": "Public",
|
|
919
|
+
"name": "modalPosition",
|
|
920
|
+
"propertyTypeTokenRange": {
|
|
921
|
+
"startIndex": 1,
|
|
922
|
+
"endIndex": 2
|
|
923
|
+
},
|
|
924
|
+
"isStatic": false,
|
|
925
|
+
"isProtected": false,
|
|
926
|
+
"isAbstract": false
|
|
927
|
+
},
|
|
761
928
|
{
|
|
762
929
|
"kind": "Property",
|
|
763
930
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#persistColumnStateKey:member",
|
|
@@ -15,6 +15,33 @@ import { RouterConfiguration } from '@microsoft/fast-router';
|
|
|
15
15
|
import { Session } from '@genesislcap/foundation-comms';
|
|
16
16
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
17
17
|
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
export declare const buttonCellRenderer: (title: any, clickHandler: any) => {
|
|
22
|
+
width: number;
|
|
23
|
+
pinned: string;
|
|
24
|
+
enableCellChangeFlash: boolean;
|
|
25
|
+
cellStyle: {
|
|
26
|
+
padding: string;
|
|
27
|
+
lineHeight: string;
|
|
28
|
+
};
|
|
29
|
+
filter: boolean;
|
|
30
|
+
suppressFiltersToolPanel: boolean;
|
|
31
|
+
suppressColumnsToolPanel: boolean;
|
|
32
|
+
headerName: string;
|
|
33
|
+
minWidth: number;
|
|
34
|
+
maxWidth: number;
|
|
35
|
+
cellRendererSelector: (params: any) => {
|
|
36
|
+
component: string;
|
|
37
|
+
params: {
|
|
38
|
+
actionClick: any;
|
|
39
|
+
actionName: any;
|
|
40
|
+
appearance: string;
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
|
|
18
45
|
/**
|
|
19
46
|
* The attribute which is set to configure the resource that the entity manager is working with
|
|
20
47
|
*
|
|
@@ -163,6 +190,7 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
163
190
|
*/
|
|
164
191
|
editedEntity: any;
|
|
165
192
|
submitting: boolean;
|
|
193
|
+
defaultEntityValues: any;
|
|
166
194
|
/**
|
|
167
195
|
* String which contains the text of the popup modal when the user is adding or editing an entity
|
|
168
196
|
*/
|
|
@@ -173,6 +201,11 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
173
201
|
sizeColumnsToFit: boolean;
|
|
174
202
|
enableFilterBar: boolean;
|
|
175
203
|
enableCellFlashing: boolean;
|
|
204
|
+
/**
|
|
205
|
+
* Determines where the modal dialog will appear on screen
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
modalPosition: 'centre' | 'left' | 'right';
|
|
176
209
|
/**
|
|
177
210
|
* Set up the web component
|
|
178
211
|
* @internal
|
|
@@ -192,6 +225,11 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
192
225
|
* @public
|
|
193
226
|
*/
|
|
194
227
|
submitEntityChanges(e: CustomEvent): Promise<void>;
|
|
228
|
+
/**
|
|
229
|
+
* Show the entity create form
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
create(): void;
|
|
195
233
|
/**
|
|
196
234
|
* Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
|
|
197
235
|
*
|
|
@@ -208,6 +246,7 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
208
246
|
private editEntity;
|
|
209
247
|
private readEntity;
|
|
210
248
|
closeModal(): void;
|
|
249
|
+
criteriaChanged(e: CustomEvent<string>): void;
|
|
211
250
|
/**
|
|
212
251
|
* Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
|
|
213
252
|
*
|
|
@@ -337,19 +376,7 @@ declare const EntityManagement_base: (new (...args: any[]) => {
|
|
|
337
376
|
requestPointerLock(): void;
|
|
338
377
|
scroll(options?: ScrollToOptions): void;
|
|
339
378
|
scroll(x: number, y: number): void;
|
|
340
|
-
/**
|
|
341
|
-
* Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
|
|
342
|
-
*
|
|
343
|
-
* @param e - CustomEvent which contains data about the selected entity. If the row is not selected then the reference will be set to an empty object.
|
|
344
|
-
* @internal
|
|
345
|
-
*/
|
|
346
379
|
scrollBy(options?: ScrollToOptions): void;
|
|
347
|
-
/**
|
|
348
|
-
* Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
|
|
349
|
-
*
|
|
350
|
-
* @param e - CustomEvent which contains data about the selected entity. If the row is not selected then the reference will be set to an empty object.
|
|
351
|
-
* @internal
|
|
352
|
-
*/
|
|
353
380
|
scrollBy(x: number, y: number): void;
|
|
354
381
|
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
355
382
|
scrollTo(options?: ScrollToOptions): void;
|
|
@@ -399,6 +426,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
|
|
|
399
426
|
readonly DOCUMENT_POSITION_FOLLOWING: number;
|
|
400
427
|
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
|
|
401
428
|
readonly DOCUMENT_POSITION_PRECEDING: number;
|
|
429
|
+
/**
|
|
430
|
+
* Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
|
|
431
|
+
*
|
|
432
|
+
* @param e - CustomEvent where `e.detail` contains data to update the selectedEntity reference with the entity to delete.
|
|
433
|
+
* @internal
|
|
434
|
+
*/
|
|
402
435
|
readonly DOCUMENT_TYPE_NODE: number;
|
|
403
436
|
readonly ELEMENT_NODE: number;
|
|
404
437
|
readonly ENTITY_NODE: number;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [buttonCellRenderer](./foundation-entity-management.buttoncellrenderer.md)
|
|
4
|
+
|
|
5
|
+
## buttonCellRenderer variable
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
buttonCellRenderer: (title: any, clickHandler: any) => {
|
|
12
|
+
width: number;
|
|
13
|
+
pinned: string;
|
|
14
|
+
enableCellChangeFlash: boolean;
|
|
15
|
+
cellStyle: {
|
|
16
|
+
padding: string;
|
|
17
|
+
lineHeight: string;
|
|
18
|
+
};
|
|
19
|
+
filter: boolean;
|
|
20
|
+
suppressFiltersToolPanel: boolean;
|
|
21
|
+
suppressColumnsToolPanel: boolean;
|
|
22
|
+
headerName: string;
|
|
23
|
+
minWidth: number;
|
|
24
|
+
maxWidth: number;
|
|
25
|
+
cellRendererSelector: (params: any) => {
|
|
26
|
+
component: string;
|
|
27
|
+
params: {
|
|
28
|
+
actionClick: any;
|
|
29
|
+
actionName: any;
|
|
30
|
+
appearance: string;
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [create](./foundation-entity-management.entitymanagement.create.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.create() method
|
|
6
|
+
|
|
7
|
+
Show the entity create form
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
create(): void;
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [criteriaChanged](./foundation-entity-management.entitymanagement.criteriachanged.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.criteriaChanged() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
criteriaChanged(e: CustomEvent<string>): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| e | CustomEvent<string> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.defaultEntityValues property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
defaultEntityValues: any;
|
|
11
|
+
```
|
|
@@ -41,6 +41,7 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
41
41
|
| [createEvent](./foundation-entity-management.entitymanagement.createevent.md) | | string | Name of the event handler on the Genesis server which handles creating an entity |
|
|
42
42
|
| [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md) | | any | |
|
|
43
43
|
| [datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md) | | [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md) | The configuration which is used when interacting with the resource on the backend |
|
|
44
|
+
| [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md) | | any | |
|
|
44
45
|
| [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md) | | string | Name of the event handler on the Genesis server which handles deleting the entity |
|
|
45
46
|
| [editDialogTitle](./foundation-entity-management.entitymanagement.editdialogtitle.md) | | string | String which contains the text of the popup modal when the user is adding or editing an entity |
|
|
46
47
|
| [editedEntity](./foundation-entity-management.entitymanagement.editedentity.md) | | any | Disables the form while enabled to stop the user dispatching a large number of duplicate events |
|
|
@@ -50,6 +51,7 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
50
51
|
| [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md) | | boolean | |
|
|
51
52
|
| [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md) | | string | Label for the entity which has usages such as being shown in the title of the modal wen editing the entity |
|
|
52
53
|
| [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md) | | any | |
|
|
54
|
+
| [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md) | | 'centre' \| 'left' \| 'right' | Determines where the modal dialog will appear on screen |
|
|
53
55
|
| [persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md) | | string | This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it. |
|
|
54
56
|
| [readEvent](./foundation-entity-management.entitymanagement.readevent.md) | | string | |
|
|
55
57
|
| [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md) | | (...args: any\[\]) => {} | |
|
|
@@ -67,6 +69,8 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
67
69
|
| Method | Modifiers | Description |
|
|
68
70
|
| --- | --- | --- |
|
|
69
71
|
| [closeModal()](./foundation-entity-management.entitymanagement.closemodal.md) | | |
|
|
72
|
+
| [create()](./foundation-entity-management.entitymanagement.create.md) | | Show the entity create form |
|
|
73
|
+
| [criteriaChanged(e)](./foundation-entity-management.entitymanagement.criteriachanged.md) | | |
|
|
70
74
|
| [deepClone()](./foundation-entity-management.entitymanagement.deepclone.md) | | Override the deepClone method to ensure that observable attributes are cloned |
|
|
71
75
|
| [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) | | |
|
|
72
76
|
| [submitEntityChanges(e)](./foundation-entity-management.entitymanagement.submitentitychanges.md) | | Event handler for when the user submits the action for the currently open form, either editing or adding the entity |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.modalPosition property
|
|
6
|
+
|
|
7
|
+
Determines where the modal dialog will appear on screen
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
modalPosition: 'centre' | 'left' | 'right';
|
|
13
|
+
```
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
| Variable | Description |
|
|
19
19
|
| --- | --- |
|
|
20
|
+
| [buttonCellRenderer](./foundation-entity-management.buttoncellrenderer.md) | |
|
|
20
21
|
| [getErrorFormat](./foundation-entity-management.geterrorformat.md) | Format the error as a string with a different format depending on whether <code>err</code> has a <code>FIELD</code> property or not |
|
|
21
22
|
| [logger](./foundation-entity-management.logger.md) | |
|
|
22
23
|
| [UsersColumnConfig](./foundation-entity-management.userscolumnconfig.md) | Defines the default columns which are present on the user management component |
|
package/docs/api-report.md
CHANGED
|
@@ -21,6 +21,31 @@ import { RouterConfiguration } from '@microsoft/fast-router';
|
|
|
21
21
|
import { Session } from '@genesislcap/foundation-comms';
|
|
22
22
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
23
23
|
|
|
24
|
+
// @public (undocumented)
|
|
25
|
+
export const buttonCellRenderer: (title: any, clickHandler: any) => {
|
|
26
|
+
width: number;
|
|
27
|
+
pinned: string;
|
|
28
|
+
enableCellChangeFlash: boolean;
|
|
29
|
+
cellStyle: {
|
|
30
|
+
padding: string;
|
|
31
|
+
lineHeight: string;
|
|
32
|
+
};
|
|
33
|
+
filter: boolean;
|
|
34
|
+
suppressFiltersToolPanel: boolean;
|
|
35
|
+
suppressColumnsToolPanel: boolean;
|
|
36
|
+
headerName: string;
|
|
37
|
+
minWidth: number;
|
|
38
|
+
maxWidth: number;
|
|
39
|
+
cellRendererSelector: (params: any) => {
|
|
40
|
+
component: string;
|
|
41
|
+
params: {
|
|
42
|
+
actionClick: any;
|
|
43
|
+
actionName: any;
|
|
44
|
+
appearance: string;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
};
|
|
48
|
+
|
|
24
49
|
// @public
|
|
25
50
|
export type DatasourceConfiguration = Omit<DatasourceOptions, 'resourceName' | 'request'>;
|
|
26
51
|
|
|
@@ -39,11 +64,16 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
39
64
|
protected connect: Connect;
|
|
40
65
|
// @internal
|
|
41
66
|
connectedCallback(): Promise<void>;
|
|
67
|
+
create(): void;
|
|
42
68
|
createEvent: string;
|
|
43
69
|
// (undocumented)
|
|
44
70
|
createFormUiSchema: any;
|
|
71
|
+
// (undocumented)
|
|
72
|
+
criteriaChanged(e: CustomEvent<string>): void;
|
|
45
73
|
datasourceConfig: DatasourceConfiguration;
|
|
46
74
|
deepClone(): Node;
|
|
75
|
+
// (undocumented)
|
|
76
|
+
defaultEntityValues: any;
|
|
47
77
|
// @internal
|
|
48
78
|
deleteEntity(e: CustomEvent): Promise<void>;
|
|
49
79
|
deleteEvent: string;
|
|
@@ -68,6 +98,7 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
68
98
|
formResourceName: string;
|
|
69
99
|
// (undocumented)
|
|
70
100
|
formUiSchema: any;
|
|
101
|
+
modalPosition: 'centre' | 'left' | 'right';
|
|
71
102
|
persistColumnStateKey: string;
|
|
72
103
|
// (undocumented)
|
|
73
104
|
readEvent: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-entity-management",
|
|
3
3
|
"description": "Genesis Foundation Entity Management",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.20.0-bny.19",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -46,8 +46,8 @@
|
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@custom-elements-manifest/analyzer": "^0.8.2",
|
|
49
|
-
"@genesislcap/foundation-testing": "
|
|
50
|
-
"@genesislcap/genx": "
|
|
49
|
+
"@genesislcap/foundation-testing": "14.20.0-bny.19",
|
|
50
|
+
"@genesislcap/genx": "14.20.0-bny.19",
|
|
51
51
|
"@microsoft/api-documenter": "^7.19.13",
|
|
52
52
|
"@microsoft/api-extractor": "^7.31.1",
|
|
53
53
|
"@playwright/test": "^1.18.1",
|
|
@@ -90,15 +90,15 @@
|
|
|
90
90
|
"webpack-merge": "^5.7.3"
|
|
91
91
|
},
|
|
92
92
|
"dependencies": {
|
|
93
|
-
"@genesislcap/foundation-comms": "
|
|
94
|
-
"@genesislcap/foundation-errors": "
|
|
95
|
-
"@genesislcap/foundation-forms": "
|
|
96
|
-
"@genesislcap/foundation-login": "
|
|
97
|
-
"@genesislcap/foundation-ui": "
|
|
98
|
-
"@genesislcap/foundation-utils": "
|
|
99
|
-
"@genesislcap/foundation-zero": "
|
|
100
|
-
"@genesislcap/foundation-zero-grid-pro": "
|
|
101
|
-
"@genesislcap/grid-pro": "
|
|
93
|
+
"@genesislcap/foundation-comms": "14.20.0-bny.19",
|
|
94
|
+
"@genesislcap/foundation-errors": "14.20.0-bny.19",
|
|
95
|
+
"@genesislcap/foundation-forms": "14.20.0-bny.19",
|
|
96
|
+
"@genesislcap/foundation-login": "14.20.0-bny.19",
|
|
97
|
+
"@genesislcap/foundation-ui": "14.20.0-bny.19",
|
|
98
|
+
"@genesislcap/foundation-utils": "14.20.0-bny.19",
|
|
99
|
+
"@genesislcap/foundation-zero": "14.20.0-bny.19",
|
|
100
|
+
"@genesislcap/foundation-zero-grid-pro": "14.20.0-bny.19",
|
|
101
|
+
"@genesislcap/grid-pro": "14.20.0-bny.19",
|
|
102
102
|
"@microsoft/fast-components": "^2.21.3",
|
|
103
103
|
"@microsoft/fast-element": "^1.7.0",
|
|
104
104
|
"@microsoft/fast-foundation": "^2.33.2",
|
|
@@ -119,5 +119,5 @@
|
|
|
119
119
|
"access": "public"
|
|
120
120
|
},
|
|
121
121
|
"customElements": "dist/custom-elements.json",
|
|
122
|
-
"gitHead": "
|
|
122
|
+
"gitHead": "6055bc907ba47a7d9597017c2c850d3d59dff831"
|
|
123
123
|
}
|