@sankhyalabs/core-docs 2.3.4 → 2.3.5

package/classes/DataUnit.md

@@ -0,0 +1,1394 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnit
+
+# Class: DataUnit
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DataUnit.md#constructor)
+
+### Properties
+
+- [\_filterProviders](DataUnit.md#_filterproviders)
+- [\_interceptors](DataUnit.md#_interceptors)
+- [\_name](DataUnit.md#_name)
+- [\_observers](DataUnit.md#_observers)
+- [\_pageSize](DataUnit.md#_pagesize)
+- [\_sortingProvider](DataUnit.md#_sortingprovider)
+- [\_stateManager](DataUnit.md#_statemanager)
+- [dataLoader](DataUnit.md#dataloader)
+- [metadataLoader](DataUnit.md#metadataloader)
+- [recordLoader](DataUnit.md#recordloader)
+- [removeLoader](DataUnit.md#removeloader)
+- [saveLoader](DataUnit.md#saveloader)
+
+### Accessors
+
+- [metadata](DataUnit.md#metadata)
+- [name](DataUnit.md#name)
+- [pageSize](DataUnit.md#pagesize)
+- [records](DataUnit.md#records)
+- [sortingProvider](DataUnit.md#sortingprovider)
+
+### Methods
+
+- [addFilterProvider](DataUnit.md#addfilterprovider)
+- [addInterceptor](DataUnit.md#addinterceptor)
+- [addRecord](DataUnit.md#addrecord)
+- [canRedo](DataUnit.md#canredo)
+- [canUndo](DataUnit.md#canundo)
+- [cancelEdition](DataUnit.md#canceledition)
+- [cancelWaitingChange](DataUnit.md#cancelwaitingchange)
+- [copySelected](DataUnit.md#copyselected)
+- [dispatchAction](DataUnit.md#dispatchaction)
+- [doDispatchAction](DataUnit.md#dodispatchaction)
+- [executeLoadData](DataUnit.md#executeloaddata)
+- [getField](DataUnit.md#getfield)
+- [getFieldValue](DataUnit.md#getfieldvalue)
+- [getFielterProviderKey](DataUnit.md#getfielterproviderkey)
+- [getFilters](DataUnit.md#getfilters)
+- [getModifiedRecords](DataUnit.md#getmodifiedrecords)
+- [getPaginationInfo](DataUnit.md#getpaginationinfo)
+- [getSelectedRecords](DataUnit.md#getselectedrecords)
+- [getSelection](DataUnit.md#getselection)
+- [getSort](DataUnit.md#getsort)
+- [gotoPage](DataUnit.md#gotopage)
+- [hasDirtyRecords](DataUnit.md#hasdirtyrecords)
+- [hasNext](DataUnit.md#hasnext)
+- [hasPrevious](DataUnit.md#hasprevious)
+- [intercept](DataUnit.md#intercept)
+- [isDirty](DataUnit.md#isdirty)
+- [loadData](DataUnit.md#loaddata)
+- [loadMetadata](DataUnit.md#loadmetadata)
+- [nextPage](DataUnit.md#nextpage)
+- [nextRecord](DataUnit.md#nextrecord)
+- [previousPage](DataUnit.md#previouspage)
+- [previousRecord](DataUnit.md#previousrecord)
+- [redo](DataUnit.md#redo)
+- [reloadCurrentRecord](DataUnit.md#reloadcurrentrecord)
+- [removeInterceptor](DataUnit.md#removeinterceptor)
+- [removeRecords](DataUnit.md#removerecords)
+- [removeSelectedRecords](DataUnit.md#removeselectedrecords)
+- [saveData](DataUnit.md#savedata)
+- [selectFirst](DataUnit.md#selectfirst)
+- [selectLast](DataUnit.md#selectlast)
+- [setFieldValue](DataUnit.md#setfieldvalue)
+- [setSelection](DataUnit.md#setselection)
+- [setSelectionByIndex](DataUnit.md#setselectionbyindex)
+- [startChange](DataUnit.md#startchange)
+- [subscribe](DataUnit.md#subscribe)
+- [toString](DataUnit.md#tostring)
+- [undo](DataUnit.md#undo)
+- [unsubscribe](DataUnit.md#unsubscribe)
+- [validateAndTypeValue](DataUnit.md#validateandtypevalue)
+- [valueFromString](DataUnit.md#valuefromstring)
+- [valueToString](DataUnit.md#valuetostring)
+- [waitingForChange](DataUnit.md#waitingforchange)
+
+## Constructors
+
+### constructor
+
+• **new DataUnit**(`name`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:40
+
+## Properties
+
+### \_filterProviders
+
+• `Private` **\_filterProviders**: `Map`<`string`, `FilterProvider`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:29
+
+___
+
+### \_interceptors
+
+• `Private` **\_interceptors**: [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:31
+
+___
+
+### \_name
+
+• `Private` **\_name**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:26
+
+___
+
+### \_observers
+
+• `Private` **\_observers**: (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:27
+
+___
+
+### \_pageSize
+
+• `Private` **\_pageSize**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:32
+
+___
+
+### \_sortingProvider
+
+• `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:28
+
+___
+
+### \_stateManager
+
+• `Private` **\_stateManager**: `default`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:30
+
+___
+
+### dataLoader
+
+• `Optional` **dataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
+
+##### Returns
+
+`Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:35
+
+___
+
+### metadataLoader
+
+• `Optional` **metadataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Type declaration
+
+▸ (`dataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+
+##### Returns
+
+`Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:34
+
+___
+
+### recordLoader
+
+• `Optional` **recordLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `recordIds` | `string`[] |
+
+##### Returns
+
+`Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:38
+
+___
+
+### removeLoader
+
+• `Optional` **removeLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `recordIds`): `Promise`<`string`[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `recordIds` | `string`[] |
+
+##### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:37
+
+___
+
+### saveLoader
+
+• `Optional` **saveLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `changes` | [`Change`](Change.md)[] |
+
+##### Returns
+
+`Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:36
+
+## Accessors
+
+### metadata
+
+• `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Returns
+
+[`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:294
+
+• `set` **metadata**(`md`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `md` | [`UnitMetadata`](../interfaces/UnitMetadata.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:290
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:63
+
+___
+
+### pageSize
+
+• `get` **pageSize**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:311
+
+• `set` **pageSize**(`size`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `size` | `number` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:307
+
+___
+
+### records
+
+• `get` **records**(): [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:302
+
+• `set` **records**(`r`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `r` | [`Record`](../interfaces/Record.md)[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:298
+
+___
+
+### sortingProvider
+
+• `set` **sortingProvider**(`provider`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `provider` | [`SortingProvider`](../interfaces/SortingProvider.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:286
+
+## Methods
+
+### addFilterProvider
+
+▸ **addFilterProvider**(`provider`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `provider` | `FilterProvider` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:278
+
+___
+
+### addInterceptor
+
+▸ **addInterceptor**(`interceptor`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:270
+
+___
+
+### addRecord
+
+▸ **addRecord**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:324
+
+___
+
+### canRedo
+
+▸ **canRedo**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:465
+
+___
+
+### canUndo
+
+▸ **canUndo**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:461
+
+___
+
+### cancelEdition
+
+▸ **cancelEdition**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:433
+
+___
+
+### cancelWaitingChange
+
+▸ **cancelWaitingChange**(`fieldName`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:357
+
+___
+
+### copySelected
+
+▸ **copySelected**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:328
+
+___
+
+### dispatchAction
+
+▸ `Private` **dispatchAction**(`actionType`, `payload?`, `executionCtx?`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `actionType` | [`Action`](../enums/Action.md) |
+| `payload?` | `any` |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:482
+
+___
+
+### doDispatchAction
+
+▸ `Private` **doDispatchAction**(`action`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](DataUnitAction.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:513
+
+___
+
+### executeLoadData
+
+▸ `Private` **executeLoadData**(`request`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:95
+
+___
+
+### getField
+
+▸ **getField**(`fieldName`): `undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+
+#### Returns
+
+`undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:320
+
+___
+
+### getFieldValue
+
+▸ **getFieldValue**(`fieldName`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:339
+
+___
+
+### getFielterProviderKey
+
+▸ `Private` **getFielterProviderKey**(`provider`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `provider` | `FilterProvider` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:88
+
+___
+
+### getFilters
+
+▸ `Private` **getFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
+
+#### Returns
+
+`undefined` \| [`Filter`](../interfaces/Filter.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:73
+
+___
+
+### getModifiedRecords
+
+▸ **getModifiedRecords**(): [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:315
+
+___
+
+### getPaginationInfo
+
+▸ **getPaginationInfo**(): `void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+#### Returns
+
+`void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:282
+
+___
+
+### getSelectedRecords
+
+▸ **getSelectedRecords**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:385
+
+___
+
+### getSelection
+
+▸ **getSelection**(): `string`[]
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:361
+
+___
+
+### getSort
+
+▸ `Private` **getSort**(): `undefined` \| [`Sort`](../interfaces/Sort.md)[]
+
+#### Returns
+
+`undefined` \| [`Sort`](../interfaces/Sort.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:84
+
+___
+
+### gotoPage
+
+▸ **gotoPage**(`page`, `executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:148
+
+___
+
+### hasDirtyRecords
+
+▸ **hasDirtyRecords**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:441
+
+___
+
+### hasNext
+
+▸ **hasNext**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:445
+
+___
+
+### hasPrevious
+
+▸ **hasPrevious**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:453
+
+___
+
+### intercept
+
+▸ `Private` **intercept**(`action`, `interceptors`): `Promise`<[`DataUnitAction`](DataUnitAction.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](DataUnitAction.md) |
+| `interceptors` | `IterableIterator`<[`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\> |
+
+#### Returns
+
+`Promise`<[`DataUnitAction`](DataUnitAction.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:503
+
+___
+
+### isDirty
+
+▸ **isDirty**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:437
+
+___
+
+### loadData
+
+▸ **loadData**(`quickFilter?`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:132
+
+___
+
+### loadMetadata
+
+▸ **loadMetadata**(`executionCtx?`): `Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:114
+
+___
+
+### nextPage
+
+▸ **nextPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:168
+
+___
+
+### nextRecord
+
+▸ **nextRecord**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:393
+
+___
+
+### previousPage
+
+▸ **previousPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:172
+
+___
+
+### previousRecord
+
+▸ **previousRecord**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:413
+
+___
+
+### redo
+
+▸ **redo**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:473
+
+___
+
+### reloadCurrentRecord
+
+▸ **reloadCurrentRecord**(): `Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+#### Returns
+
+`Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:536
+
+___
+
+### removeInterceptor
+
+▸ **removeInterceptor**(`interceptor`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:274
+
+___
+
+### removeRecords
+
+▸ **removeRecords**(`recordIds`, `cachedRecords`, `buffered?`, `executionCtx?`): `Promise`<`string`[]\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `recordIds` | `string`[] | `undefined` |
+| `cachedRecords` | [`Record`](../interfaces/Record.md)[] | `undefined` |
+| `buffered` | `boolean` | `false` |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:221
+
+___
+
+### removeSelectedRecords
+
+▸ **removeSelectedRecords**(`buffered?`): `Promise`<`string`[]\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `buffered` | `boolean` | `false` |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:212
+
+___
+
+### saveData
+
+▸ **saveData**(`executionCtx?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:176
+
+___
+
+### selectFirst
+
+▸ **selectFirst**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:369
+
+___
+
+### selectLast
+
+▸ **selectLast**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:375
+
+___
+
+### setFieldValue
+
+▸ **setFieldValue**(`fieldName`, `newValue`, `records?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+| `newValue` | `any` |
+| `records?` | `string`[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:343
+
+___
+
+### setSelection
+
+▸ **setSelection**(`selection`, `executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `selection` | `string`[] |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:365
+
+___
+
+### setSelectionByIndex
+
+▸ **setSelectionByIndex**(`selection`, `executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `selection` | `number`[] |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:381
+
+___
+
+### startChange
+
+▸ **startChange**(`fieldName`, `waitingChange`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+| `waitingChange` | [`WaitingChange`](../interfaces/WaitingChange.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:353
+
+___
+
+### subscribe
+
+▸ **subscribe**(`observer`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `observer` | (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:528
+
+___
+
+### toString
+
+▸ **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:477
+
+___
+
+### undo
+
+▸ **undo**(`executionCtx?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:469
+
+___
+
+### unsubscribe
+
+▸ **unsubscribe**(`observer`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `observer` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:532
+
+___
+
+### validateAndTypeValue
+
+▸ `Private` **validateAndTypeValue**(`fieldName`, `newValue`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+| `newValue` | `any` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:68
+
+___
+
+### valueFromString
+
+▸ **valueFromString**(`fieldName`, `value`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+| `value` | `string` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:260
+
+___
+
+### valueToString
+
+▸ **valueToString**(`fieldName`, `value`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+| `value` | `any` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:265
+
+___
+
+### waitingForChange
+
+▸ **waitingForChange**(`fieldName`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:335