npm - @genesislcap/foundation-entity-management - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-entity-management 14.408.0 → 14.409.0

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 (162) hide show

package/docs/api/foundation-entity-management.entitymanagement.md DELETED Viewed

@@ -1,1000 +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)
-## EntityManagement class
-Main class which defines the entity management functionality
-**Signature:**
-```typescript
-export declare class EntityManagement extends EntityManagement_base
-```
-**Extends:** EntityManagement\_base
-## Remarks
-Connects to a backend resource and wraps up a grid which is populated with entities from that resource. The different interactions that the user can perform with the entities can be configured, examples being able to update and delete entities.
-## Example
-Example of using the entity management system to handle counterparties
-```
-<entity-management
-  resourceName="ALL_COUNTERPARTYS"
-  title="Counterparty Management"
-  updateEvent="EVENT_COUNTERPARTY_MODIFY"
-  deleteEvent="EVENT_COUNTERPARTY_DELETE"
-  createEvent="EVENT_COUNTERPARTY_INSERT"
-></entity-management>
-```
-Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the name of the resource in the database to manage is `ALL_COUNTERPARTYS`<br /> - the name of the event handler for update events is `EVENT_COUNTERPARTY_MODIFY`<br /> - the name of the event handler for create events is `EVENT_COUNTERPARTY_INSERT`<br /> - the name of the event handler for delete events is `EVENT_COUNTERPARTY_DELETE`<br />
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[approvalMessageLabel](./foundation-entity-management.entitymanagement.approvalmessagelabel.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Label for the approval message field in the approval dialog.
-</td></tr>
-<tr><td>
-[columns](./foundation-entity-management.entitymanagement.columns.md)
-</td><td>
-</td><td>
-ColDef\[\]
-</td><td>
-Array which holds the column definitions.
-</td></tr>
-<tr><td>
-[confirmationMessage](./foundation-entity-management.entitymanagement.confirmationmessage.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Optional confirmation message to display before form submission. If set, a confirmation dialog will be shown when the user clicks submit.
-</td></tr>
-<tr><td>
-[createEvent](./foundation-entity-management.entitymanagement.createevent.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Name of the event handler on the Genesis server which handles creating an entity
-</td></tr>
-<tr><td>
-[createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md)
-</td><td>
-</td><td>
-UiSchema
-</td><td>
-Enables you to supply a schema to configure an insert form.
-</td></tr>
-<tr><td>
-[crudActionMenuName](./foundation-entity-management.entitymanagement.crudactionmenuname.md)
-</td><td>
-</td><td>
-string
-</td><td>
-The label of the crud action menu
-</td></tr>
-<tr><td>
-[crudMenuPosition](./foundation-entity-management.entitymanagement.crudmenuposition.md)
-</td><td>
-</td><td>
-[CrudMenuPosition](./foundation-entity-management.crudmenuposition.md)
-</td><td>
-Determines where the buttons will appear
-</td></tr>
-<tr><td>
-[crudMenuStyle](./foundation-entity-management.entitymanagement.crudmenustyle.md)
-</td><td>
-</td><td>
-[ActionsMenuStyle](./foundation-entity-management.actionsmenustyle.md)
-</td><td>
-Determines the style of the buttons
-</td></tr>
-<tr><td>
-[customActions](./foundation-entity-management.entitymanagement.customactions.md)
-</td><td>
-</td><td>
-[CustomAction](./foundation-entity-management.customaction.md)<!-- -->\[\]
-</td><td>
-Array of custom actions that can be added to the entity management component
-</td></tr>
-<tr><td>
-[datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md)
-</td><td>
-</td><td>
-[DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md)
-</td><td>
-Get the configuration which is used when interacting with the resource on the backend
-</td></tr>
-<tr><td>
-[datasourceType](./foundation-entity-management.entitymanagement.datasourcetype.md)
-</td><td>
-</td><td>
-DatasourceType
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md)
-</td><td>
-</td><td>
-Record&lt;string, unknown&gt;
-</td><td>
-The default values to populate the form with when the user is adding an entity
-</td></tr>
-<tr><td>
-[deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Name of the event handler on the Genesis server which handles deleting the entity
-</td></tr>
-<tr><td>
-[enableAiCriteriaSearch](./foundation-entity-management.entitymanagement.enableaicriteriasearch.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.
-</td></tr>
-<tr><td>
-[enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
-</td></tr>
-<tr><td>
-[enableCsvExport](./foundation-entity-management.entitymanagement.enablecsvexport.md)
-</td><td>
-</td><td>
-{ buttonName?: string; fileName?: string; } \| null
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Enables filter bar component
-</td></tr>
-<tr><td>
-[enableFilters](./foundation-entity-management.entitymanagement.enablefilters.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Enables foundation-filters with flyout UI
-</td></tr>
-<tr><td>
-[enableRowFlashing](./foundation-entity-management.entitymanagement.enablerowflashing.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-If true, will enable row flashing for all rows for `add` transactions
-</td></tr>
-<tr><td>
-[enableSearchBar](./foundation-entity-management.entitymanagement.enablesearchbar.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-This attribute controls whether to enable the search-bar.
-</td></tr>
-<tr><td>
-[entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications
-</td></tr>
-<tr><td>
-[errorNotificationConfig](./foundation-entity-management.entitymanagement.errornotificationconfig.md)
-</td><td>
-</td><td>
-NotificationStructure\['config'\]
-</td><td>
-Notification config used for submit failures. Defaults to an error snackbar but can be overridden while keeping title/body unchanged.
-</td></tr>
-<tr><td>
-[filtersModalPosition](./foundation-entity-management.entitymanagement.filtersmodalposition.md)
-</td><td>
-</td><td>
-'centre' \| 'left' \| 'right'
-</td><td>
-Determines where the filters modal will appear on screen
-</td></tr>
-<tr><td>
-[filtersUiSchema](./foundation-entity-management.entitymanagement.filtersuischema.md)
-</td><td>
-</td><td>
-UiSchema
-</td><td>
-UI schema configuration for the filters component
-</td></tr>
-<tr><td>
-[formRenderers](./foundation-entity-management.entitymanagement.formrenderers.md)
-</td><td>
-</td><td>
-RendererEntry\[\]
-</td><td>
-Array with renderers used by foundation-forms
-</td></tr>
-<tr><td>
-[gridAutosizing](./foundation-entity-management.entitymanagement.gridautosizing.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.
-</td></tr>
-<tr><td>
-[gridOptions](./foundation-entity-management.entitymanagement.gridoptions.md)
-</td><td>
-</td><td>
-GridOptions
-</td><td>
-GridOptions to be passed down from application
-</td></tr>
-<tr><td>
-[headerCaseType](./foundation-entity-management.entitymanagement.headercasetype.md)
-</td><td>
-</td><td>
-GridProCaseType
-</td><td>
-The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used.
-</td></tr>
-<tr><td>
-[hideDelete](./foundation-entity-management.entitymanagement.hidedelete.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Hides delete button
-</td></tr>
-<tr><td>
-[hideEdit](./foundation-entity-management.entitymanagement.hideedit.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Hides edit button
-</td></tr>
-<tr><td>
-[modalPosition](./foundation-entity-management.entitymanagement.modalposition.md)
-</td><td>
-</td><td>
-'centre' \| 'left' \| 'right'
-</td><td>
-Determines where the modal dialog will appear on screen
-</td></tr>
-<tr><td>
-[persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md)
-</td><td>
-</td><td>
-string
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[persistFilterModelKey](./foundation-entity-management.entitymanagement.persistfiltermodelkey.md)
-</td><td>
-</td><td>
-string
-</td><td>
-The key to use for persisting the filter model in local browser or KV storage.
-</td></tr>
-<tr><td>
-[prefix](./foundation-entity-management.entitymanagement.prefix.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Name of the design system prefix that will be used in renderers.
-</td></tr>
-<tr><td>
-[readEvent](./foundation-entity-management.entitymanagement.readevent.md)
-</td><td>
-</td><td>
-string
-</td><td>
-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
-</td></tr>
-<tr><td>
-[readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md)
-</td><td>
-</td><td>
-(entity: any) =&gt; any
-</td><td>
-Similar to readEvent but allows to provide function that will be executed before opening the form and yields data to the form
-</td></tr>
-<tr><td>
-[resourceName](./foundation-entity-management.entitymanagement.resourcename.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Name of the backend resource which contain the entities to manage
-</td></tr>
-<tr><td>
-[rowSelection](./foundation-entity-management.entitymanagement.rowselection.md)
-</td><td>
-</td><td>
-string
-</td><td>
-This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.
-</td></tr>
-<tr><td>
-[searchBarConfig](./foundation-entity-management.entitymanagement.searchbarconfig.md)
-</td><td>
-</td><td>
-AvailableOption\[\]
-</td><td>
-Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid \*
-</td></tr>
-<tr><td>
-[setApprovalMessage](./foundation-entity-management.entitymanagement.setapprovalmessage.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[showFilterPersistenceControls](./foundation-entity-management.entitymanagement.showfilterpersistencecontrols.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Controls visibility of filter save/load UI in foundation-filters
-</td></tr>
-<tr><td>
-[sizeColumnsToContent](./foundation-entity-management.entitymanagement.sizecolumnstocontent.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Auto-sizes a column based on its contents
-</td></tr>
-<tr><td>
-[sizeColumnsToFit](./foundation-entity-management.entitymanagement.sizecolumnstofit.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Resizes columns to take available space
-</td></tr>
-<tr><td>
-[statusBarConfig](./foundation-entity-management.entitymanagement.statusbarconfig.md)
-</td><td>
-</td><td>
-GridProStatusBarConfig
-</td><td>
-Configuration for the grid status bar components.
-</td></tr>
-<tr><td>
-[title](./foundation-entity-management.entitymanagement.title.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Title of the grid
-</td></tr>
-<tr><td>
-[updateEvent](./foundation-entity-management.entitymanagement.updateevent.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Name of the event handler on the Genesis server which handles updating the entity
-</td></tr>
-<tr><td>
-[updateFormUiSchema](./foundation-entity-management.entitymanagement.updateformuischema.md)
-</td><td>
-</td><td>
-UiSchema
-</td><td>
-Enables you to supply a schema to configure an update form.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[deleteColumnState(resetToDefault)](./foundation-entity-management.entitymanagement.deletecolumnstate.md)
-</td><td>
-</td><td>
-Deletes the saved column state for the grid
-</td></tr>
-<tr><td>
-[setDSConfigWithoutUpdatingBaseCriteria(config)](./foundation-entity-management.entitymanagement.setdsconfigwithoutupdatingbasecriteria.md)
-</td><td>
-</td><td>
-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)
-</td></tr>
-</tbody></table>