@sankhyalabs/core-docs 5.20.0-dev.9 → 5.20.0-ms.2

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1795
+src/dataunit/DataUnit.ts:1967
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1795
 
 #### Source
 
-src/dataunit/DataUnit.ts:1797
+src/dataunit/DataUnit.ts:1969
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1797
 
 #### Source
 
-src/dataunit/DataUnit.ts:1794
+src/dataunit/DataUnit.ts:1966
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1794
 
 #### Source
 
-src/dataunit/DataUnit.ts:1796
+src/dataunit/DataUnit.ts:1968

package/enumerations/LockManagerOperation.md

@@ -0,0 +1,33 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManagerOperation
+
+# Enumeration: LockManagerOperation
+
+Define os tipos de operação que o locker pode controlar
+
+## Enumeration Members
+
+### APP\_LOADING
+
+> **APP\_LOADING**: `"app_loading"`
+
+Operação de lock utilizada para controlar carregamento da aplicação.
+
+#### Source
+
+src/utils/LockManager.ts:13
+
+***
+
+### TASKBAR\_CLICK
+
+> **TASKBAR\_CLICK**: `"taskbar_click"`
+
+Operação de lock utilizada para controlar cliques nos botoes da taskbar.
+
+#### Source
+
+src/utils/LockManager.ts:9

package/enumerations/RECORD_DATE_FORMAT.md

@@ -0,0 +1,27 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / RECORD\_DATE\_FORMAT
+
+# Enumeration: RECORD\_DATE\_FORMAT
+
+## Enumeration Members
+
+### DD\_MM\_YYYY
+
+> **DD\_MM\_YYYY**: `"DD/MM/YYYY"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:8
+
+***
+
+### ISO
+
+> **ISO**: `"ISO"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:9

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1903
+src/dataunit/DataUnit.ts:2075
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1903
 
 #### Source
 
-src/dataunit/DataUnit.ts:1904
+src/dataunit/DataUnit.ts:2076

package/enumerations/StorageType.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / StorageType
+
+# Enumeration: StorageType
+
+## Enumeration Members
+
+### IN\_MEMORY\_CACHE
+
+> **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:2
+
+***
+
+### LOCAL\_STORAGE
+
+> **LOCAL\_STORAGE**: `"localStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:4
+
+***
+
+### SESSION\_STORAGE
+
+> **SESSION\_STORAGE**: `"sessionStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:3

package/globals.md

@@ -14,9 +14,12 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
 - [OverflowDirection](enumerations/OverflowDirection.md)
+- [RECORD\_DATE\_FORMAT](enumerations/RECORD_DATE_FORMAT.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -24,9 +27,13 @@
 - [ApplicationContext](classes/ApplicationContext.md)
 - [ArrayUtils](classes/ArrayUtils.md)
 - [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
+- [Base64Utils](classes/Base64Utils.md)
 - [Change](classes/Change.md)
+- [ColumnFilterManager](classes/ColumnFilterManager.md)
 - [DataUnit](classes/DataUnit.md)
 - [DataUnitAction](classes/DataUnitAction.md)
+- [DataUnitInMemoryLoader](classes/DataUnitInMemoryLoader.md)
+- [DataUnitLoaderUtils](classes/DataUnitLoaderUtils.md)
 - [DataUnitStorage](classes/DataUnitStorage.md)
 - [DateUtils](classes/DateUtils.md)
 - [ElementIDUtils](classes/ElementIDUtils.md)
@@ -39,6 +46,7 @@
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
 - [KeyboardManager](classes/KeyboardManager.md)
+- [LockManager](classes/LockManager.md)
 - [MaskFormatter](classes/MaskFormatter.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
@@ -49,6 +57,9 @@
 - [RequestMetadata](classes/RequestMetadata.md)
 - [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
+- [ServiceCanceledException](classes/ServiceCanceledException.md)
+- [ServiceUtils](classes/ServiceUtils.md)
+- [SilentException](classes/SilentException.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)
 - [TimeFormatter](classes/TimeFormatter.md)
@@ -62,6 +73,7 @@
 - [ChildDescriptor](interfaces/ChildDescriptor.md)
 - [ChildLink](interfaces/ChildLink.md)
 - [DUActionInterceptor](interfaces/DUActionInterceptor.md)
+- [DataUnitInMemoryLoaderConfig](interfaces/DataUnitInMemoryLoaderConfig.md)
 - [ExecutionContext](interfaces/ExecutionContext.md)
 - [FieldDescriptor](interfaces/FieldDescriptor.md)
 - [Filter](interfaces/Filter.md)
@@ -71,8 +83,10 @@
 - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
 - [LoadDataRequest](interfaces/LoadDataRequest.md)
 - [LoadDataResponse](interfaces/LoadDataResponse.md)
+- [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
+- [PaginationInfoBuilderParams](interfaces/PaginationInfoBuilderParams.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
 - [QuickFilter](interfaces/QuickFilter.md)
 - [Record](interfaces/Record.md)
@@ -84,8 +98,13 @@
 
 ## Type Aliases
 
+- [DataUnitEventOptions](type-aliases/DataUnitEventOptions.md)
 - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
 
+## Variables
+
+- [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
+
 ## Functions
 
 - [defaultDataLoader](functions/defaultDataLoader.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1778
+src/dataunit/DataUnit.ts:1950

package/interfaces/DataUnitInMemoryLoaderConfig.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoaderConfig
+
+# Interface: DataUnitInMemoryLoaderConfig
+
+## Properties
+
+### autoLoad?
+
+> `optional` **autoLoad**: `boolean`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:2
+
+***
+
+### pageSize?
+
+> `optional` **pageSize**: `number`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:3
+
+***
+
+### recordDateFormat?
+
+> `optional` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:4

package/interfaces/IRepository.md

@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
 
 ***
 
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
+
+Retorna todos os registros que estão em cache no momento
+
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Source
+
+src/repository/IRepository.ts:88
+
+***
+
 ### insert()
 
 > **insert**(`itemReference`, `items`): `Promise`\<`void`\>

package/interfaces/LoadDataRequest.md

@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
 
 ### source?
 
-> `optional` **source**: `String`
+> `optional` **source**: `string`
 
 De onde partiu o refresh. Por padrão a fonte não é identificada
 

package/interfaces/OverFlowWatcherParams.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverFlowWatcherParams
+
+# Interface: OverFlowWatcherParams
+
+## Properties
+
+### callback
+
+> **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:233
+
+***
+
+### debounce?
+
+> `optional` **debounce**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:236
+
+***
+
+### deltaSize?
+
+> `optional` **deltaSize**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:235
+
+***
+
+### element
+
+> **element**: `HTMLElement`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:232
+
+***
+
+### notOverFlow?
+
+> `optional` **notOverFlow**: `string`[]
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:237
+
+***
+
+### overFlowDirection?
+
+> `optional` **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:234

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1883
+src/dataunit/DataUnit.ts:2055
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1883
 
 #### Source
 
-src/dataunit/DataUnit.ts:1884
+src/dataunit/DataUnit.ts:2056
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1884
 
 #### Source
 
-src/dataunit/DataUnit.ts:1885
+src/dataunit/DataUnit.ts:2057

package/interfaces/PaginationInfo.md

@@ -10,6 +10,18 @@ Informações da paginação retornada na requisição de carregamento de regist
 
 ## Properties
 
+### askRowsLimit?
+
+> `optional` **askRowsLimit**: `number`
+
+Informa se deve exibir diálogo para cancelar carregamento de registros
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:30
+
+***
+
 ### count?
 
 > `optional` **count**: `number`
@@ -70,6 +82,19 @@ src/dataunit/loading/PaginationInfo.ts:11
 
 ***
 
+### loadingInProgress?
+
+> `optional` **loadingInProgress**: `boolean`
+
+Informa se o carregamento de dados em background está sendo executado
+ Caso o dataunit não tenha carga paralela o valor será indefinido
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:25
+
+***
+
 ### total?
 
 > `optional` **total**: `number`

package/interfaces/PaginationInfoBuilderParams.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / PaginationInfoBuilderParams
+
+# Interface: PaginationInfoBuilderParams
+
+## Properties
+
+### offset
+
+> **offset**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
+
+***
+
+### recordsLength
+
+> **recordsLength**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
+
+***
+
+### recordsPerPage
+
+> **recordsPerPage**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85

package/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1890
+src/dataunit/DataUnit.ts:2062
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1890
 
 #### Source
 
-src/dataunit/DataUnit.ts:1891
+src/dataunit/DataUnit.ts:2063
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1891
 
 #### Source
 
-src/dataunit/DataUnit.ts:1889
+src/dataunit/DataUnit.ts:2061

package/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1785
+src/dataunit/DataUnit.ts:1957
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1785
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1956
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1954
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1782
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1955

package/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1790
+src/dataunit/DataUnit.ts:1962
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1790
 
 #### Source
 
-src/dataunit/DataUnit.ts:1785
+src/dataunit/DataUnit.ts:1957
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1785
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1956
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1954
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1782
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1955

package/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1878
+src/dataunit/DataUnit.ts:2050
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1878
 
 #### Source
 
-src/dataunit/DataUnit.ts:1879
+src/dataunit/DataUnit.ts:2051
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1879
 
 #### Source
 
-src/dataunit/DataUnit.ts:1877
+src/dataunit/DataUnit.ts:2049

package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:257

package/namespaces/MaskFormatter/variables/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:257

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "5.20.0-dev.9",
+    "version": "5.20.0-ms.2",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [

package/type-aliases/DataUnitEventOptions.md

@@ -0,0 +1,17 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitEventOptions
+
+# Type alias: DataUnitEventOptions
+
+> **DataUnitEventOptions**: `object`
+
+## Index signature
+
+ \[`key`: `string`\]: `any`
+
+## Source
+
+src/dataunit/DataUnit.ts:2132

package/variables/OVERFLOWED_CLASS_NAME.md

@@ -0,0 +1,13 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
+
+# Variable: OVERFLOWED\_CLASS\_NAME
+
+> `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
+
+## Source
+
+src/utils/OverflowWatcher/index.ts:9