@genesislcap/foundation-entity-management 14.408.0 → 14.409.0

package/docs/api/foundation-entity-management.entitymanagement.modalposition.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[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)
-
-## EntityManagement.modalPosition property
-
-Determines where the modal dialog will appear on screen
-
-**Signature:**
-
-```typescript
-modalPosition: 'centre' | 'left' | 'right';
-```

package/docs/api/foundation-entity-management.entitymanagement.persistcolumnstatekey.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md)
-
-## EntityManagement.persistColumnStateKey property
-
-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.
-
-**Signature:**
-
-```typescript
-persistColumnStateKey: string;
-```
-
-## Remarks
-
-Setting this value will set the entity manager to persist the column states through page refreshes etc. An example of what is stored is when the user resizes or reorders columns. This value must be unique for each table in your app otherwise the persisted data will be corrupted. There is an option on the grid for the user to reset the table to the default layout if they wish. If you omit this attribute then nothing is persisted
-

package/docs/api/foundation-entity-management.entitymanagement.persistfiltermodelkey.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [persistFilterModelKey](./foundation-entity-management.entitymanagement.persistfiltermodelkey.md)
-
-## EntityManagement.persistFilterModelKey property
-
-The key to use for persisting the filter model in local browser or KV storage.
-
-**Signature:**
-
-```typescript
-persistFilterModelKey: string;
-```
-
-## Remarks
-
-Default behaviour when unset is to not save the filter config. This value must be unique for each table in your app otherwise the persisted data will be corrupted.
-

package/docs/api/foundation-entity-management.entitymanagement.prefix.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [prefix](./foundation-entity-management.entitymanagement.prefix.md)
-
-## EntityManagement.prefix property
-
-Name of the design system prefix that will be used in renderers.
-
-**Signature:**
-
-```typescript
-prefix: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.readevent.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [readEvent](./foundation-entity-management.entitymanagement.readevent.md)
-
-## EntityManagement.readEvent property
-
-Name of the request on the Genesis server which fetches data for the form, example usage could include fetching additional data that is not available in the grid but required for the selected entity
-
-**Signature:**
-
-```typescript
-readEvent: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.readeventfn.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md)
-
-## EntityManagement.readEventFn property
-
-Similar to readEvent but allows to provide function that will be executed before opening the form and yields data to the form
-
-**Signature:**
-
-```typescript
-readEventFn: (entity: any) => any;
-```

package/docs/api/foundation-entity-management.entitymanagement.resourcename.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [resourceName](./foundation-entity-management.entitymanagement.resourcename.md)
-
-## EntityManagement.resourceName property
-
-Name of the backend resource which contain the entities to manage
-
-**Signature:**
-
-```typescript
-resourceName: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.rowselection.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [rowSelection](./foundation-entity-management.entitymanagement.rowselection.md)
-
-## EntityManagement.rowSelection property
-
-This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.
-
-**Signature:**
-
-```typescript
-rowSelection: string;
-```
-
-## Remarks
-
-Defaults to single
-

package/docs/api/foundation-entity-management.entitymanagement.searchbarconfig.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [searchBarConfig](./foundation-entity-management.entitymanagement.searchbarconfig.md)
-
-## EntityManagement.searchBarConfig property
-
-Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid \*
-
-**Signature:**
-
-```typescript
-searchBarConfig: AvailableOption[];
-```

package/docs/api/foundation-entity-management.entitymanagement.setapprovalmessage.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [setApprovalMessage](./foundation-entity-management.entitymanagement.setapprovalmessage.md)
-
-## EntityManagement.setApprovalMessage property
-
-When enabled, adds an APPROVAL\_MESSAGE field to the form schema. This field will be sent at root level alongside DETAILS when submitting. Can be overridden per custom action via the action's setApprovalMessage property.
-
-**Signature:**
-
-```typescript
-setApprovalMessage: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.setdsconfigwithoutupdatingbasecriteria.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [setDSConfigWithoutUpdatingBaseCriteria](./foundation-entity-management.entitymanagement.setdsconfigwithoutupdatingbasecriteria.md)
-
-## EntityManagement.setDSConfigWithoutUpdatingBaseCriteria() method
-
-Usually when the datasource config is updated we need to cache the criteria so it can be combined with the searchbar, but this function allows you to set the datasource config without doing that (so we don't cache the search bar criteria)
-
-**Signature:**
-
-```typescript
-setDSConfigWithoutUpdatingBaseCriteria(config: DatasourceConfiguration): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-config
-
-
-</td><td>
-
-[DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-entity-management.entitymanagement.showfilterpersistencecontrols.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [showFilterPersistenceControls](./foundation-entity-management.entitymanagement.showfilterpersistencecontrols.md)
-
-## EntityManagement.showFilterPersistenceControls property
-
-Controls visibility of filter save/load UI in foundation-filters
-
-**Signature:**
-
-```typescript
-showFilterPersistenceControls: boolean;
-```
-
-## Remarks
-
-Defaults to true
-

package/docs/api/foundation-entity-management.entitymanagement.sizecolumnstocontent.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [sizeColumnsToContent](./foundation-entity-management.entitymanagement.sizecolumnstocontent.md)
-
-## EntityManagement.sizeColumnsToContent property
-
-Auto-sizes a column based on its contents
-
-**Signature:**
-
-```typescript
-sizeColumnsToContent: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.sizecolumnstofit.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [sizeColumnsToFit](./foundation-entity-management.entitymanagement.sizecolumnstofit.md)
-
-## EntityManagement.sizeColumnsToFit property
-
-Resizes columns to take available space
-
-**Signature:**
-
-```typescript
-sizeColumnsToFit: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.statusbarconfig.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [statusBarConfig](./foundation-entity-management.entitymanagement.statusbarconfig.md)
-
-## EntityManagement.statusBarConfig property
-
-Configuration for the grid status bar components.
-
-**Signature:**
-
-```typescript
-statusBarConfig: GridProStatusBarConfig;
-```
-
-## Remarks
-
-This requires AG Grid Enterprise module to be enabled. The status bar will only be displayed if the Enterprise module is available.
-

package/docs/api/foundation-entity-management.entitymanagement.title.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [title](./foundation-entity-management.entitymanagement.title.md)
-
-## EntityManagement.title property
-
-Title of the grid
-
-**Signature:**
-
-```typescript
-title: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.updateevent.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [updateEvent](./foundation-entity-management.entitymanagement.updateevent.md)
-
-## EntityManagement.updateEvent property
-
-Name of the event handler on the Genesis server which handles updating the entity
-
-**Signature:**
-
-```typescript
-updateEvent: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.updateformuischema.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [updateFormUiSchema](./foundation-entity-management.entitymanagement.updateformuischema.md)
-
-## EntityManagement.updateFormUiSchema property
-
-Enables you to supply a schema to configure an update form.
-
-**Signature:**
-
-```typescript
-updateFormUiSchema: UiSchema;
-```

package/docs/api/foundation-entity-management.geterrorformat.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [getErrorFormat](./foundation-entity-management.geterrorformat.md)
-
-## getErrorFormat() function
-
-Format the error as a string with a different format depending on whether `err` has a `FIELD` property or not
-
-**Signature:**
-
-```typescript
-getErrorFormat: (err: any) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-err
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-

package/docs/api/foundation-entity-management.list.actionbuttonsconfig.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [actionButtonsConfig](./foundation-entity-management.list.actionbuttonsconfig.md)
-
-## List.actionButtonsConfig property
-
-**Signature:**
-
-```typescript
-actionButtonsConfig: any[];
-```

package/docs/api/foundation-entity-management.list.asyncadd.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [asyncAdd](./foundation-entity-management.list.asyncadd.md)
-
-## List.asyncAdd property
-
-**Signature:**
-
-```typescript
-asyncAdd: boolean;
-```

package/docs/api/foundation-entity-management.list.asyncremove.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [asyncRemove](./foundation-entity-management.list.asyncremove.md)
-
-## List.asyncRemove property
-
-**Signature:**
-
-```typescript
-asyncRemove: boolean;
-```

package/docs/api/foundation-entity-management.list.asyncupdate.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [asyncUpdate](./foundation-entity-management.list.asyncupdate.md)
-
-## List.asyncUpdate property
-
-**Signature:**
-
-```typescript
-asyncUpdate: boolean;
-```

package/docs/api/foundation-entity-management.list.columns.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [columns](./foundation-entity-management.list.columns.md)
-
-## List.columns property
-
-**Signature:**
-
-```typescript
-columns: ColDef[];
-```

package/docs/api/foundation-entity-management.list.connect.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [connect](./foundation-entity-management.list.connect.md)
-
-## List.connect property
-
-**Signature:**
-
-```typescript
-protected connect: Connect;
-```

package/docs/api/foundation-entity-management.list.connectedcallback.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [connectedCallback](./foundation-entity-management.list.connectedcallback.md)
-
-## List.connectedCallback() method
-
-**Signature:**
-
-```typescript
-connectedCallback(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-entity-management.list.createevent.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [createEvent](./foundation-entity-management.list.createevent.md)
-
-## List.createEvent property
-
-**Signature:**
-
-```typescript
-createEvent: string;
-```

package/docs/api/foundation-entity-management.list.criteria.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [criteria](./foundation-entity-management.list.criteria.md)
-
-## List.criteria property
-
-**Signature:**
-
-```typescript
-get criteria(): string;
-```

package/docs/api/foundation-entity-management.list.customactions.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [customActions](./foundation-entity-management.list.customactions.md)
-
-## List.customActions property
-
-**Signature:**
-
-```typescript
-customActions: CustomAction[];
-```

package/docs/api/foundation-entity-management.list.datasource.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [datasource](./foundation-entity-management.list.datasource.md)
-
-## List.datasource property
-
-**Signature:**
-
-```typescript
-datasource: GridProGenesisDatasource;
-```

package/docs/api/foundation-entity-management.list.datasourceconfig.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [datasourceConfig](./foundation-entity-management.list.datasourceconfig.md)
-
-## List.datasourceConfig property
-
-**Signature:**
-
-```typescript
-datasourceConfig: DatasourceConfiguration;
-```

package/docs/api/foundation-entity-management.list.datasourcetype.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [datasourceType](./foundation-entity-management.list.datasourcetype.md)
-
-## List.datasourceType property
-
-**Signature:**
-
-```typescript
-datasourceType: DatasourceType;
-```

package/docs/api/foundation-entity-management.list.delete.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [delete](./foundation-entity-management.list.delete.md)
-
-## List.delete() method
-
-**Signature:**
-
-```typescript
-delete(e: any): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-e
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-entity-management.list.deleteevent.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [deleteEvent](./foundation-entity-management.list.deleteevent.md)
-
-## List.deleteEvent property
-
-**Signature:**
-
-```typescript
-deleteEvent: string;
-```

package/docs/api/foundation-entity-management.list.disablepolling.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [disablePolling](./foundation-entity-management.list.disablepolling.md)
-
-## List.disablePolling property
-
-**Signature:**
-
-```typescript
-get disablePolling(): boolean;
-```

package/docs/api/foundation-entity-management.list.disconnectedcallback.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [disconnectedCallback](./foundation-entity-management.list.disconnectedcallback.md)
-
-## List.disconnectedCallback() method
-
-**Signature:**
-
-```typescript
-disconnectedCallback(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-entity-management.list.enablecellflashing.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md) &gt; [enableCellFlashing](./foundation-entity-management.list.enablecellflashing.md)
-
-## List.enableCellFlashing property
-
-**Signature:**
-
-```typescript
-enableCellFlashing: boolean;
-```