@genesislcap/foundation-entity-management 14.408.0 → 14.409.0

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

@@ -1,88 +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; [CustomActionState](./foundation-entity-management.customactionstate.md)
-
-## CustomActionState interface
-
-**Signature:**
-
-```typescript
-export interface CustomActionState 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[event](./foundation-entity-management.customactionstate.event.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./foundation-entity-management.customactionstate.name.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[rowData](./foundation-entity-management.customactionstate.rowdata.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-entity-management.customactionstate.name.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; [CustomActionState](./foundation-entity-management.customactionstate.md) &gt; [name](./foundation-entity-management.customactionstate.name.md)
-
-## CustomActionState.name property
-
-**Signature:**
-
-```typescript
-name: string;
-```

package/docs/api/foundation-entity-management.customactionstate.rowdata.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; [CustomActionState](./foundation-entity-management.customactionstate.md) &gt; [rowData](./foundation-entity-management.customactionstate.rowdata.md)
-
-## CustomActionState.rowData property
-
-**Signature:**
-
-```typescript
-rowData: any;
-```

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

@@ -1,31 +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; [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md)
-
-## DatasourceConfiguration type
-
-The attribute which is set to configure the resource that the entity manager is working with
-
-**Signature:**
-
-```typescript
-export type DatasourceConfiguration = Omit<DatasourceOptions, 'resourceName'>;
-```
-
-## Example
-
-
-```javascript
-type DatasourceConfiguration = {
-  criteria?: string;
-  fields?: string;
-  isSnapshot?: boolean;
-  maxRows?: number;
-  maxView?: number;
-  movingView?: boolean;
-  pollingInterval?: number;
-  orderBy?: string;
-  reverse?: boolean;
-}
-```
-

package/docs/api/foundation-entity-management.defaultvalue.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; [DefaultValue](./foundation-entity-management.defaultvalue.md)
-
-## DefaultValue type
-
-**Signature:**
-
-```typescript
-export type DefaultValue = string | number | boolean | null | RecordTypeValue;
-```
-**References:** [RecordTypeValue](./foundation-entity-management.recordtypevalue.md)
-

package/docs/api/foundation-entity-management.defaultvalues.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; [DefaultValues](./foundation-entity-management.defaultvalues.md)
-
-## DefaultValues interface
-
-**Signature:**
-
-```typescript
-export interface DefaultValues 
-```

package/docs/api/foundation-entity-management.entity_name.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; [ENTITY\_NAME](./foundation-entity-management.entity_name.md)
-
-## ENTITY\_NAME variable
-
-**Signature:**
-
-```typescript
-ENTITY_NAME: import("@microsoft/fast-foundation").InterfaceSymbol<string>
-```

package/docs/api/foundation-entity-management.entitymanagement.approvalmessagelabel.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; [approvalMessageLabel](./foundation-entity-management.entitymanagement.approvalmessagelabel.md)
-
-## EntityManagement.approvalMessageLabel property
-
-Label for the approval message field in the approval dialog.
-
-**Signature:**
-
-```typescript
-approvalMessageLabel: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.columns.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; [columns](./foundation-entity-management.entitymanagement.columns.md)
-
-## EntityManagement.columns property
-
-Array which holds the column definitions.
-
-**Signature:**
-
-```typescript
-columns: ColDef[];
-```

package/docs/api/foundation-entity-management.entitymanagement.confirmationmessage.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; [confirmationMessage](./foundation-entity-management.entitymanagement.confirmationmessage.md)
-
-## EntityManagement.confirmationMessage property
-
-Optional confirmation message to display before form submission. If set, a confirmation dialog will be shown when the user clicks submit.
-
-**Signature:**
-
-```typescript
-confirmationMessage: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.createevent.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; [createEvent](./foundation-entity-management.entitymanagement.createevent.md)
-
-## EntityManagement.createEvent property
-
-Name of the event handler on the Genesis server which handles creating an entity
-
-**Signature:**
-
-```typescript
-createEvent: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.createformuischema.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; [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md)
-
-## EntityManagement.createFormUiSchema property
-
-Enables you to supply a schema to configure an insert form.
-
-**Signature:**
-
-```typescript
-createFormUiSchema: UiSchema;
-```

package/docs/api/foundation-entity-management.entitymanagement.crudactionmenuname.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; [crudActionMenuName](./foundation-entity-management.entitymanagement.crudactionmenuname.md)
-
-## EntityManagement.crudActionMenuName property
-
-The label of the crud action menu
-
-**Signature:**
-
-```typescript
-crudActionMenuName: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.crudmenuposition.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; [crudMenuPosition](./foundation-entity-management.entitymanagement.crudmenuposition.md)
-
-## EntityManagement.crudMenuPosition property
-
-Determines where the buttons will appear
-
-**Signature:**
-
-```typescript
-crudMenuPosition: CrudMenuPosition;
-```

package/docs/api/foundation-entity-management.entitymanagement.crudmenustyle.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; [crudMenuStyle](./foundation-entity-management.entitymanagement.crudmenustyle.md)
-
-## EntityManagement.crudMenuStyle property
-
-Determines the style of the buttons
-
-**Signature:**
-
-```typescript
-crudMenuStyle: ActionsMenuStyle;
-```

package/docs/api/foundation-entity-management.entitymanagement.customactions.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; [customActions](./foundation-entity-management.entitymanagement.customactions.md)
-
-## EntityManagement.customActions property
-
-Array of custom actions that can be added to the entity management component
-
-**Signature:**
-
-```typescript
-customActions: CustomAction[];
-```

package/docs/api/foundation-entity-management.entitymanagement.datasourceconfig.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; [datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md)
-
-## EntityManagement.datasourceConfig property
-
-Get the configuration which is used when interacting with the resource on the backend
-
-**Signature:**
-
-```typescript
-set datasourceConfig(config: DatasourceConfiguration);
-```
-
-## Remarks
-
-Handles the configuration such as how many rows of entities to fetch at a time
-

package/docs/api/foundation-entity-management.entitymanagement.datasourcetype.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; [datasourceType](./foundation-entity-management.entitymanagement.datasourcetype.md)
-
-## EntityManagement.datasourceType property
-
-If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component. By default `grid-pro-client-side-datasource` will be used.
-
-**Signature:**
-
-```typescript
-datasourceType: DatasourceType;
-```

package/docs/api/foundation-entity-management.entitymanagement.defaultentityvalues.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; [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md)
-
-## EntityManagement.defaultEntityValues property
-
-The default values to populate the form with when the user is adding an entity
-
-**Signature:**
-
-```typescript
-defaultEntityValues: Record<string, unknown>;
-```

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

@@ -1,54 +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; [deleteColumnState](./foundation-entity-management.entitymanagement.deletecolumnstate.md)
-
-## EntityManagement.deleteColumnState() method
-
-Deletes the saved column state for the grid
-
-**Signature:**
-
-```typescript
-deleteColumnState(resetToDefault?: boolean): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-resetToDefault
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether to reset columns to their default configuration. Defaults to true.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-entity-management.entitymanagement.deleteevent.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; [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md)
-
-## EntityManagement.deleteEvent property
-
-Name of the event handler on the Genesis server which handles deleting the entity
-
-**Signature:**
-
-```typescript
-deleteEvent: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.enableaicriteriasearch.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; [enableAiCriteriaSearch](./foundation-entity-management.entitymanagement.enableaicriteriasearch.md)
-
-## EntityManagement.enableAiCriteriaSearch property
-
-Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.
-
-**Signature:**
-
-```typescript
-enableAiCriteriaSearch: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.enablecellflashing.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; [enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md)
-
-## EntityManagement.enableCellFlashing property
-
-If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
-
-**Signature:**
-
-```typescript
-enableCellFlashing: boolean;
-```
-
-## Remarks
-
-Defaults to true
-

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

@@ -1,43 +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; [enableCsvExport](./foundation-entity-management.entitymanagement.enablecsvexport.md)
-
-## EntityManagement.enableCsvExport property
-
-Enabling this option will enable a download button in the top-right of the header which will export the data to a csv file when clicked.
-
-**Signature:**
-
-```typescript
-enableCsvExport: {
-        buttonName?: string;
-        fileName?: string;
-    } | null;
-```
-
-## Remarks
-
-The default button is `Export` and the filename `export.csv`<!-- -->. You can optionally configure these values via this property to override them
-
-## Example 1
-
-Enabling the feature and using the default configuration
-
-```ts
-<foundation-entity-manager
-  :enableCsvExport="${() => ({})}"
->
-</foundation-entity-manager>
-```
-
-## Example 2
-
-Enabling the feature and overriding the default values
-
-```ts
-<foundation-entity-manager
-  :enableCsvExport="${() => ({buttonName: 'Download', fileName: 'counterparty-export'})}"
->
-</foundation-entity-manager>
-```
-

package/docs/api/foundation-entity-management.entitymanagement.enablefilterbar.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; [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md)
-
-## EntityManagement.enableFilterBar property
-
-Enables filter bar component
-
-**Signature:**
-
-```typescript
-enableFilterBar: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.enablefilters.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; [enableFilters](./foundation-entity-management.entitymanagement.enablefilters.md)
-
-## EntityManagement.enableFilters property
-
-Enables foundation-filters with flyout UI
-
-**Signature:**
-
-```typescript
-enableFilters: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.enablerowflashing.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; [enableRowFlashing](./foundation-entity-management.entitymanagement.enablerowflashing.md)
-
-## EntityManagement.enableRowFlashing property
-
-If true, will enable row flashing for all rows for `add` transactions
-
-**Signature:**
-
-```typescript
-enableRowFlashing: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.enablesearchbar.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; [enableSearchBar](./foundation-entity-management.entitymanagement.enablesearchbar.md)
-
-## EntityManagement.enableSearchBar property
-
-This attribute controls whether to enable the search-bar.
-
-**Signature:**
-
-```typescript
-enableSearchBar: boolean;
-```

package/docs/api/foundation-entity-management.entitymanagement.entitylabel.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; [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md)
-
-## EntityManagement.entityLabel property
-
-Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications
-
-**Signature:**
-
-```typescript
-entityLabel: string;
-```

package/docs/api/foundation-entity-management.entitymanagement.errornotificationconfig.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; [errorNotificationConfig](./foundation-entity-management.entitymanagement.errornotificationconfig.md)
-
-## EntityManagement.errorNotificationConfig property
-
-Notification config used for submit failures. Defaults to an error snackbar but can be overridden while keeping title/body unchanged.
-
-**Signature:**
-
-```typescript
-errorNotificationConfig: NotificationStructure['config'];
-```

package/docs/api/foundation-entity-management.entitymanagement.filtersmodalposition.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; [filtersModalPosition](./foundation-entity-management.entitymanagement.filtersmodalposition.md)
-
-## EntityManagement.filtersModalPosition property
-
-Determines where the filters modal will appear on screen
-
-**Signature:**
-
-```typescript
-filtersModalPosition: 'centre' | 'left' | 'right';
-```

package/docs/api/foundation-entity-management.entitymanagement.filtersuischema.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; [filtersUiSchema](./foundation-entity-management.entitymanagement.filtersuischema.md)
-
-## EntityManagement.filtersUiSchema property
-
-UI schema configuration for the filters component
-
-**Signature:**
-
-```typescript
-filtersUiSchema: UiSchema;
-```

package/docs/api/foundation-entity-management.entitymanagement.formrenderers.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; [formRenderers](./foundation-entity-management.entitymanagement.formrenderers.md)
-
-## EntityManagement.formRenderers property
-
-Array with renderers used by foundation-forms
-
-**Signature:**
-
-```typescript
-formRenderers: RendererEntry[];
-```

package/docs/api/foundation-entity-management.entitymanagement.gridautosizing.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; [gridAutosizing](./foundation-entity-management.entitymanagement.gridautosizing.md)
-
-## EntityManagement.gridAutosizing property
-
-Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.
-
-**Signature:**
-
-```typescript
-gridAutosizing: boolean;
-```