@genesislcap/foundation-entity-management 14.24.4 → 14.25.0-bny.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.
Files changed (31) hide show
  1. package/dist/custom-elements.json +157 -37
  2. package/dist/dts/entities/entities.d.ts +21 -4
  3. package/dist/dts/entities/entities.d.ts.map +1 -1
  4. package/dist/dts/entities/entities.styles.d.ts.map +1 -1
  5. package/dist/dts/entities/entities.template.d.ts.map +1 -1
  6. package/dist/dts/list/list.d.ts +0 -2
  7. package/dist/dts/list/list.d.ts.map +1 -1
  8. package/dist/dts/list/list.styles.d.ts.map +1 -1
  9. package/dist/dts/list/list.template.d.ts +0 -23
  10. package/dist/dts/list/list.template.d.ts.map +1 -1
  11. package/dist/dts/utils/index.d.ts +26 -0
  12. package/dist/dts/utils/index.d.ts.map +1 -1
  13. package/dist/esm/entities/entities.js +28 -5
  14. package/dist/esm/entities/entities.styles.js +6 -0
  15. package/dist/esm/entities/entities.template.js +17 -3
  16. package/dist/esm/list/list.js +2 -7
  17. package/dist/esm/list/list.styles.js +0 -6
  18. package/dist/esm/list/list.template.js +0 -35
  19. package/dist/esm/utils/index.js +25 -0
  20. package/dist/foundation-entity-management.api.json +198 -0
  21. package/dist/foundation-entity-management.d.ts +48 -4
  22. package/docs/api/foundation-entity-management.buttoncellrenderer.md +34 -0
  23. package/docs/api/foundation-entity-management.entitymanagement.create.md +17 -0
  24. package/docs/api/foundation-entity-management.entitymanagement.criteriachanged.md +22 -0
  25. package/docs/api/foundation-entity-management.entitymanagement.defaultentityvalues.md +11 -0
  26. package/docs/api/foundation-entity-management.entitymanagement.editentityform.md +11 -0
  27. package/docs/api/foundation-entity-management.entitymanagement.md +5 -0
  28. package/docs/api/foundation-entity-management.entitymanagement.modalposition.md +13 -0
  29. package/docs/api/foundation-entity-management.md +1 -0
  30. package/docs/api-report.md +34 -0
  31. package/package.json +18 -44
@@ -3,28 +3,40 @@ import { html, ref, when } from '@microsoft/fast-element';
3
3
  import { List } from '../list';
4
4
  List;
5
5
  Form;
6
+ /**
7
+ * Default header for Entity Management screen
8
+ * @internal
9
+ */
10
+ const defaultHeader = html `
11
+ <h3>${(x) => x.title}</h3>
12
+ ${when((x) => x.createEvent, html `
13
+ <zero-button appearance="accent" @click=${(x, y) => x.create()}>Add</zero-button>
14
+ `)}
15
+ `;
6
16
  /**
7
17
  * Defines the html of the entity component as a ViewTemplate object
8
18
  * @typeParam EntityManagement - the {@link EntityManagement | class} the template is defined for
9
19
  */
10
20
  export const template = html `
11
21
  <div class="container">
22
+ <slot name="header" part="header">${defaultHeader}</slot>
12
23
  <entity-list
13
24
  title=${(x) => x.title}
14
25
  persist-column-state-key=${(x) => x.persistColumnStateKey}
15
26
  size-columns-to-fit=${(x) => x.sizeColumnsToFit}
16
27
  enable-filter-bar=${(x) => x.enableFilterBar}
17
28
  resourceName=${(x) => x.resourceName}
18
- :createEvent=${(x) => x.createEvent}
19
29
  :deleteEvent=${(x) => x.deleteEvent}
20
30
  :updateEvent=${(x) => x.updateEvent}
21
31
  :columns=${(x) => x.columns}
22
32
  :datasourceConfig=${(x) => x.datasourceConfig}
23
33
  data-test-id="entity-list"
24
- ></entity-list>
34
+ >
35
+ <slot name="header" slot="header">${defaultHeader}</slot>
36
+ </entity-list>
25
37
  <zero-modal
26
38
  ${ref('editEntityModal')}
27
- position="right"
39
+ position=${(x) => x.modalPosition}
28
40
  :onCloseCallback=${(x) => x.closeModal.bind(x)}
29
41
  data-test-id="edit-entity-modal"
30
42
  >
@@ -33,6 +45,8 @@ export const template = html `
33
45
  <slot name="edit">
34
46
  ${when((x) => x.editModalVisible, html `
35
47
  <foundation-form
48
+ part="form"
49
+ ${ref('editEntityForm')}
36
50
  resourceName=${(x) => x.formResourceName}
37
51
  :data=${(x) => x.editedEntity}
38
52
  :uischema=${(x) => x.formUiSchema}
@@ -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 { buttonCellRenderer, listTemplate } from './list.template';
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);
@@ -18,10 +18,4 @@ export const listStyles = css `
18
18
  height: inherit;
19
19
  width: 100%;
20
20
  }
21
-
22
- .heading {
23
- display: flex;
24
- justify-content: space-between;
25
- align-items: center;
26
- }
27
21
  `;
@@ -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
@@ -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",
@@ -370,6 +393,37 @@
370
393
  "isProtected": true,
371
394
  "isAbstract": false
372
395
  },
396
+ {
397
+ "kind": "Method",
398
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#create:member(1)",
399
+ "docComment": "/**\n * Show the entity create form\n *\n * @public\n */\n",
400
+ "excerptTokens": [
401
+ {
402
+ "kind": "Content",
403
+ "text": "create(): "
404
+ },
405
+ {
406
+ "kind": "Content",
407
+ "text": "void"
408
+ },
409
+ {
410
+ "kind": "Content",
411
+ "text": ";"
412
+ }
413
+ ],
414
+ "isStatic": false,
415
+ "returnTypeTokenRange": {
416
+ "startIndex": 1,
417
+ "endIndex": 2
418
+ },
419
+ "releaseTag": "Public",
420
+ "isProtected": false,
421
+ "overloadIndex": 1,
422
+ "parameters": [],
423
+ "isOptional": false,
424
+ "isAbstract": false,
425
+ "name": "create"
426
+ },
373
427
  {
374
428
  "kind": "Property",
375
429
  "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createEvent:member",
@@ -430,6 +484,59 @@
430
484
  "isProtected": false,
431
485
  "isAbstract": false
432
486
  },
487
+ {
488
+ "kind": "Method",
489
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#criteriaChanged:member(1)",
490
+ "docComment": "",
491
+ "excerptTokens": [
492
+ {
493
+ "kind": "Content",
494
+ "text": "criteriaChanged(e: "
495
+ },
496
+ {
497
+ "kind": "Reference",
498
+ "text": "CustomEvent",
499
+ "canonicalReference": "!CustomEvent:interface"
500
+ },
501
+ {
502
+ "kind": "Content",
503
+ "text": "<string>"
504
+ },
505
+ {
506
+ "kind": "Content",
507
+ "text": "): "
508
+ },
509
+ {
510
+ "kind": "Content",
511
+ "text": "void"
512
+ },
513
+ {
514
+ "kind": "Content",
515
+ "text": ";"
516
+ }
517
+ ],
518
+ "isStatic": false,
519
+ "returnTypeTokenRange": {
520
+ "startIndex": 4,
521
+ "endIndex": 5
522
+ },
523
+ "releaseTag": "Public",
524
+ "isProtected": false,
525
+ "overloadIndex": 1,
526
+ "parameters": [
527
+ {
528
+ "parameterName": "e",
529
+ "parameterTypeTokenRange": {
530
+ "startIndex": 1,
531
+ "endIndex": 3
532
+ },
533
+ "isOptional": false
534
+ }
535
+ ],
536
+ "isOptional": false,
537
+ "isAbstract": false,
538
+ "name": "criteriaChanged"
539
+ },
433
540
  {
434
541
  "kind": "Property",
435
542
  "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#datasourceConfig:member",
@@ -493,6 +600,36 @@
493
600
  "isAbstract": false,
494
601
  "name": "deepClone"
495
602
  },
603
+ {
604
+ "kind": "Property",
605
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#defaultEntityValues:member",
606
+ "docComment": "",
607
+ "excerptTokens": [
608
+ {
609
+ "kind": "Content",
610
+ "text": "defaultEntityValues: "
611
+ },
612
+ {
613
+ "kind": "Content",
614
+ "text": "any"
615
+ },
616
+ {
617
+ "kind": "Content",
618
+ "text": ";"
619
+ }
620
+ ],
621
+ "isReadonly": false,
622
+ "isOptional": false,
623
+ "releaseTag": "Public",
624
+ "name": "defaultEntityValues",
625
+ "propertyTypeTokenRange": {
626
+ "startIndex": 1,
627
+ "endIndex": 2
628
+ },
629
+ "isStatic": false,
630
+ "isProtected": false,
631
+ "isAbstract": false
632
+ },
496
633
  {
497
634
  "kind": "Property",
498
635
  "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deleteEvent:member",
@@ -583,6 +720,37 @@
583
720
  "isProtected": false,
584
721
  "isAbstract": false
585
722
  },
723
+ {
724
+ "kind": "Property",
725
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editEntityForm:member",
726
+ "docComment": "",
727
+ "excerptTokens": [
728
+ {
729
+ "kind": "Content",
730
+ "text": "editEntityForm: "
731
+ },
732
+ {
733
+ "kind": "Reference",
734
+ "text": "Form",
735
+ "canonicalReference": "@genesislcap/foundation-forms!Form:class"
736
+ },
737
+ {
738
+ "kind": "Content",
739
+ "text": ";"
740
+ }
741
+ ],
742
+ "isReadonly": false,
743
+ "isOptional": false,
744
+ "releaseTag": "Public",
745
+ "name": "editEntityForm",
746
+ "propertyTypeTokenRange": {
747
+ "startIndex": 1,
748
+ "endIndex": 2
749
+ },
750
+ "isStatic": false,
751
+ "isProtected": false,
752
+ "isAbstract": false
753
+ },
586
754
  {
587
755
  "kind": "Property",
588
756
  "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editEntityModal:member",
@@ -794,6 +962,36 @@
794
962
  "isProtected": false,
795
963
  "isAbstract": false
796
964
  },
965
+ {
966
+ "kind": "Property",
967
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalPosition:member",
968
+ "docComment": "/**\n * Determines where the modal dialog will appear on screen\n *\n * @public\n */\n",
969
+ "excerptTokens": [
970
+ {
971
+ "kind": "Content",
972
+ "text": "modalPosition: "
973
+ },
974
+ {
975
+ "kind": "Content",
976
+ "text": "'centre' | 'left' | 'right'"
977
+ },
978
+ {
979
+ "kind": "Content",
980
+ "text": ";"
981
+ }
982
+ ],
983
+ "isReadonly": false,
984
+ "isOptional": false,
985
+ "releaseTag": "Public",
986
+ "name": "modalPosition",
987
+ "propertyTypeTokenRange": {
988
+ "startIndex": 1,
989
+ "endIndex": 2
990
+ },
991
+ "isStatic": false,
992
+ "isProtected": false,
993
+ "isAbstract": false
994
+ },
797
995
  {
798
996
  "kind": "Property",
799
997
  "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#persistColumnStateKey:member",
@@ -7,6 +7,7 @@ import { Controller } from '@microsoft/fast-element';
7
7
  import { DatasourceOptions } from '@genesislcap/foundation-comms';
8
8
  import { DOMContainer } from '@genesislcap/foundation-utils';
9
9
  import { FASTElement } from '@microsoft/fast-element';
10
+ import { Form } from '@genesislcap/foundation-forms';
10
11
  import { FoundationAnalytics } from '@genesislcap/foundation-comms';
11
12
  import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
12
13
  import { GridProRendererTypes } from '@genesislcap/grid-pro';
@@ -18,6 +19,33 @@ import { RouterConfiguration } from '@microsoft/fast-router';
18
19
  import { Session } from '@genesislcap/foundation-comms';
19
20
  import { ViewTemplate } from '@microsoft/fast-element';
20
21
 
22
+ /**
23
+ * @public
24
+ */
25
+ export declare 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
+
21
49
  /**
22
50
  * The attribute which is set to configure the resource that the entity manager is working with
23
51
  *
@@ -166,6 +194,7 @@ export declare class EntityManagement extends EntityManagement_base {
166
194
  */
167
195
  editedEntity: any;
168
196
  submitting: boolean;
197
+ defaultEntityValues: any;
169
198
  /**
170
199
  * String which contains the text of the popup modal when the user is adding or editing an entity
171
200
  */
@@ -173,9 +202,15 @@ export declare class EntityManagement extends EntityManagement_base {
173
202
  editModalVisible: boolean;
174
203
  editModalVisibleChanged(): void;
175
204
  editEntityModal: any;
205
+ editEntityForm: Form;
176
206
  sizeColumnsToFit: boolean;
177
207
  enableFilterBar: boolean;
178
208
  enableCellFlashing: boolean;
209
+ /**
210
+ * Determines where the modal dialog will appear on screen
211
+ * @public
212
+ */
213
+ modalPosition: 'centre' | 'left' | 'right';
179
214
  /**
180
215
  * Set up the web component
181
216
  * @internal
@@ -195,6 +230,11 @@ export declare class EntityManagement extends EntityManagement_base {
195
230
  * @public
196
231
  */
197
232
  submitEntityChanges(e: CustomEvent): Promise<void>;
233
+ /**
234
+ * Show the entity create form
235
+ * @public
236
+ */
237
+ create(): void;
198
238
  /**
199
239
  * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
200
240
  *
@@ -211,6 +251,7 @@ export declare class EntityManagement extends EntityManagement_base {
211
251
  private editEntity;
212
252
  private readEntity;
213
253
  closeModal(): void;
254
+ criteriaChanged(e: CustomEvent<string>): void;
214
255
  /**
215
256
  * Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
216
257
  *
@@ -239,10 +280,7 @@ declare const EntityManagement_base: (new (...args: any[]) => {
239
280
  readonly shouldRunConnect: boolean;
240
281
  "__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
241
282
  connectedCallback(): void;
242
- readonly $fastController: Controller; /**
243
- * Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
244
- * @public
245
- */
283
+ readonly $fastController: Controller;
246
284
  $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
247
285
  disconnectedCallback(): void;
248
286
  attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
@@ -341,6 +379,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
341
379
  webkitMatchesSelector(selectors: string): boolean;
342
380
  readonly baseURI: string;
343
381
  readonly childNodes: NodeListOf<ChildNode>;
382
+ /**
383
+ * Sets up and opens the model to either edit or add an entity. Added as an event listener on the class when receiving the `edit-entity` event.
384
+ *
385
+ * @param e - CustomEvent where `e.detail` is used to deduce whether to edit or add an entity.
386
+ * @internal
387
+ */
344
388
  readonly firstChild: ChildNode;
345
389
  readonly isConnected: boolean;
346
390
  readonly lastChild: ChildNode;
@@ -0,0 +1,34 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [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) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [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) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [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&lt;string&gt; | |
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) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md)
4
+
5
+ ## EntityManagement.defaultEntityValues property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ defaultEntityValues: any;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [editEntityForm](./foundation-entity-management.entitymanagement.editentityform.md)
4
+
5
+ ## EntityManagement.editEntityForm property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ editEntityForm: Form;
11
+ ```
@@ -41,15 +41,18 @@ 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 |
48
+ | [editEntityForm](./foundation-entity-management.entitymanagement.editentityform.md) | | Form | |
47
49
  | [editEntityModal](./foundation-entity-management.entitymanagement.editentitymodal.md) | | any | |
48
50
  | [editModalVisible](./foundation-entity-management.entitymanagement.editmodalvisible.md) | | boolean | |
49
51
  | [enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md) | | boolean | |
50
52
  | [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md) | | boolean | |
51
53
  | [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
54
  | [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md) | | any | |
55
+ | [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md) | | 'centre' \| 'left' \| 'right' | Determines where the modal dialog will appear on screen |
53
56
  | [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
57
  | [readEvent](./foundation-entity-management.entitymanagement.readevent.md) | | string | |
55
58
  | [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md) | | (...args: any\[\]) =&gt; {} | |
@@ -68,6 +71,8 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
68
71
  | --- | --- | --- |
69
72
  | [closeModal()](./foundation-entity-management.entitymanagement.closemodal.md) | | |
70
73
  | [confirmDelete()](./foundation-entity-management.entitymanagement.confirmdelete.md) | | |
74
+ | [create()](./foundation-entity-management.entitymanagement.create.md) | | Show the entity create form |
75
+ | [criteriaChanged(e)](./foundation-entity-management.entitymanagement.criteriachanged.md) | | |
71
76
  | [deepClone()](./foundation-entity-management.entitymanagement.deepclone.md) | | Override the deepClone method to ensure that observable attributes are cloned |
72
77
  | [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) | | |
73
78
  | [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) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [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 |