@sankhyalabs/core-docs 5.20.0-dev.3 → 5.20.0-dev.31

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 (84) hide show
  1. package/README.md +3 -1
  2. package/classes/ApplicationContext.md +31 -32
  3. package/classes/ArrayUtils.md +95 -83
  4. package/classes/AuthorizedServiceCaller.md +25 -34
  5. package/classes/Change.md +59 -74
  6. package/classes/DataUnit.md +1052 -1075
  7. package/classes/DataUnitAction.md +25 -42
  8. package/classes/DataUnitStorage.md +40 -43
  9. package/classes/DateUtils.md +133 -126
  10. package/classes/ElementIDUtils.md +123 -122
  11. package/classes/ErrorException.md +67 -88
  12. package/classes/ErrorTracking.md +20 -23
  13. package/classes/FieldComparator.md +35 -39
  14. package/classes/FloatingManager.md +195 -198
  15. package/classes/HTMLBuilder.md +14 -20
  16. package/classes/HttpProvider.md +45 -41
  17. package/classes/IDBRepository.md +179 -196
  18. package/classes/JSUtils.md +65 -66
  19. package/classes/KeyboardManager.md +95 -87
  20. package/classes/{MaskFormatter-1.md → MaskFormatter.md} +81 -120
  21. package/classes/NumberUtils.md +163 -152
  22. package/classes/ObjectUtils.md +113 -70
  23. package/classes/OnboardingUtils.md +36 -51
  24. package/classes/OverflowWatcher.md +533 -0
  25. package/classes/PromiseSync.md +25 -42
  26. package/classes/ReadyUtil.md +31 -41
  27. package/classes/RequestMetadata.md +29 -30
  28. package/classes/SearchUtils.md +18 -20
  29. package/classes/SelectionInfo.md +59 -74
  30. package/classes/SkwHttpProvider.md +33 -45
  31. package/classes/StringUtils.md +297 -322
  32. package/classes/TimeFormatter.md +43 -44
  33. package/classes/UserAgentUtils.md +17 -20
  34. package/classes/VersionUtils.md +15 -18
  35. package/classes/WaitingChangeException.md +63 -84
  36. package/classes/WarningException.md +67 -88
  37. package/enumerations/Action.md +297 -0
  38. package/enumerations/ChangeOperation.md +47 -0
  39. package/enumerations/DataType.md +57 -0
  40. package/enumerations/DependencyType.md +37 -0
  41. package/enumerations/OverflowDirection.md +29 -0
  42. package/enumerations/SelectionMode.md +27 -0
  43. package/enumerations/SortMode.md +27 -0
  44. package/enumerations/UserInterface.md +177 -0
  45. package/functions/defaultDataLoader.md +25 -0
  46. package/{modules.md → globals.md} +26 -36
  47. package/interfaces/ChildDescriptor.md +12 -16
  48. package/interfaces/ChildLink.md +9 -12
  49. package/interfaces/DUActionInterceptor.md +10 -14
  50. package/interfaces/ExecutionContext.md +17 -32
  51. package/interfaces/FieldDescriptor.md +52 -66
  52. package/interfaces/Filter.md +13 -17
  53. package/interfaces/IElementIDInfo.md +11 -14
  54. package/interfaces/ILoadResult.md +11 -16
  55. package/interfaces/IRepository.md +88 -93
  56. package/interfaces/IRepositoryIndex.md +23 -30
  57. package/interfaces/LoadDataRequest.md +36 -45
  58. package/interfaces/LoadDataResponse.md +11 -14
  59. package/interfaces/OverFlowWatcherParams.md +67 -0
  60. package/interfaces/PageRequest.md +16 -20
  61. package/interfaces/PaginationInfo.md +24 -31
  62. package/interfaces/PromiseSyncCallback.md +13 -17
  63. package/interfaces/QuickFilter.md +17 -21
  64. package/interfaces/Record.md +26 -33
  65. package/interfaces/SavedRecord.md +33 -41
  66. package/interfaces/Sort.md +12 -16
  67. package/interfaces/SortingProvider.md +10 -13
  68. package/interfaces/UnitMetadata.md +16 -21
  69. package/interfaces/WaitingChange.md +16 -20
  70. package/namespaces/MaskFormatter/README.md +17 -0
  71. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  72. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  73. package/package.json +1 -1
  74. package/type-aliases/DataUnitEventOptions.md +17 -0
  75. package/type-aliases/OnOverflowCallBack.md +25 -0
  76. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
  77. package/enums/Action.md +0 -305
  78. package/enums/ChangeOperation.md +0 -52
  79. package/enums/DataType.md +0 -63
  80. package/enums/DependencyType.md +0 -41
  81. package/enums/SelectionMode.md +0 -30
  82. package/enums/SortMode.md +0 -30
  83. package/enums/UserInterface.md +0 -195
  84. package/modules/MaskFormatter.md +0 -37
package/classes/DataUnit.md CHANGED
@@ -1,511 +1,366 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnit
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / DataUnit
2
6
 
3
7
  # Class: DataUnit
4
8
 
5
9
  `DataUnit`: Atua como uma camada de abstração entre o back-end e a interface do usuário.
6
10
 
7
- ## Table of contents
8
-
9
- ### Constructors
10
-
11
- - [constructor](DataUnit.md#constructor)
12
-
13
- ### Properties
14
-
15
- - [\_childByName](DataUnit.md#_childbyname)
16
- - [\_defaultSorting](DataUnit.md#_defaultsorting)
17
- - [\_filterProviders](DataUnit.md#_filterproviders)
18
- - [\_interceptors](DataUnit.md#_interceptors)
19
- - [\_loadingLockers](DataUnit.md#_loadinglockers)
20
- - [\_name](DataUnit.md#_name)
21
- - [\_observers](DataUnit.md#_observers)
22
- - [\_pageSize](DataUnit.md#_pagesize)
23
- - [\_parentDataUnit](DataUnit.md#_parentdataunit)
24
- - [\_savingLockers](DataUnit.md#_savinglockers)
25
- - [\_sortingProvider](DataUnit.md#_sortingprovider)
26
- - [\_stateManager](DataUnit.md#_statemanager)
27
- - [\_uuid](DataUnit.md#_uuid)
28
- - [dataLoader](DataUnit.md#dataloader)
29
- - [metadataLoader](DataUnit.md#metadataloader)
30
- - [recordLoader](DataUnit.md#recordloader)
31
- - [removeLoader](DataUnit.md#removeloader)
32
- - [saveLoader](DataUnit.md#saveloader)
33
- - [CHANGING\_PAGE\_LOADING\_SOURCE](DataUnit.md#changing_page_loading_source)
34
- - [DEFAULT\_DATAUNIT\_NAME](DataUnit.md#default_dataunit_name)
35
-
36
- ### Accessors
37
-
38
- - [dataUnitId](DataUnit.md#dataunitid)
39
- - [defaultSorting](DataUnit.md#defaultsorting)
40
- - [metadata](DataUnit.md#metadata)
41
- - [name](DataUnit.md#name)
42
- - [pageSize](DataUnit.md#pagesize)
43
- - [records](DataUnit.md#records)
44
- - [sortingProvider](DataUnit.md#sortingprovider)
45
-
46
- ### Methods
47
-
48
- - [addFilterProvider](DataUnit.md#addfilterprovider)
49
- - [addInterceptor](DataUnit.md#addinterceptor)
50
- - [addLoadingLocker](DataUnit.md#addloadinglocker)
51
- - [addRecord](DataUnit.md#addrecord)
52
- - [addStandAloneField](DataUnit.md#addstandalonefield)
53
- - [buildChangesToSave](DataUnit.md#buildchangestosave)
54
- - [buildChangesToSaveFromChild](DataUnit.md#buildchangestosavefromchild)
55
- - [canRedo](DataUnit.md#canredo)
56
- - [canUndo](DataUnit.md#canundo)
57
- - [cancelEdition](DataUnit.md#canceledition)
58
- - [cancelWaitingChange](DataUnit.md#cancelwaitingchange)
59
- - [childrenIsDirty](DataUnit.md#childrenisdirty)
60
- - [clearDataUnit](DataUnit.md#cleardataunit)
61
- - [clearInvalid](DataUnit.md#clearinvalid)
62
- - [clearSelection](DataUnit.md#clearselection)
63
- - [copySelected](DataUnit.md#copyselected)
64
- - [disableField](DataUnit.md#disablefield)
65
- - [dispatchAction](DataUnit.md#dispatchaction)
66
- - [doDispatchAction](DataUnit.md#dodispatchaction)
67
- - [enableField](DataUnit.md#enablefield)
68
- - [executeLoadData](DataUnit.md#executeloaddata)
69
- - [getAddedRecords](DataUnit.md#getaddedrecords)
70
- - [getAllChangesToSave](DataUnit.md#getallchangestosave)
71
- - [getAppliedFilters](DataUnit.md#getappliedfilters)
72
- - [getBeforeSavePromisses](DataUnit.md#getbeforesavepromisses)
73
- - [getChildDataunit](DataUnit.md#getchilddataunit)
74
- - [getChildInfo](DataUnit.md#getchildinfo)
75
- - [getField](DataUnit.md#getfield)
76
- - [getFieldValue](DataUnit.md#getfieldvalue)
77
- - [getFielterProviderKey](DataUnit.md#getfielterproviderkey)
78
- - [getFilters](DataUnit.md#getfilters)
79
- - [getFormattedValue](DataUnit.md#getformattedvalue)
80
- - [getInvalidMessage](DataUnit.md#getinvalidmessage)
81
- - [getLastLoadRequest](DataUnit.md#getlastloadrequest)
82
- - [getLoadDataRequest](DataUnit.md#getloaddatarequest)
83
- - [getModifiedRecords](DataUnit.md#getmodifiedrecords)
84
- - [getPaginationInfo](DataUnit.md#getpaginationinfo)
85
- - [getParentRecordId](DataUnit.md#getparentrecordid)
86
- - [getRecordsByDataUnit](DataUnit.md#getrecordsbydataunit)
87
- - [getSelectedRecord](DataUnit.md#getselectedrecord)
88
- - [getSelectedRecords](DataUnit.md#getselectedrecords)
89
- - [getSelection](DataUnit.md#getselection)
90
- - [getSelectionInfo](DataUnit.md#getselectioninfo)
91
- - [getSort](DataUnit.md#getsort)
92
- - [gotoPage](DataUnit.md#gotopage)
93
- - [hasCopiedRecord](DataUnit.md#hascopiedrecord)
94
- - [hasDirtyRecords](DataUnit.md#hasdirtyrecords)
95
- - [hasNewRecord](DataUnit.md#hasnewrecord)
96
- - [hasNext](DataUnit.md#hasnext)
97
- - [hasPrevious](DataUnit.md#hasprevious)
98
- - [hasWaitingChanges](DataUnit.md#haswaitingchanges)
99
- - [hideField](DataUnit.md#hidefield)
100
- - [intercept](DataUnit.md#intercept)
101
- - [isDirty](DataUnit.md#isdirty)
102
- - [isNewRecord](DataUnit.md#isnewrecord)
103
- - [isSameRequest](DataUnit.md#issamerequest)
104
- - [loadData](DataUnit.md#loaddata)
105
- - [loadMetadata](DataUnit.md#loadmetadata)
106
- - [nextPage](DataUnit.md#nextpage)
107
- - [nextRecord](DataUnit.md#nextrecord)
108
- - [notifySavingData](DataUnit.md#notifysavingdata)
109
- - [onDataUnitParentEvent](DataUnit.md#ondataunitparentevent)
110
- - [previousPage](DataUnit.md#previouspage)
111
- - [previousRecord](DataUnit.md#previousrecord)
112
- - [processLoadingLockers](DataUnit.md#processloadinglockers)
113
- - [redo](DataUnit.md#redo)
114
- - [release](DataUnit.md#release)
115
- - [releaseCallbacks](DataUnit.md#releasecallbacks)
116
- - [reloadCurrentRecord](DataUnit.md#reloadcurrentrecord)
117
- - [removeChildDataunit](DataUnit.md#removechilddataunit)
118
- - [removeFilterProvider](DataUnit.md#removefilterprovider)
119
- - [removeInterceptor](DataUnit.md#removeinterceptor)
120
- - [removeRecords](DataUnit.md#removerecords)
121
- - [removeSelectedRecords](DataUnit.md#removeselectedrecords)
122
- - [requestSelectFirst](DataUnit.md#requestselectfirst)
123
- - [saveData](DataUnit.md#savedata)
124
- - [selectFirst](DataUnit.md#selectfirst)
125
- - [selectLast](DataUnit.md#selectlast)
126
- - [setFieldValue](DataUnit.md#setfieldvalue)
127
- - [setInvalidField](DataUnit.md#setinvalidfield)
128
- - [setSelection](DataUnit.md#setselection)
129
- - [setSelectionByIndex](DataUnit.md#setselectionbyindex)
130
- - [showField](DataUnit.md#showfield)
131
- - [startChange](DataUnit.md#startchange)
132
- - [subscribe](DataUnit.md#subscribe)
133
- - [toString](DataUnit.md#tostring)
134
- - [undo](DataUnit.md#undo)
135
- - [unsubscribe](DataUnit.md#unsubscribe)
136
- - [updatePageSelection](DataUnit.md#updatepageselection)
137
- - [updatePagination](DataUnit.md#updatepagination)
138
- - [validateAndTypeValue](DataUnit.md#validateandtypevalue)
139
- - [valueFromString](DataUnit.md#valuefromstring)
140
- - [valueToString](DataUnit.md#valuetostring)
141
- - [waitingForChange](DataUnit.md#waitingforchange)
142
-
143
11
  ## Constructors
144
12
 
145
- ### constructor
13
+ ### new DataUnit()
146
14
 
147
- • **new DataUnit**(`name?`, `parentDataUnit?`)
15
+ > **new DataUnit**(`name`, `parentDataUnit`?): [`DataUnit`](DataUnit.md)
148
16
 
149
17
  #### Parameters
150
18
 
151
- | Name | Type | Default value |
152
- | :------ | :------ | :------ |
153
- | `name` | `string` | `DataUnit.DEFAULT_DATAUNIT_NAME` |
154
- | `parentDataUnit?` | [`DataUnit`](DataUnit.md) | `undefined` |
19
+ • **name**: `string`= `DataUnit.DEFAULT_DATAUNIT_NAME`
155
20
 
156
- #### Defined in
21
+ • **parentDataUnit?**: [`DataUnit`](DataUnit.md)
157
22
 
158
- src/dataunit/DataUnit.ts:57
23
+ #### Returns
24
+
25
+ [`DataUnit`](DataUnit.md)
26
+
27
+ #### Source
28
+
29
+ src/dataunit/DataUnit.ts:59
159
30
 
160
31
  ## Properties
161
32
 
33
+ ### \_allowReleaseCallbacks
34
+
35
+ > `private` **\_allowReleaseCallbacks**: `boolean`
36
+
37
+ #### Source
38
+
39
+ src/dataunit/DataUnit.ts:51
40
+
41
+ ***
42
+
162
43
  ### \_childByName
163
44
 
164
- • `Private` **\_childByName**: `Map`<`string`, [`DataUnit`](DataUnit.md)\>
45
+ > `private` **\_childByName**: `Map`\<`string`, [`DataUnit`](DataUnit.md)\>
165
46
 
166
- #### Defined in
47
+ #### Source
167
48
 
168
- src/dataunit/DataUnit.ts:45
49
+ src/dataunit/DataUnit.ts:46
169
50
 
170
- ___
51
+ ***
171
52
 
172
53
  ### \_defaultSorting
173
54
 
174
- • `Private` **\_defaultSorting**: [`Sort`](../interfaces/Sort.md)[]
55
+ > `private` **\_defaultSorting**: [`Sort`](../interfaces/Sort.md)[]
175
56
 
176
- #### Defined in
57
+ #### Source
177
58
 
178
- src/dataunit/DataUnit.ts:49
59
+ src/dataunit/DataUnit.ts:50
179
60
 
180
- ___
61
+ ***
181
62
 
182
63
  ### \_filterProviders
183
64
 
184
- • `Private` **\_filterProviders**: `Map`<`string`, `FilterProvider`\>
65
+ > `private` **\_filterProviders**: `Map`\<`string`, `FilterProvider`\>
185
66
 
186
- #### Defined in
67
+ #### Source
187
68
 
188
- src/dataunit/DataUnit.ts:41
69
+ src/dataunit/DataUnit.ts:42
189
70
 
190
- ___
71
+ ***
191
72
 
192
73
  ### \_interceptors
193
74
 
194
- • `Private` **\_interceptors**: [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)[]
75
+ > `private` **\_interceptors**: `Map`\<`string`, [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\>
195
76
 
196
- #### Defined in
77
+ #### Source
197
78
 
198
- src/dataunit/DataUnit.ts:43
79
+ src/dataunit/DataUnit.ts:44
199
80
 
200
- ___
81
+ ***
201
82
 
202
83
  ### \_loadingLockers
203
84
 
204
- • `Private` **\_loadingLockers**: `Promise`<`void`\>[]
85
+ > `private` **\_loadingLockers**: `Promise`\<`void`\>[]
205
86
 
206
- #### Defined in
87
+ #### Source
207
88
 
208
- src/dataunit/DataUnit.ts:47
89
+ src/dataunit/DataUnit.ts:48
209
90
 
210
- ___
91
+ ***
211
92
 
212
93
  ### \_name
213
94
 
214
- • `Private` **\_name**: `string`
95
+ > `private` **\_name**: `string`
215
96
 
216
- #### Defined in
97
+ #### Source
217
98
 
218
- src/dataunit/DataUnit.ts:38
99
+ src/dataunit/DataUnit.ts:39
219
100
 
220
- ___
101
+ ***
221
102
 
222
103
  ### \_observers
223
104
 
224
- • `Private` **\_observers**: (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void`[]
105
+ > `private` **\_observers**: (`action`, `options`?) => `void`[]
225
106
 
226
- #### Defined in
107
+ #### Source
227
108
 
228
- src/dataunit/DataUnit.ts:39
109
+ src/dataunit/DataUnit.ts:40
229
110
 
230
- ___
111
+ ***
231
112
 
232
113
  ### \_pageSize
233
114
 
234
- • `Private` **\_pageSize**: `number`
115
+ > `private` **\_pageSize**: `number`
235
116
 
236
- #### Defined in
117
+ #### Source
237
118
 
238
- src/dataunit/DataUnit.ts:44
119
+ src/dataunit/DataUnit.ts:45
239
120
 
240
- ___
121
+ ***
241
122
 
242
123
  ### \_parentDataUnit
243
124
 
244
- • `Private` **\_parentDataUnit**: `undefined` \| [`DataUnit`](DataUnit.md)
125
+ > `private` **\_parentDataUnit**: `undefined` \| [`DataUnit`](DataUnit.md)
245
126
 
246
- #### Defined in
127
+ #### Source
247
128
 
248
- src/dataunit/DataUnit.ts:46
129
+ src/dataunit/DataUnit.ts:47
249
130
 
250
- ___
131
+ ***
251
132
 
252
133
  ### \_savingLockers
253
134
 
254
- • `Private` **\_savingLockers**: `Promise`<`any`\>[] = `[]`
135
+ > `private` **\_savingLockers**: `Promise`\<`any`\>[] = `[]`
255
136
 
256
- #### Defined in
137
+ #### Source
257
138
 
258
- src/dataunit/DataUnit.ts:48
139
+ src/dataunit/DataUnit.ts:49
259
140
 
260
- ___
141
+ ***
261
142
 
262
- ### \_sortingProvider
143
+ ### \_sortingProvider?
263
144
 
264
- • `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
145
+ > `private` `optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
265
146
 
266
- #### Defined in
147
+ #### Source
267
148
 
268
- src/dataunit/DataUnit.ts:40
149
+ src/dataunit/DataUnit.ts:41
269
150
 
270
- ___
151
+ ***
271
152
 
272
153
  ### \_stateManager
273
154
 
274
- • `Private` **\_stateManager**: `default`
155
+ > `private` **\_stateManager**: `default`
275
156
 
276
- #### Defined in
157
+ #### Source
277
158
 
278
- src/dataunit/DataUnit.ts:42
159
+ src/dataunit/DataUnit.ts:43
279
160
 
280
- ___
161
+ ***
281
162
 
282
163
  ### \_uuid
283
164
 
284
- • `Private` **\_uuid**: `string`
165
+ > `private` **\_uuid**: `string`
285
166
 
286
- #### Defined in
167
+ #### Source
287
168
 
288
- src/dataunit/DataUnit.ts:37
169
+ src/dataunit/DataUnit.ts:38
289
170
 
290
- ___
171
+ ***
291
172
 
292
- ### dataLoader
173
+ ### dataLoader()?
293
174
 
294
- • `Optional` **dataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
175
+ > `optional` **dataLoader**: (`dataUnit`, `request`) => `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
295
176
 
296
- #### Type declaration
177
+ #### Parameters
297
178
 
298
- ▸ (`dataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
179
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
299
180
 
300
- ##### Parameters
181
+ • **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
301
182
 
302
- | Name | Type |
303
- | :------ | :------ |
304
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
305
- | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
183
+ #### Returns
306
184
 
307
- ##### Returns
185
+ `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
308
186
 
309
- `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
187
+ #### Source
310
188
 
311
- #### Defined in
189
+ src/dataunit/DataUnit.ts:54
312
190
 
313
- src/dataunit/DataUnit.ts:52
191
+ ***
314
192
 
315
- ___
193
+ ### metadataLoader()?
316
194
 
317
- ### metadataLoader
195
+ > `optional` **metadataLoader**: (`dataUnit`) => `Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
318
196
 
319
- • `Optional` **metadataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
197
+ #### Parameters
320
198
 
321
- #### Type declaration
199
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
322
200
 
323
- ▸ (`dataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
201
+ #### Returns
324
202
 
325
- ##### Parameters
203
+ `Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
326
204
 
327
- | Name | Type |
328
- | :------ | :------ |
329
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
205
+ #### Source
330
206
 
331
- ##### Returns
207
+ src/dataunit/DataUnit.ts:53
332
208
 
333
- `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
209
+ ***
334
210
 
335
- #### Defined in
211
+ ### recordLoader()?
336
212
 
337
- src/dataunit/DataUnit.ts:51
213
+ > `optional` **recordLoader**: (`dataUnit`, `recordIds`) => `Promise`\<[`Record`](../interfaces/Record.md)[]\>
338
214
 
339
- ___
215
+ #### Parameters
340
216
 
341
- ### recordLoader
217
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
342
218
 
343
- • `Optional` **recordLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
219
+ • **recordIds**: `string`[]
344
220
 
345
- #### Type declaration
221
+ #### Returns
346
222
 
347
- ▸ (`dataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
223
+ `Promise`\<[`Record`](../interfaces/Record.md)[]\>
348
224
 
349
- ##### Parameters
225
+ #### Source
350
226
 
351
- | Name | Type |
352
- | :------ | :------ |
353
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
354
- | `recordIds` | `string`[] |
227
+ src/dataunit/DataUnit.ts:57
355
228
 
356
- ##### Returns
229
+ ***
357
230
 
358
- `Promise`<[`Record`](../interfaces/Record.md)[]\>
231
+ ### removeLoader()?
359
232
 
360
- #### Defined in
233
+ > `optional` **removeLoader**: (`dataUnit`, `recordIds`) => `Promise`\<`string`[]\>
361
234
 
362
- src/dataunit/DataUnit.ts:55
235
+ #### Parameters
363
236
 
364
- ___
237
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
365
238
 
366
- ### removeLoader
239
+ • **recordIds**: `string`[]
367
240
 
368
- • `Optional` **removeLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
241
+ #### Returns
369
242
 
370
- #### Type declaration
243
+ `Promise`\<`string`[]\>
371
244
 
372
- ▸ (`dataUnit`, `recordIds`): `Promise`<`string`[]\>
245
+ #### Source
373
246
 
374
- ##### Parameters
247
+ src/dataunit/DataUnit.ts:56
375
248
 
376
- | Name | Type |
377
- | :------ | :------ |
378
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
379
- | `recordIds` | `string`[] |
249
+ ***
380
250
 
381
- ##### Returns
251
+ ### saveLoader()?
382
252
 
383
- `Promise`<`string`[]\>
253
+ > `optional` **saveLoader**: (`dataUnit`, `changes`) => `Promise`\<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
384
254
 
385
- #### Defined in
255
+ #### Parameters
386
256
 
387
- src/dataunit/DataUnit.ts:54
257
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
388
258
 
389
- ___
259
+ • **changes**: [`Change`](Change.md)[]
390
260
 
391
- ### saveLoader
261
+ #### Returns
392
262
 
393
- • `Optional` **saveLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
263
+ `Promise`\<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
394
264
 
395
- #### Type declaration
265
+ #### Source
396
266
 
397
- ▸ (`dataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
267
+ src/dataunit/DataUnit.ts:55
398
268
 
399
- ##### Parameters
269
+ ***
400
270
 
401
- | Name | Type |
402
- | :------ | :------ |
403
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
404
- | `changes` | [`Change`](Change.md)[] |
271
+ ### CHANGING\_PAGE\_LOADING\_SOURCE
405
272
 
406
- ##### Returns
273
+ > `static` **CHANGING\_PAGE\_LOADING\_SOURCE**: `string` = `"CHANGING_PAGE_LOADING_SOURCE"`
407
274
 
408
- `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
275
+ #### Source
409
276
 
410
- #### Defined in
277
+ src/dataunit/DataUnit.ts:35
411
278
 
412
- src/dataunit/DataUnit.ts:53
279
+ ***
413
280
 
414
- ___
281
+ ### DEFAULT\_DATAUNIT\_NAME
415
282
 
416
- ### CHANGING\_PAGE\_LOADING\_SOURCE
283
+ > `static` **DEFAULT\_DATAUNIT\_NAME**: `string` = `"dataunit"`
284
+
285
+ #### Source
417
286
 
418
- ▪ `Static` **CHANGING\_PAGE\_LOADING\_SOURCE**: `string` = `"CHANGING_PAGE_LOADING_SOURCE"`
287
+ src/dataunit/DataUnit.ts:36
419
288
 
420
- #### Defined in
289
+ ## Accessors
421
290
 
422
- src/dataunit/DataUnit.ts:34
291
+ ### allowReleaseCallbacks
423
292
 
424
- ___
293
+ > `set` **allowReleaseCallbacks**(`allow`): `void`
425
294
 
426
- ### DEFAULT\_DATAUNIT\_NAME
295
+ #### Parameters
427
296
 
428
- ▪ `Static` **DEFAULT\_DATAUNIT\_NAME**: `string` = `"dataunit"`
297
+ • **allow**: `boolean`
429
298
 
430
- #### Defined in
299
+ #### Source
431
300
 
432
- src/dataunit/DataUnit.ts:35
301
+ src/dataunit/DataUnit.ts:1776
433
302
 
434
- ## Accessors
303
+ ***
435
304
 
436
305
  ### dataUnitId
437
306
 
438
- • `get` **dataUnitId**(): `string`
307
+ > `get` **dataUnitId**(): `string`
439
308
 
440
309
  #### Returns
441
310
 
442
311
  `string`
443
312
 
444
- #### Defined in
313
+ #### Source
445
314
 
446
- src/dataunit/DataUnit.ts:118
315
+ src/dataunit/DataUnit.ts:145
447
316
 
448
- ___
317
+ ***
449
318
 
450
319
  ### defaultSorting
451
320
 
452
- • `set` **defaultSorting**(`sorting`): `void`
321
+ > `set` **defaultSorting**(`sorting`): `void`
453
322
 
454
323
  Define a ordenação padrão.
455
324
 
456
325
  #### Parameters
457
326
 
458
- | Name | Type | Description |
459
- | :------ | :------ | :------ |
460
- | `sorting` | [`Sort`](../interfaces/Sort.md)[] | Ordenação padrão. |
461
-
462
- #### Returns
327
+ • **sorting**: [`Sort`](../interfaces/Sort.md)[]
463
328
 
464
- `void`
329
+ Ordenação padrão.
465
330
 
466
- #### Defined in
331
+ #### Source
467
332
 
468
- src/dataunit/DataUnit.ts:712
333
+ src/dataunit/DataUnit.ts:751
469
334
 
470
- ___
335
+ ***
471
336
 
472
337
  ### metadata
473
338
 
474
- • `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
339
+ > `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
475
340
 
476
341
  Obtém os metadados do DataUnit.
477
342
 
478
- #### Returns
479
-
480
- [`UnitMetadata`](../interfaces/UnitMetadata.md)
481
-
482
- #### Defined in
483
-
484
- src/dataunit/DataUnit.ts:730
485
-
486
- • `set` **metadata**(`md`): `void`
343
+ > `set` **metadata**(`md`): `void`
487
344
 
488
345
  Define a propriedade metadata da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
489
346
 
490
347
  #### Parameters
491
348
 
492
- | Name | Type |
493
- | :------ | :------ |
494
- | `md` | [`UnitMetadata`](../interfaces/UnitMetadata.md) |
349
+ • **md**: [`UnitMetadata`](../interfaces/UnitMetadata.md)
495
350
 
496
351
  #### Returns
497
352
 
498
- `void`
353
+ [`UnitMetadata`](../interfaces/UnitMetadata.md)
499
354
 
500
- #### Defined in
355
+ #### Source
501
356
 
502
- src/dataunit/DataUnit.ts:721
357
+ src/dataunit/DataUnit.ts:769
503
358
 
504
- ___
359
+ ***
505
360
 
506
361
  ### name
507
362
 
508
- • `get` **name**(): `string`
363
+ > `get` **name**(): `string`
509
364
 
510
365
  Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uniform Resource Identifier).
511
366
 
@@ -515,153 +370,181 @@ Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uni
515
370
 
516
371
  - Nome de identificação do DataUnit.
517
372
 
518
- #### Defined in
373
+ #### Source
519
374
 
520
- src/dataunit/DataUnit.ts:129
375
+ src/dataunit/DataUnit.ts:156
521
376
 
522
- ___
377
+ ***
523
378
 
524
379
  ### pageSize
525
380
 
526
- • `get` **pageSize**(): `number`
381
+ > `get` **pageSize**(): `number`
527
382
 
528
383
  Obtém a quantidade de registros que está sendo exibido por página.
529
384
 
385
+ > `set` **pageSize**(`size`): `void`
386
+
387
+ Define a quantidade de registros que será exibido por página.
388
+
389
+ #### Parameters
390
+
391
+ • **size**: `number`
392
+
393
+ Quantidade de registros que será exibido por página.
394
+
530
395
  #### Returns
531
396
 
532
397
  `number`
533
398
 
534
399
  - Quantidade de registros exibidos por página.
535
400
 
536
- #### Defined in
401
+ #### Source
537
402
 
538
- src/dataunit/DataUnit.ts:791
403
+ src/dataunit/DataUnit.ts:830
539
404
 
540
- • `set` **pageSize**(`size`): `void`
405
+ ***
541
406
 
542
- Define a quantidade de registros que será exibido por página.
407
+ ### records
408
+
409
+ > `get` **records**(): [`Record`](../interfaces/Record.md)[]
410
+
411
+ Obtém todos os registros atuais.
412
+
413
+ > `set` **records**(`records`): `void`
414
+
415
+ Define a propriedade records da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
543
416
 
544
417
  #### Parameters
545
418
 
546
- | Name | Type | Description |
547
- | :------ | :------ | :------ |
548
- | `size` | `number` | Quantidade de registros que será exibido por página. |
419
+ • **records**: [`Record`](../interfaces/Record.md)[]
549
420
 
550
421
  #### Returns
551
422
 
552
- `void`
423
+ [`Record`](../interfaces/Record.md)[]
553
424
 
554
- #### Defined in
425
+ - Todos os registros atuais.
555
426
 
556
- src/dataunit/DataUnit.ts:780
427
+ #### Source
557
428
 
558
- ___
429
+ src/dataunit/DataUnit.ts:807
559
430
 
560
- ### records
431
+ ***
561
432
 
562
- • `get` **records**(): [`Record`](../interfaces/Record.md)[]
433
+ ### sortingProvider
563
434
 
564
- Obtém todos os registros atuais.
435
+ > `set` **sortingProvider**(`provider`): `void`
565
436
 
566
- #### Returns
437
+ Define a lógica de ordenação dos registros.
567
438
 
568
- [`Record`](../interfaces/Record.md)[]
439
+ #### Parameters
569
440
 
570
- - Todos os registros atuais.
441
+ • **provider**: [`SortingProvider`](../interfaces/SortingProvider.md)
571
442
 
572
- #### Defined in
443
+ Objeto usado para definir a propriedade sortingProvider da instância da classe.
573
444
 
574
- src/dataunit/DataUnit.ts:768
445
+ #### Source
575
446
 
576
- • `set` **records**(`records`): `void`
447
+ src/dataunit/DataUnit.ts:740
577
448
 
578
- Define a propriedade records da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
449
+ ## Methods
450
+
451
+ ### addField()
452
+
453
+ > **addField**(`field`): `void`
454
+
455
+ Adiciona um campo stand-alone ao dataUnit.
579
456
 
580
457
  #### Parameters
581
458
 
582
- | Name | Type |
583
- | :------ | :------ |
584
- | `records` | [`Record`](../interfaces/Record.md)[] |
459
+ • **field**: `Omit`\<[`FieldDescriptor`](../interfaces/FieldDescriptor.md), `"standAlone"`\>
460
+
461
+ Campo a ser adicionado.
585
462
 
586
463
  #### Returns
587
464
 
588
465
  `void`
589
466
 
590
- #### Defined in
467
+ #### Source
591
468
 
592
- src/dataunit/DataUnit.ts:757
469
+ src/dataunit/DataUnit.ts:1757
593
470
 
594
- ___
471
+ ***
595
472
 
596
- ### sortingProvider
473
+ ### addFilterProvider()
597
474
 
598
- • `set` **sortingProvider**(`provider`): `void`
475
+ > **addFilterProvider**(`provider`): `void`
599
476
 
600
- Define a lógica de ordenação dos registros.
477
+ Adiciona um FilterProvider.
601
478
 
602
479
  #### Parameters
603
480
 
604
- | Name | Type | Description |
605
- | :------ | :------ | :------ |
606
- | `provider` | [`SortingProvider`](../interfaces/SortingProvider.md) | Objeto usado para definir a propriedade sortingProvider da instância da classe. |
481
+ • **provider**: `FilterProvider`
482
+
483
+ FilterProvider que será adicionado.
607
484
 
608
485
  #### Returns
609
486
 
610
487
  `void`
611
488
 
612
- #### Defined in
489
+ #### Source
613
490
 
614
- src/dataunit/DataUnit.ts:701
491
+ src/dataunit/DataUnit.ts:698
615
492
 
616
- ## Methods
493
+ ***
617
494
 
618
- ### addFilterProvider
495
+ ### addGlobalLoaderProp()
619
496
 
620
- ▸ **addFilterProvider**(`provider`): `void`
497
+ > **addGlobalLoaderProp**(`name`, `value`): `void`
621
498
 
622
- Adiciona um FilterProvider.
499
+ Adiciona uma propriedade transacional que será envida aos
500
+ loaders (dataLoader, saveLoader, removeLoader e recordLoader) na chamada.
501
+ Essas propriedades serão limpas ao final da execução de cada método.
623
502
 
624
503
  #### Parameters
625
504
 
626
- | Name | Type | Description |
627
- | :------ | :------ | :------ |
628
- | `provider` | `FilterProvider` | FilterProvider que será adicionado. |
505
+ • **name**: `string`
506
+
507
+ Nome da propriedade
508
+
509
+ • **value**: `string`
510
+
511
+ Valor da propriedade
629
512
 
630
513
  #### Returns
631
514
 
632
515
  `void`
633
516
 
634
- #### Defined in
517
+ #### Source
635
518
 
636
- src/dataunit/DataUnit.ts:659
519
+ src/dataunit/DataUnit.ts:132
637
520
 
638
- ___
521
+ ***
639
522
 
640
- ### addInterceptor
523
+ ### addInterceptor()
641
524
 
642
- ▸ **addInterceptor**(`interceptor`): `void`
525
+ > **addInterceptor**(`interceptor`): `void`
643
526
 
644
527
  Adiciona um interceptor correspondente a uma ação do DataUnit para fazer um processamento customizado.
645
528
 
646
529
  #### Parameters
647
530
 
648
- | Name | Type | Description |
649
- | :------ | :------ | :------ |
650
- | `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) | Interceptor a ser adicionado. |
531
+ • **interceptor**: [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)
532
+
533
+ Interceptor a ser adicionado.
651
534
 
652
535
  #### Returns
653
536
 
654
537
  `void`
655
538
 
656
- #### Defined in
539
+ #### Source
657
540
 
658
- src/dataunit/DataUnit.ts:637
541
+ src/dataunit/DataUnit.ts:676
659
542
 
660
- ___
543
+ ***
661
544
 
662
- ### addLoadingLocker
545
+ ### addLoadingLocker()
663
546
 
664
- ▸ **addLoadingLocker**(): `Function`
547
+ > **addLoadingLocker**(): `Function`
665
548
 
666
549
  Adiciona um locker para impedir o carregamento dos registros do dataUnit.
667
550
 
@@ -671,59 +554,57 @@ Adiciona um locker para impedir o carregamento dos registros do dataUnit.
671
554
 
672
555
  Retorna uma função responsável por liberar o lock adicionado.
673
556
 
674
- #### Defined in
557
+ #### Source
675
558
 
676
- src/dataunit/DataUnit.ts:1714
559
+ src/dataunit/DataUnit.ts:1766
677
560
 
678
- ___
561
+ ***
679
562
 
680
- ### addRecord
563
+ ### addRecord()
681
564
 
682
- ▸ **addRecord**(`executionCtx?`): `Promise`<`boolean`\>
565
+ > **addRecord**(`executionCtx`?): `Promise`\<`boolean`\>
683
566
 
684
567
  Adiciona um novo registro.
685
568
 
686
569
  #### Parameters
687
570
 
688
- | Name | Type | Description |
689
- | :------ | :------ | :------ |
690
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da inserção do dado no DataUnit. |
571
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
572
+
573
+ Contexto de execução da inserção do dado no DataUnit.
691
574
 
692
575
  #### Returns
693
576
 
694
- `Promise`<`boolean`\>
577
+ `Promise`\<`boolean`\>
695
578
 
696
- #### Defined in
579
+ #### Source
697
580
 
698
- src/dataunit/DataUnit.ts:837
581
+ src/dataunit/DataUnit.ts:876
699
582
 
700
- ___
583
+ ***
701
584
 
702
- ### addStandAloneField
585
+ ### ~~addStandAloneField()~~
703
586
 
704
- ▸ **addStandAloneField**(`field`): `void`
587
+ > **addStandAloneField**(): `void`
705
588
 
706
589
  Adiciona um campo stand-alone ao dataUnit.
707
590
 
708
- #### Parameters
709
-
710
- | Name | Type | Description |
711
- | :------ | :------ | :------ |
712
- | `field` | `Omit`<[`FieldDescriptor`](../interfaces/FieldDescriptor.md), ``"standAlone"``\> | Campo a ser adicionado. |
713
-
714
591
  #### Returns
715
592
 
716
593
  `void`
717
594
 
718
- #### Defined in
595
+ #### Deprecated
596
+
597
+ - metodo depreciado, utilizar o metodo addField
719
598
 
720
- src/dataunit/DataUnit.ts:1705
599
+ #### Source
721
600
 
722
- ___
601
+ src/dataunit/DataUnit.ts:1748
723
602
 
724
- ### buildChangesToSave
603
+ ***
725
604
 
726
- ▸ **buildChangesToSave**(): [`Change`](Change.md)[]
605
+ ### buildChangesToSave()
606
+
607
+ > **buildChangesToSave**(): [`Change`](Change.md)[]
727
608
 
728
609
  Retorna as alterações a serem salvas no DataUnit atual.
729
610
 
@@ -733,36 +614,35 @@ Retorna as alterações a serem salvas no DataUnit atual.
733
614
 
734
615
  - Mudanças realizadas no DataUnit atual
735
616
 
736
- #### Defined in
617
+ #### Source
737
618
 
738
- src/dataunit/DataUnit.ts:471
619
+ src/dataunit/DataUnit.ts:508
739
620
 
740
- ___
621
+ ***
741
622
 
742
- ### buildChangesToSaveFromChild
623
+ ### buildChangesToSaveFromChild()
743
624
 
744
- ▸ **buildChangesToSaveFromChild**(`allChanges`, `dataUnit`): `void`
625
+ > **buildChangesToSaveFromChild**(`allChanges`, `dataUnit`): `void`
745
626
 
746
627
  #### Parameters
747
628
 
748
- | Name | Type |
749
- | :------ | :------ |
750
- | `allChanges` | [`Change`](Change.md)[] |
751
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
629
+ • **allChanges**: [`Change`](Change.md)[]
630
+
631
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
752
632
 
753
633
  #### Returns
754
634
 
755
635
  `void`
756
636
 
757
- #### Defined in
637
+ #### Source
758
638
 
759
- src/dataunit/DataUnit.ts:475
639
+ src/dataunit/DataUnit.ts:512
760
640
 
761
- ___
641
+ ***
762
642
 
763
- ### canRedo
643
+ ### canRedo()
764
644
 
765
- ▸ **canRedo**(): `boolean`
645
+ > **canRedo**(): `boolean`
766
646
 
767
647
  Retorna se a informação do estado futuro está salva, permitindo refazer a ação.
768
648
 
@@ -772,15 +652,15 @@ Retorna se a informação do estado futuro está salva, permitindo refazer a aç
772
652
 
773
653
  Verdadeiro se for possível refazer a ação.
774
654
 
775
- #### Defined in
655
+ #### Source
776
656
 
777
- src/dataunit/DataUnit.ts:1357
657
+ src/dataunit/DataUnit.ts:1396
778
658
 
779
- ___
659
+ ***
780
660
 
781
- ### canUndo
661
+ ### canUndo()
782
662
 
783
- ▸ **canUndo**(): `boolean`
663
+ > **canUndo**(): `boolean`
784
664
 
785
665
  Retorna se a informação do estado anterior está salva, permitindo desfazer a ação.
786
666
 
@@ -790,61 +670,63 @@ Retorna se a informação do estado anterior está salva, permitindo desfazer a
790
670
 
791
671
  Verdadeiro se for possível desfazer a ação.
792
672
 
793
- #### Defined in
673
+ #### Source
794
674
 
795
- src/dataunit/DataUnit.ts:1346
675
+ src/dataunit/DataUnit.ts:1385
796
676
 
797
- ___
677
+ ***
798
678
 
799
- ### cancelEdition
679
+ ### cancelEdition()
800
680
 
801
- ▸ **cancelEdition**(`executionCtx?`, `fromParent?`, `silent?`): `Promise`<`boolean`\>
681
+ > **cancelEdition**(`executionCtx`?, `fromParent`?, `silent`?): `Promise`\<`boolean`\>
802
682
 
803
683
  Cancela edição do registro atual.
804
684
 
805
685
  #### Parameters
806
686
 
807
- | Name | Type | Default value | Description |
808
- | :------ | :------ | :------ | :------ |
809
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` | Contexto de execução do cancelamento da seleção dos registros. |
810
- | `fromParent?` | `boolean` | `undefined` | - |
811
- | `silent` | `boolean` | `false` | - |
687
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
688
+
689
+ Contexto de execução do cancelamento da seleção dos registros.
690
+
691
+ • **fromParent?**: `boolean`
692
+
693
+ • **silent?**: `boolean`= `false`
812
694
 
813
695
  #### Returns
814
696
 
815
- `Promise`<`boolean`\>
697
+ `Promise`\<`boolean`\>
816
698
 
817
- #### Defined in
699
+ #### Source
818
700
 
819
- src/dataunit/DataUnit.ts:1213
701
+ src/dataunit/DataUnit.ts:1252
820
702
 
821
- ___
703
+ ***
822
704
 
823
- ### cancelWaitingChange
705
+ ### cancelWaitingChange()
824
706
 
825
- ▸ **cancelWaitingChange**(`fieldName`): `void`
707
+ > **cancelWaitingChange**(`fieldName`): `void`
826
708
 
827
709
  Cancela o início de uma alteração no campo.
828
710
 
829
711
  #### Parameters
830
712
 
831
- | Name | Type | Description |
832
- | :------ | :------ | :------ |
833
- | `fieldName` | `string` | Identificador do campo. |
713
+ • **fieldName**: `string`
714
+
715
+ Identificador do campo.
834
716
 
835
717
  #### Returns
836
718
 
837
719
  `void`
838
720
 
839
- #### Defined in
721
+ #### Source
840
722
 
841
- src/dataunit/DataUnit.ts:1004
723
+ src/dataunit/DataUnit.ts:1043
842
724
 
843
- ___
725
+ ***
844
726
 
845
- ### childrenIsDirty
727
+ ### childrenIsDirty()
846
728
 
847
- ▸ `Private` **childrenIsDirty**(): `boolean`
729
+ > `private` **childrenIsDirty**(): `boolean`
848
730
 
849
731
  Retorna se existe algum DataUnit detail com alterações pendentes.
850
732
 
@@ -854,15 +736,15 @@ Retorna se existe algum DataUnit detail com alterações pendentes.
854
736
 
855
737
  Verdadeiro se existir alterações pendentes em algum DataUnit detail.
856
738
 
857
- #### Defined in
739
+ #### Source
858
740
 
859
- src/dataunit/DataUnit.ts:1242
741
+ src/dataunit/DataUnit.ts:1281
860
742
 
861
- ___
743
+ ***
862
744
 
863
- ### clearDataUnit
745
+ ### clearDataUnit()
864
746
 
865
- ▸ **clearDataUnit**(): `void`
747
+ > **clearDataUnit**(): `void`
866
748
 
867
749
  Limpa todos os registros do DataUnit
868
750
 
@@ -870,201 +752,221 @@ Limpa todos os registros do DataUnit
870
752
 
871
753
  `void`
872
754
 
873
- #### Defined in
755
+ #### Source
874
756
 
875
- src/dataunit/DataUnit.ts:1146
757
+ src/dataunit/DataUnit.ts:1185
876
758
 
877
- ___
759
+ ***
878
760
 
879
- ### clearInvalid
761
+ ### clearInvalid()
880
762
 
881
- ▸ **clearInvalid**(`recordId`, `fieldName?`): `void`
763
+ > **clearInvalid**(`recordId`, `fieldName`?): `void`
882
764
 
883
765
  Limpa campos inválidos.
884
766
 
885
767
  #### Parameters
886
768
 
887
- | Name | Type | Description |
888
- | :------ | :------ | :------ |
889
- | `recordId` | `string` | Indica em qual registro o campo não está mais inválido. |
890
- | `fieldName?` | `string` | Nome do campo. Caso omitido, todos os campos serão limpos. |
769
+ • **recordId**: `string`
770
+
771
+ Indica em qual registro o campo não está mais inválido.
772
+
773
+ • **fieldName?**: `string`
774
+
775
+ Nome do campo. Caso omitido, todos os campos serão limpos.
891
776
 
892
777
  #### Returns
893
778
 
894
779
  `void`
895
780
 
896
- #### Defined in
781
+ #### Source
897
782
 
898
- src/dataunit/DataUnit.ts:969
783
+ src/dataunit/DataUnit.ts:1008
899
784
 
900
- ___
785
+ ***
901
786
 
902
- ### clearSelection
787
+ ### clearSelection()
903
788
 
904
- ▸ **clearSelection**(`executionCtx?`): `void`
789
+ > **clearSelection**(`executionCtx`?): `void`
905
790
 
906
791
  Limpa a seleção.
907
792
 
908
793
  #### Parameters
909
794
 
910
- | Name | Type | Description |
911
- | :------ | :------ | :------ |
912
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
795
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
796
+
797
+ Contexto de execução da seleção dos registros do DataUnit.
913
798
 
914
799
  #### Returns
915
800
 
916
801
  `void`
917
802
 
918
- #### Defined in
803
+ #### Source
919
804
 
920
- src/dataunit/DataUnit.ts:1079
805
+ src/dataunit/DataUnit.ts:1118
921
806
 
922
- ___
807
+ ***
923
808
 
924
- ### copySelected
809
+ ### copySelected()
925
810
 
926
- ▸ **copySelected**(`executionCtx?`): `void`
811
+ > **copySelected**(`executionCtx`?): `void`
927
812
 
928
813
  Efetua a cópia do registro selecionado.
929
814
 
930
815
  #### Parameters
931
816
 
932
- | Name | Type | Description |
933
- | :------ | :------ | :------ |
934
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da cópia do dado do DataUnit. |
817
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
818
+
819
+ Contexto de execução da cópia do dado do DataUnit.
935
820
 
936
821
  #### Returns
937
822
 
938
823
  `void`
939
824
 
940
- #### Defined in
825
+ #### Source
941
826
 
942
- src/dataunit/DataUnit.ts:848
827
+ src/dataunit/DataUnit.ts:887
943
828
 
944
- ___
829
+ ***
945
830
 
946
- ### disableField
831
+ ### disableField()
947
832
 
948
- ▸ **disableField**(`fieldName`): `void`
833
+ > **disableField**(`fieldName`): `void`
949
834
 
950
835
  Desabilita um campo do DataUnit
951
836
 
952
837
  #### Parameters
953
838
 
954
- | Name | Type | Description |
955
- | :------ | :------ | :------ |
956
- | `fieldName` | `string` | nome do campo para ficar desabilitado. |
839
+ • **fieldName**: `string`
840
+
841
+ nome do campo para ficar desabilitado.
957
842
 
958
843
  #### Returns
959
844
 
960
845
  `void`
961
846
 
962
- #### Defined in
847
+ #### Source
963
848
 
964
- src/dataunit/DataUnit.ts:1615
849
+ src/dataunit/DataUnit.ts:1658
965
850
 
966
- ___
851
+ ***
967
852
 
968
- ### dispatchAction
853
+ ### dispatchAction()
969
854
 
970
- ▸ `Private` **dispatchAction**(`actionType`, `payload?`, `executionCtx?`): `Promise`<`boolean`\>
855
+ > `private` **dispatchAction**(`actionType`, `payload`?, `executionCtx`?, `options`?): `Promise`\<`boolean`\>
971
856
 
972
857
  Lança ação do DataUnit para que sejam processadas.
973
858
 
974
859
  #### Parameters
975
860
 
976
- | Name | Type | Description |
977
- | :------ | :------ | :------ |
978
- | `actionType` | [`Action`](../enums/Action.md) | Tipo de ação que será executada. |
979
- | `payload?` | `any` | Dados que serão processados na ação. |
980
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de lançar a ação que será executada. |
861
+ • **actionType**: [`Action`](../enumerations/Action.md)
862
+
863
+ Tipo de ação que será executada.
864
+
865
+ • **payload?**: `any`
866
+
867
+ Dados que serão processados na ação.
868
+
869
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
870
+
871
+ Contexto de execução de lançar a ação que será executada.
872
+
873
+ • **options?**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)
981
874
 
982
875
  #### Returns
983
876
 
984
- `Promise`<`boolean`\>
877
+ `Promise`\<`boolean`\>
985
878
 
986
879
  - Verdadeiro se ação iniciada.
987
880
 
988
- #### Defined in
881
+ #### Source
989
882
 
990
- src/dataunit/DataUnit.ts:1407
883
+ src/dataunit/DataUnit.ts:1446
991
884
 
992
- ___
885
+ ***
993
886
 
994
- ### doDispatchAction
887
+ ### doDispatchAction()
995
888
 
996
- ▸ `Private` **doDispatchAction**(`action`): `void`
889
+ > `private` **doDispatchAction**(`action`, `options`): `void`
997
890
 
998
891
  Processa as ações no DataUnit e notifica os observers.
999
892
 
1000
893
  #### Parameters
1001
894
 
1002
- | Name | Type | Description |
1003
- | :------ | :------ | :------ |
1004
- | `action` | [`DataUnitAction`](DataUnitAction.md) | Ações em execução no DataUnit. |
895
+ • **action**: [`DataUnitAction`](DataUnitAction.md)
896
+
897
+ Ações em execução no DataUnit.
898
+
899
+ • **options**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)= `{}`
1005
900
 
1006
901
  #### Returns
1007
902
 
1008
903
  `void`
1009
904
 
1010
- #### Defined in
905
+ #### Source
1011
906
 
1012
- src/dataunit/DataUnit.ts:1455
907
+ src/dataunit/DataUnit.ts:1494
1013
908
 
1014
- ___
909
+ ***
1015
910
 
1016
- ### enableField
911
+ ### enableField()
1017
912
 
1018
- ▸ **enableField**(`fieldName`): `void`
913
+ > **enableField**(`fieldName`): `void`
1019
914
 
1020
915
  Habilita um campo do DataUnit
1021
916
 
1022
917
  #### Parameters
1023
918
 
1024
- | Name | Type | Description |
1025
- | :------ | :------ | :------ |
1026
- | `fieldName` | `string` | nome do campo para ser habilitado. |
919
+ • **fieldName**: `string`
920
+
921
+ nome do campo para ser habilitado.
1027
922
 
1028
923
  #### Returns
1029
924
 
1030
925
  `void`
1031
926
 
1032
- #### Defined in
927
+ #### Source
1033
928
 
1034
- src/dataunit/DataUnit.ts:1600
929
+ src/dataunit/DataUnit.ts:1643
1035
930
 
1036
- ___
931
+ ***
1037
932
 
1038
- ### executeLoadData
933
+ ### executeLoadData()
1039
934
 
1040
- ▸ `Private` **executeLoadData**(`request`, `executionCtx?`, `checkLastFilter?`, `selectFirstRecord?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
935
+ > `private` **executeLoadData**(`request`, `executionCtx`?, `checkLastFilter`?, `selectFirstRecord`?): `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1041
936
 
1042
937
  Executa o carregamento dos registros.
1043
938
 
1044
939
  #### Parameters
1045
940
 
1046
- | Name | Type | Description |
1047
- | :------ | :------ | :------ |
1048
- | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) | Dados da requisição para carregamento dos registros. |
1049
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
1050
- | `checkLastFilter?` | `boolean` | Habilita a verificação da última requisição, evitando carga desnecessária. |
1051
- | `selectFirstRecord?` | `boolean` | - |
941
+ • **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
942
+
943
+ Dados da requisição para carregamento dos registros.
944
+
945
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
946
+
947
+ Contexto de execução do carregamento dos registros do DataUnit.
948
+
949
+ • **checkLastFilter?**: `boolean`
950
+
951
+ Habilita a verificação da última requisição, evitando carga desnecessária.
952
+
953
+ • **selectFirstRecord?**: `boolean`
1052
954
 
1053
955
  #### Returns
1054
956
 
1055
- `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
957
+ `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1056
958
 
1057
959
  - Registros do DataUnit.
1058
960
 
1059
- #### Defined in
961
+ #### Source
1060
962
 
1061
- src/dataunit/DataUnit.ts:196
963
+ src/dataunit/DataUnit.ts:225
1062
964
 
1063
- ___
965
+ ***
1064
966
 
1065
- ### getAddedRecords
967
+ ### getAddedRecords()
1066
968
 
1067
- ▸ **getAddedRecords**(): [`Record`](../interfaces/Record.md)[]
969
+ > **getAddedRecords**(): [`Record`](../interfaces/Record.md)[]
1068
970
 
1069
971
  Obtém os registros adicionados no DataUnit.
1070
972
 
@@ -1074,15 +976,15 @@ Obtém os registros adicionados no DataUnit.
1074
976
 
1075
977
  - Lista dos registros adicionados.
1076
978
 
1077
- #### Defined in
979
+ #### Source
1078
980
 
1079
- src/dataunit/DataUnit.ts:814
981
+ src/dataunit/DataUnit.ts:853
1080
982
 
1081
- ___
983
+ ***
1082
984
 
1083
- ### getAllChangesToSave
985
+ ### getAllChangesToSave()
1084
986
 
1085
- ▸ **getAllChangesToSave**(): [`Change`](Change.md)[]
987
+ > **getAllChangesToSave**(): [`Change`](Change.md)[]
1086
988
 
1087
989
  Retorna todas as alterações do DataUnit a serem salvas, incluindo no nível Master e Detail.
1088
990
 
@@ -1092,15 +994,15 @@ Retorna todas as alterações do DataUnit a serem salvas, incluindo no nível Ma
1092
994
 
1093
995
  - Todas as mudanças realizadas no DataUnit, tanto Master quanto Detail;
1094
996
 
1095
- #### Defined in
997
+ #### Source
1096
998
 
1097
- src/dataunit/DataUnit.ts:493
999
+ src/dataunit/DataUnit.ts:530
1098
1000
 
1099
- ___
1001
+ ***
1100
1002
 
1101
- ### getAppliedFilters
1003
+ ### getAppliedFilters()
1102
1004
 
1103
- ▸ **getAppliedFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
1005
+ > **getAppliedFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
1104
1006
 
1105
1007
  Obtém os filtros aplicados.
1106
1008
 
@@ -1110,59 +1012,59 @@ Obtém os filtros aplicados.
1110
1012
 
1111
1013
  - Lista de filtros.
1112
1014
 
1113
- #### Defined in
1015
+ #### Source
1114
1016
 
1115
- src/dataunit/DataUnit.ts:1589
1017
+ src/dataunit/DataUnit.ts:1632
1116
1018
 
1117
- ___
1019
+ ***
1118
1020
 
1119
- ### getBeforeSavePromisses
1021
+ ### getBeforeSavePromisses()
1120
1022
 
1121
- ▸ `Private` **getBeforeSavePromisses**(): (`undefined` \| `Promise`<`any`\>)[]
1023
+ > `private` **getBeforeSavePromisses**(): (`undefined` \| `Promise`\<`any`\>)[]
1122
1024
 
1123
1025
  #### Returns
1124
1026
 
1125
- (`undefined` \| `Promise`<`any`\>)[]
1027
+ (`undefined` \| `Promise`\<`any`\>)[]
1126
1028
 
1127
- #### Defined in
1029
+ #### Source
1128
1030
 
1129
- src/dataunit/DataUnit.ts:401
1031
+ src/dataunit/DataUnit.ts:435
1130
1032
 
1131
- ___
1033
+ ***
1132
1034
 
1133
- ### getChildDataunit
1035
+ ### getChildDataunit()
1134
1036
 
1135
- ▸ **getChildDataunit**(`name`): [`DataUnit`](DataUnit.md)
1037
+ > **getChildDataunit**(`name`): [`DataUnit`](DataUnit.md)
1136
1038
 
1137
1039
  Cria um dataunit filho.
1138
1040
 
1139
1041
  #### Parameters
1140
1042
 
1141
- | Name | Type | Description |
1142
- | :------ | :------ | :------ |
1143
- | `name` | `string` | Nome do dataunit filho. |
1043
+ • **name**: `string`
1044
+
1045
+ Nome do dataunit filho.
1144
1046
 
1145
1047
  #### Returns
1146
1048
 
1147
1049
  [`DataUnit`](DataUnit.md)
1148
1050
 
1149
- #### Defined in
1051
+ #### Source
1150
1052
 
1151
- src/dataunit/DataUnit.ts:1478
1053
+ src/dataunit/DataUnit.ts:1517
1152
1054
 
1153
- ___
1055
+ ***
1154
1056
 
1155
- ### getChildInfo
1057
+ ### getChildInfo()
1156
1058
 
1157
- ▸ **getChildInfo**(`name`): `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
1059
+ > **getChildInfo**(`name`): `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
1158
1060
 
1159
1061
  Obtém informações da ligação para um DataUnit filho.
1160
1062
 
1161
1063
  #### Parameters
1162
1064
 
1163
- | Name | Type | Description |
1164
- | :------ | :------ | :------ |
1165
- | `name` | `string` | Nome do DataUnit que se deseja. |
1065
+ • **name**: `string`
1066
+
1067
+ Nome do DataUnit que se deseja.
1166
1068
 
1167
1069
  #### Returns
1168
1070
 
@@ -1170,23 +1072,23 @@ Obtém informações da ligação para um DataUnit filho.
1170
1072
 
1171
1073
  - As informações sobre a ligação solicitada. Pode retornar undefined.
1172
1074
 
1173
- #### Defined in
1075
+ #### Source
1174
1076
 
1175
- src/dataunit/DataUnit.ts:743
1077
+ src/dataunit/DataUnit.ts:782
1176
1078
 
1177
- ___
1079
+ ***
1178
1080
 
1179
- ### getField
1081
+ ### getField()
1180
1082
 
1181
- ▸ **getField**(`fieldName`): `undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
1083
+ > **getField**(`fieldName`): `undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
1182
1084
 
1183
1085
  Obtém metadados de um campo específico.
1184
1086
 
1185
1087
  #### Parameters
1186
1088
 
1187
- | Name | Type | Description |
1188
- | :------ | :------ | :------ |
1189
- | `fieldName` | `string` | Identificador do campo. |
1089
+ • **fieldName**: `string`
1090
+
1091
+ Identificador do campo.
1190
1092
 
1191
1093
  #### Returns
1192
1094
 
@@ -1194,23 +1096,23 @@ Obtém metadados de um campo específico.
1194
1096
 
1195
1097
  - Metadados do campo informado.
1196
1098
 
1197
- #### Defined in
1099
+ #### Source
1198
1100
 
1199
- src/dataunit/DataUnit.ts:826
1101
+ src/dataunit/DataUnit.ts:865
1200
1102
 
1201
- ___
1103
+ ***
1202
1104
 
1203
- ### getFieldValue
1105
+ ### getFieldValue()
1204
1106
 
1205
- ▸ **getFieldValue**(`fieldName`): `any`
1107
+ > **getFieldValue**(`fieldName`): `any`
1206
1108
 
1207
1109
  Obtém valor do campo desejado.
1208
1110
 
1209
1111
  #### Parameters
1210
1112
 
1211
- | Name | Type | Description |
1212
- | :------ | :------ | :------ |
1213
- | `fieldName` | `string` | Identificador do campo a ser buscado. |
1113
+ • **fieldName**: `string`
1114
+
1115
+ Identificador do campo a ser buscado.
1214
1116
 
1215
1117
  #### Returns
1216
1118
 
@@ -1218,23 +1120,23 @@ Obtém valor do campo desejado.
1218
1120
 
1219
1121
  - Valor do campo.
1220
1122
 
1221
- #### Defined in
1123
+ #### Source
1222
1124
 
1223
- src/dataunit/DataUnit.ts:907
1125
+ src/dataunit/DataUnit.ts:946
1224
1126
 
1225
- ___
1127
+ ***
1226
1128
 
1227
- ### getFielterProviderKey
1129
+ ### getFielterProviderKey()
1228
1130
 
1229
- ▸ `Private` **getFielterProviderKey**(`provider`): `string`
1131
+ > `private` **getFielterProviderKey**(`provider`): `string`
1230
1132
 
1231
1133
  Obtém chave única para identificação do FilterProvider.
1232
1134
 
1233
1135
  #### Parameters
1234
1136
 
1235
- | Name | Type | Description |
1236
- | :------ | :------ | :------ |
1237
- | `provider` | `FilterProvider` | Interface FilterProvider na qual será retornada uma chave correspondente. |
1137
+ • **provider**: `FilterProvider`
1138
+
1139
+ Interface FilterProvider na qual será retornada uma chave correspondente.
1238
1140
 
1239
1141
  #### Returns
1240
1142
 
@@ -1242,15 +1144,15 @@ Obtém chave única para identificação do FilterProvider.
1242
1144
 
1243
1145
  - A chave do provider.
1244
1146
 
1245
- #### Defined in
1147
+ #### Source
1246
1148
 
1247
- src/dataunit/DataUnit.ts:178
1149
+ src/dataunit/DataUnit.ts:207
1248
1150
 
1249
- ___
1151
+ ***
1250
1152
 
1251
- ### getFilters
1153
+ ### getFilters()
1252
1154
 
1253
- ▸ **getFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
1155
+ > **getFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
1254
1156
 
1255
1157
  Obtém todos os filtros de dados.
1256
1158
 
@@ -1260,15 +1162,15 @@ Obtém todos os filtros de dados.
1260
1162
 
1261
1163
  - Lista de filtros.
1262
1164
 
1263
- #### Defined in
1165
+ #### Source
1264
1166
 
1265
- src/dataunit/DataUnit.ts:1560
1167
+ src/dataunit/DataUnit.ts:1603
1266
1168
 
1267
- ___
1169
+ ***
1268
1170
 
1269
- ### getFormattedValue
1171
+ ### getFormattedValue()
1270
1172
 
1271
- ▸ **getFormattedValue**(`fieldName`, `value?`): `string`
1173
+ > **getFormattedValue**(`fieldName`, `value`?): `string`
1272
1174
 
1273
1175
  Formata o valor do campo considerando as informações do descriptor.
1274
1176
  Diferente do método "valueToString" que retorna o dado em valor textual,
@@ -1277,10 +1179,13 @@ usada na interface.
1277
1179
 
1278
1180
  #### Parameters
1279
1181
 
1280
- | Name | Type | Description |
1281
- | :------ | :------ | :------ |
1282
- | `fieldName` | `string` | Nome do campo utilizado do qual se quer obter valor. |
1283
- | `value?` | `any` | (opcional) - O valor a ser convertido. Caso omitido pega do registro selecionado. |
1182
+ • **fieldName**: `string`
1183
+
1184
+ Nome do campo utilizado do qual se quer obter valor.
1185
+
1186
+ • **value?**: `any`
1187
+
1188
+ (opcional) - O valor a ser convertido. Caso omitido pega do registro selecionado.
1284
1189
 
1285
1190
  #### Returns
1286
1191
 
@@ -1288,38 +1193,59 @@ usada na interface.
1288
1193
 
1289
1194
  - Valor formatado.
1290
1195
 
1291
- #### Defined in
1196
+ #### Source
1197
+
1198
+ src/dataunit/DataUnit.ts:654
1199
+
1200
+ ***
1201
+
1202
+ ### getGlobalLoaderProps()
1203
+
1204
+ > **getGlobalLoaderProps**(): `Map`\<`string`, `string`\>
1205
+
1206
+ Retorna as propriedades transacionais adicionados anteriores à chamada.
1207
+
1208
+ #### Returns
1209
+
1210
+ `Map`\<`string`, `string`\>
1292
1211
 
1293
- src/dataunit/DataUnit.ts:614
1212
+ - Todas as propriedades desde o final do último loader.
1294
1213
 
1295
- ___
1214
+ #### Source
1296
1215
 
1297
- ### getInvalidMessage
1216
+ src/dataunit/DataUnit.ts:141
1298
1217
 
1299
- ▸ **getInvalidMessage**(`recordId`, `fieldName`): `undefined` \| `string`
1218
+ ***
1219
+
1220
+ ### getInvalidMessage()
1221
+
1222
+ > **getInvalidMessage**(`recordId`, `fieldName`): `undefined` \| `string`
1300
1223
 
1301
1224
  Obtém a mensagem de campo inválido para determinado registro.
1302
1225
 
1303
1226
  #### Parameters
1304
1227
 
1305
- | Name | Type | Description |
1306
- | :------ | :------ | :------ |
1307
- | `recordId` | `string` | Identificador do registro. |
1308
- | `fieldName` | `string` | Nome do campo. |
1228
+ • **recordId**: `string`
1229
+
1230
+ Identificador do registro.
1231
+
1232
+ • **fieldName**: `string`
1233
+
1234
+ Nome do campo.
1309
1235
 
1310
1236
  #### Returns
1311
1237
 
1312
1238
  `undefined` \| `string`
1313
1239
 
1314
- #### Defined in
1240
+ #### Source
1315
1241
 
1316
- src/dataunit/DataUnit.ts:981
1242
+ src/dataunit/DataUnit.ts:1020
1317
1243
 
1318
- ___
1244
+ ***
1319
1245
 
1320
- ### getLastLoadRequest
1246
+ ### getLastLoadRequest()
1321
1247
 
1322
- ▸ **getLastLoadRequest**(): `undefined` \| [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
1248
+ > **getLastLoadRequest**(): `undefined` \| [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
1323
1249
 
1324
1250
  Obtém as informações da última carga de dados.
1325
1251
 
@@ -1329,36 +1255,35 @@ Obtém as informações da última carga de dados.
1329
1255
 
1330
1256
  - As informações de filtro e paginação.
1331
1257
 
1332
- #### Defined in
1258
+ #### Source
1333
1259
 
1334
- src/dataunit/DataUnit.ts:1578
1260
+ src/dataunit/DataUnit.ts:1621
1335
1261
 
1336
- ___
1262
+ ***
1337
1263
 
1338
- ### getLoadDataRequest
1264
+ ### getLoadDataRequest()
1339
1265
 
1340
- ▸ `Private` **getLoadDataRequest**(`quickFilter?`, `source?`): [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
1266
+ > `private` **getLoadDataRequest**(`quickFilter`?, `source`?): [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
1341
1267
 
1342
1268
  #### Parameters
1343
1269
 
1344
- | Name | Type |
1345
- | :------ | :------ |
1346
- | `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) |
1347
- | `source?` | `string` |
1270
+ • **quickFilter?**: [`QuickFilter`](../interfaces/QuickFilter.md)
1271
+
1272
+ • **source?**: `string`
1348
1273
 
1349
1274
  #### Returns
1350
1275
 
1351
1276
  [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
1352
1277
 
1353
- #### Defined in
1278
+ #### Source
1354
1279
 
1355
- src/dataunit/DataUnit.ts:366
1280
+ src/dataunit/DataUnit.ts:400
1356
1281
 
1357
- ___
1282
+ ***
1358
1283
 
1359
- ### getModifiedRecords
1284
+ ### getModifiedRecords()
1360
1285
 
1361
- ▸ **getModifiedRecords**(): [`Record`](../interfaces/Record.md)[]
1286
+ > **getModifiedRecords**(): [`Record`](../interfaces/Record.md)[]
1362
1287
 
1363
1288
  Obtém os registros modificados e ainda não salvos no DataUnit.
1364
1289
 
@@ -1368,15 +1293,15 @@ Obtém os registros modificados e ainda não salvos no DataUnit.
1368
1293
 
1369
1294
  - Lista dos registros em edição.
1370
1295
 
1371
- #### Defined in
1296
+ #### Source
1372
1297
 
1373
- src/dataunit/DataUnit.ts:802
1298
+ src/dataunit/DataUnit.ts:841
1374
1299
 
1375
- ___
1300
+ ***
1376
1301
 
1377
- ### getPaginationInfo
1302
+ ### getPaginationInfo()
1378
1303
 
1379
- ▸ **getPaginationInfo**(): `void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
1304
+ > **getPaginationInfo**(): `void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
1380
1305
 
1381
1306
  Obtém informações de paginação dos registros.
1382
1307
 
@@ -1386,49 +1311,47 @@ Obtém informações de paginação dos registros.
1386
1311
 
1387
1312
  - Informações da paginação de registros.
1388
1313
 
1389
- #### Defined in
1314
+ #### Source
1390
1315
 
1391
- src/dataunit/DataUnit.ts:680
1316
+ src/dataunit/DataUnit.ts:719
1392
1317
 
1393
- ___
1318
+ ***
1394
1319
 
1395
- ### getParentRecordId
1320
+ ### getParentRecordId()
1396
1321
 
1397
- ▸ `Private` **getParentRecordId**(): `undefined` \| `string`
1322
+ > `private` **getParentRecordId**(): `undefined` \| `string`
1398
1323
 
1399
1324
  #### Returns
1400
1325
 
1401
1326
  `undefined` \| `string`
1402
1327
 
1403
- #### Defined in
1328
+ #### Source
1404
1329
 
1405
- src/dataunit/DataUnit.ts:880
1330
+ src/dataunit/DataUnit.ts:919
1406
1331
 
1407
- ___
1332
+ ***
1408
1333
 
1409
- ### getRecordsByDataUnit
1334
+ ### getRecordsByDataUnit()
1410
1335
 
1411
- ▸ `Private` **getRecordsByDataUnit**(`records`): `Map`<`string`, [`Record`](../interfaces/Record.md)[]\>
1336
+ > `private` **getRecordsByDataUnit**(`records`): `Map`\<`string`, [`Record`](../interfaces/Record.md)[]\>
1412
1337
 
1413
1338
  #### Parameters
1414
1339
 
1415
- | Name | Type |
1416
- | :------ | :------ |
1417
- | `records` | [`Record`](../interfaces/Record.md)[] |
1340
+ • **records**: [`Record`](../interfaces/Record.md)[]
1418
1341
 
1419
1342
  #### Returns
1420
1343
 
1421
- `Map`<`string`, [`Record`](../interfaces/Record.md)[]\>
1344
+ `Map`\<`string`, [`Record`](../interfaces/Record.md)[]\>
1422
1345
 
1423
- #### Defined in
1346
+ #### Source
1424
1347
 
1425
- src/dataunit/DataUnit.ts:858
1348
+ src/dataunit/DataUnit.ts:897
1426
1349
 
1427
- ___
1350
+ ***
1428
1351
 
1429
- ### getSelectedRecord
1352
+ ### getSelectedRecord()
1430
1353
 
1431
- ▸ **getSelectedRecord**(): `undefined` \| [`Record`](../interfaces/Record.md)
1354
+ > **getSelectedRecord**(): `undefined` \| [`Record`](../interfaces/Record.md)
1432
1355
 
1433
1356
  Retorna apenas um registro selecionado no Dataunit
1434
1357
 
@@ -1438,47 +1361,41 @@ Retorna apenas um registro selecionado no Dataunit
1438
1361
 
1439
1362
  - Registro selecionado.
1440
1363
 
1441
- #### Defined in
1364
+ #### Source
1442
1365
 
1443
- src/dataunit/DataUnit.ts:1136
1366
+ src/dataunit/DataUnit.ts:1175
1444
1367
 
1445
- ___
1368
+ ***
1446
1369
 
1447
- ### getSelectedRecords
1370
+ ### ~~getSelectedRecords()~~
1448
1371
 
1449
- ▸ **getSelectedRecords**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
1372
+ > **getSelectedRecords**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
1450
1373
 
1451
1374
  Obtém todos os registros selecionados.
1452
1375
 
1453
- **`Deprecated`**
1454
-
1455
- - Utilize o método `getSelectionInfo()` para obter os registros selecionados.
1456
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
1457
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
1458
-
1459
1376
  #### Returns
1460
1377
 
1461
1378
  `undefined` \| [`Record`](../interfaces/Record.md)[]
1462
1379
 
1463
1380
  - Lista de registros selecionados.
1464
1381
 
1465
- #### Defined in
1382
+ #### Deprecated
1466
1383
 
1467
- src/dataunit/DataUnit.ts:1665
1384
+ - Utilize o método `getSelectionInfo()` para obter os registros selecionados.
1385
+ Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
1386
+ método foi descontinuado e pode retornar erros no caso da seleção virtual.
1468
1387
 
1469
- ___
1388
+ #### Source
1470
1389
 
1471
- ### getSelection
1390
+ src/dataunit/DataUnit.ts:1708
1472
1391
 
1473
- ▸ **getSelection**(): `string`[]
1392
+ ***
1474
1393
 
1475
- Obtém ids dos registros selecionados.
1394
+ ### ~~getSelection()~~
1476
1395
 
1477
- **`Deprecated`**
1396
+ > **getSelection**(): `string`[]
1478
1397
 
1479
- - Utilize o método `getSelectionInfo()` para obter os registros selecionados.
1480
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
1481
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
1398
+ Obtém ids dos registros selecionados.
1482
1399
 
1483
1400
  #### Returns
1484
1401
 
@@ -1486,15 +1403,21 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
1486
1403
 
1487
1404
  - Lista com id de todos os registros selecionados.
1488
1405
 
1489
- #### Defined in
1406
+ #### Deprecated
1490
1407
 
1491
- src/dataunit/DataUnit.ts:1689
1408
+ - Utilize o método `getSelectionInfo()` para obter os registros selecionados.
1409
+ Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
1410
+ método foi descontinuado e pode retornar erros no caso da seleção virtual.
1492
1411
 
1493
- ___
1412
+ #### Source
1494
1413
 
1495
- ### getSelectionInfo
1414
+ src/dataunit/DataUnit.ts:1732
1496
1415
 
1497
- ▸ **getSelectionInfo**(): `undefined` \| [`SelectionInfo`](SelectionInfo.md)
1416
+ ***
1417
+
1418
+ ### getSelectionInfo()
1419
+
1420
+ > **getSelectionInfo**(): `undefined` \| [`SelectionInfo`](SelectionInfo.md)
1498
1421
 
1499
1422
  Obtém informações sobre a seleção atual.
1500
1423
 
@@ -1504,15 +1427,15 @@ Obtém informações sobre a seleção atual.
1504
1427
 
1505
1428
  - Objeto com informações como registros selecionados e seleção por critério.
1506
1429
 
1507
- #### Defined in
1430
+ #### Source
1508
1431
 
1509
- src/dataunit/DataUnit.ts:1125
1432
+ src/dataunit/DataUnit.ts:1164
1510
1433
 
1511
- ___
1434
+ ***
1512
1435
 
1513
- ### getSort
1436
+ ### getSort()
1514
1437
 
1515
- ▸ **getSort**(): `undefined` \| [`Sort`](../interfaces/Sort.md)[]
1438
+ > **getSort**(): `undefined` \| [`Sort`](../interfaces/Sort.md)[]
1516
1439
 
1517
1440
  Obtém a estrutura de ordenação das colunas dos dados.
1518
1441
 
@@ -1522,40 +1445,43 @@ Obtém a estrutura de ordenação das colunas dos dados.
1522
1445
 
1523
1446
  - Lista dos ordenáveis por prioridade.
1524
1447
 
1525
- #### Defined in
1448
+ #### Source
1526
1449
 
1527
- src/dataunit/DataUnit.ts:1549
1450
+ src/dataunit/DataUnit.ts:1592
1528
1451
 
1529
- ___
1452
+ ***
1530
1453
 
1531
- ### gotoPage
1454
+ ### gotoPage()
1532
1455
 
1533
- ▸ **gotoPage**(`page`, `executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1456
+ > **gotoPage**(`page`, `executionCtx`?): `Promise`\<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1534
1457
 
1535
1458
  Alterna entre os registros por número de página.
1536
1459
 
1537
1460
  #### Parameters
1538
1461
 
1539
- | Name | Type | Description |
1540
- | :------ | :------ | :------ |
1541
- | `page` | `number` | Número da página desejada. |
1542
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
1462
+ • **page**: `number`
1463
+
1464
+ Número da página desejada.
1465
+
1466
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1467
+
1468
+ Contexto de execução do carregamento dos registros do DataUnit.
1543
1469
 
1544
1470
  #### Returns
1545
1471
 
1546
- `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1472
+ `Promise`\<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1547
1473
 
1548
1474
  - Registros da página desejada.
1549
1475
 
1550
- #### Defined in
1476
+ #### Source
1551
1477
 
1552
- src/dataunit/DataUnit.ts:318
1478
+ src/dataunit/DataUnit.ts:352
1553
1479
 
1554
- ___
1480
+ ***
1555
1481
 
1556
- ### hasCopiedRecord
1482
+ ### hasCopiedRecord()
1557
1483
 
1558
- ▸ **hasCopiedRecord**(): `boolean`
1484
+ > **hasCopiedRecord**(): `boolean`
1559
1485
 
1560
1486
  Retorna se existe pelo menos um registro novo.
1561
1487
 
@@ -1565,15 +1491,15 @@ Retorna se existe pelo menos um registro novo.
1565
1491
 
1566
1492
  Verdadeiro se algum registro foi adicionado.
1567
1493
 
1568
- #### Defined in
1494
+ #### Source
1569
1495
 
1570
- src/dataunit/DataUnit.ts:1326
1496
+ src/dataunit/DataUnit.ts:1365
1571
1497
 
1572
- ___
1498
+ ***
1573
1499
 
1574
- ### hasDirtyRecords
1500
+ ### hasDirtyRecords()
1575
1501
 
1576
- ▸ **hasDirtyRecords**(): `boolean`
1502
+ > **hasDirtyRecords**(): `boolean`
1577
1503
 
1578
1504
  Retorna se existe algum registro em modo de edição.
1579
1505
 
@@ -1583,15 +1509,15 @@ Retorna se existe algum registro em modo de edição.
1583
1509
 
1584
1510
  Verdadeiro se existir alterações de registros pendentes.
1585
1511
 
1586
- #### Defined in
1512
+ #### Source
1587
1513
 
1588
- src/dataunit/DataUnit.ts:1256
1514
+ src/dataunit/DataUnit.ts:1295
1589
1515
 
1590
- ___
1516
+ ***
1591
1517
 
1592
- ### hasNewRecord
1518
+ ### hasNewRecord()
1593
1519
 
1594
- ▸ **hasNewRecord**(): `boolean`
1520
+ > **hasNewRecord**(): `boolean`
1595
1521
 
1596
1522
  Retorna se existe pelo menos um registro novo.
1597
1523
 
@@ -1601,15 +1527,15 @@ Retorna se existe pelo menos um registro novo.
1601
1527
 
1602
1528
  Verdadeiro se algum registro foi adicionado.
1603
1529
 
1604
- #### Defined in
1530
+ #### Source
1605
1531
 
1606
- src/dataunit/DataUnit.ts:1314
1532
+ src/dataunit/DataUnit.ts:1353
1607
1533
 
1608
- ___
1534
+ ***
1609
1535
 
1610
- ### hasNext
1536
+ ### hasNext()
1611
1537
 
1612
- ▸ **hasNext**(): `boolean`
1538
+ > **hasNext**(): `boolean`
1613
1539
 
1614
1540
  Retorna se existir uma pagina seguinte a atual na paginação.
1615
1541
 
@@ -1619,15 +1545,15 @@ Retorna se existir uma pagina seguinte a atual na paginação.
1619
1545
 
1620
1546
  Verdadeiro se existir uma próxima página.
1621
1547
 
1622
- #### Defined in
1548
+ #### Source
1623
1549
 
1624
- src/dataunit/DataUnit.ts:1267
1550
+ src/dataunit/DataUnit.ts:1306
1625
1551
 
1626
- ___
1552
+ ***
1627
1553
 
1628
- ### hasPrevious
1554
+ ### hasPrevious()
1629
1555
 
1630
- ▸ **hasPrevious**(): `boolean`
1556
+ > **hasPrevious**(): `boolean`
1631
1557
 
1632
1558
  Retorna se existe uma página anterior a atual na paginação.
1633
1559
 
@@ -1637,15 +1563,15 @@ Retorna se existe uma página anterior a atual na paginação.
1637
1563
 
1638
1564
  Verdadeiro se existir uma página anterior.
1639
1565
 
1640
- #### Defined in
1566
+ #### Source
1641
1567
 
1642
- src/dataunit/DataUnit.ts:1282
1568
+ src/dataunit/DataUnit.ts:1321
1643
1569
 
1644
- ___
1570
+ ***
1645
1571
 
1646
- ### hasWaitingChanges
1572
+ ### hasWaitingChanges()
1647
1573
 
1648
- ▸ **hasWaitingChanges**(): `boolean`
1574
+ > **hasWaitingChanges**(): `boolean`
1649
1575
 
1650
1576
  Retorna se existe alterações pendentes.
1651
1577
 
@@ -1655,62 +1581,65 @@ Retorna se existe alterações pendentes.
1655
1581
 
1656
1582
  Verdadeiro se existir pendências de modificações.
1657
1583
 
1658
- #### Defined in
1584
+ #### Source
1659
1585
 
1660
- src/dataunit/DataUnit.ts:1012
1586
+ src/dataunit/DataUnit.ts:1051
1661
1587
 
1662
- ___
1588
+ ***
1663
1589
 
1664
- ### hideField
1590
+ ### hideField()
1665
1591
 
1666
- ▸ **hideField**(`fieldName`): `void`
1592
+ > **hideField**(`fieldName`): `void`
1667
1593
 
1668
1594
  Deixa um campo do DataUnit invisível
1669
1595
 
1670
1596
  #### Parameters
1671
1597
 
1672
- | Name | Type | Description |
1673
- | :------ | :------ | :------ |
1674
- | `fieldName` | `string` | nome do campo para ficar invisível. |
1598
+ • **fieldName**: `string`
1599
+
1600
+ nome do campo para ficar invisível.
1675
1601
 
1676
1602
  #### Returns
1677
1603
 
1678
1604
  `void`
1679
1605
 
1680
- #### Defined in
1606
+ #### Source
1681
1607
 
1682
- src/dataunit/DataUnit.ts:1630
1608
+ src/dataunit/DataUnit.ts:1673
1683
1609
 
1684
- ___
1610
+ ***
1685
1611
 
1686
- ### intercept
1612
+ ### intercept()
1687
1613
 
1688
- ▸ `Private` **intercept**(`action`, `interceptors`): `Promise`<[`DataUnitAction`](DataUnitAction.md)\>
1614
+ > `private` **intercept**(`action`, `interceptors`): `Promise`\<[`DataUnitAction`](DataUnitAction.md)\>
1689
1615
 
1690
1616
  Notifica os interceptors de que uma ação foi executada, para que cada interceptor possa fazer sua respectiva tratativa dos dados.
1691
1617
 
1692
1618
  #### Parameters
1693
1619
 
1694
- | Name | Type | Description |
1695
- | :------ | :------ | :------ |
1696
- | `action` | [`DataUnitAction`](DataUnitAction.md) | Ação que foi executada. |
1697
- | `interceptors` | `IterableIterator`<[`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\> | Interceptors que serão notificados. |
1620
+ • **action**: [`DataUnitAction`](DataUnitAction.md)
1621
+
1622
+ Ação que foi executada.
1623
+
1624
+ • **interceptors**: `IterableIterator`\<[`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\>
1625
+
1626
+ Interceptors que serão notificados.
1698
1627
 
1699
1628
  #### Returns
1700
1629
 
1701
- `Promise`<[`DataUnitAction`](DataUnitAction.md)\>
1630
+ `Promise`\<[`DataUnitAction`](DataUnitAction.md)\>
1702
1631
 
1703
1632
  - Ação executada no DataUnit.
1704
1633
 
1705
- #### Defined in
1634
+ #### Source
1706
1635
 
1707
- src/dataunit/DataUnit.ts:1438
1636
+ src/dataunit/DataUnit.ts:1477
1708
1637
 
1709
- ___
1638
+ ***
1710
1639
 
1711
- ### isDirty
1640
+ ### isDirty()
1712
1641
 
1713
- ▸ **isDirty**(): `boolean`
1642
+ > **isDirty**(): `boolean`
1714
1643
 
1715
1644
  Retorna se existe algum tipo de alteração pendente.
1716
1645
 
@@ -1720,23 +1649,23 @@ Retorna se existe algum tipo de alteração pendente.
1720
1649
 
1721
1650
  Verdadeiro se existir alterações pendentes.
1722
1651
 
1723
- #### Defined in
1652
+ #### Source
1724
1653
 
1725
- src/dataunit/DataUnit.ts:1231
1654
+ src/dataunit/DataUnit.ts:1270
1726
1655
 
1727
- ___
1656
+ ***
1728
1657
 
1729
- ### isNewRecord
1658
+ ### isNewRecord()
1730
1659
 
1731
- ▸ **isNewRecord**(`recordId`): `boolean`
1660
+ > **isNewRecord**(`recordId`): `boolean`
1732
1661
 
1733
1662
  Verifica se um registro é proveniente de inclusão.
1734
1663
 
1735
1664
  #### Parameters
1736
1665
 
1737
- | Name | Type | Description |
1738
- | :------ | :------ | :------ |
1739
- | `recordId` | `string` | O id do registro a ser verificado. |
1666
+ • **recordId**: `string`
1667
+
1668
+ O id do registro a ser verificado.
1740
1669
 
1741
1670
  #### Returns
1742
1671
 
@@ -1744,257 +1673,259 @@ Verifica se um registro é proveniente de inclusão.
1744
1673
 
1745
1674
  Verdadeiro se o id solicitado é de um registro novo.
1746
1675
 
1747
- #### Defined in
1676
+ #### Source
1748
1677
 
1749
- src/dataunit/DataUnit.ts:1298
1678
+ src/dataunit/DataUnit.ts:1337
1750
1679
 
1751
- ___
1680
+ ***
1752
1681
 
1753
- ### isSameRequest
1682
+ ### isSameRequest()
1754
1683
 
1755
- ▸ `Private` **isSameRequest**(`request`): `boolean`
1684
+ > `private` **isSameRequest**(`request`): `boolean`
1756
1685
 
1757
1686
  #### Parameters
1758
1687
 
1759
- | Name | Type |
1760
- | :------ | :------ |
1761
- | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
1688
+ • **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
1762
1689
 
1763
1690
  #### Returns
1764
1691
 
1765
1692
  `boolean`
1766
1693
 
1767
- #### Defined in
1694
+ #### Source
1768
1695
 
1769
- src/dataunit/DataUnit.ts:247
1696
+ src/dataunit/DataUnit.ts:278
1770
1697
 
1771
- ___
1698
+ ***
1772
1699
 
1773
- ### loadData
1700
+ ### loadData()
1774
1701
 
1775
- ▸ **loadData**(`quickFilter?`, `executionCtx?`, `checkLastFilter?`, `source?`, `selectFirstRecord?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1702
+ > **loadData**(`quickFilter`?, `executionCtx`?, `checkLastFilter`?, `source`?, `selectFirstRecord`?): `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1776
1703
 
1777
1704
  Carrega os registros do DataUnit.
1778
1705
 
1779
1706
  #### Parameters
1780
1707
 
1781
- | Name | Type | Description |
1782
- | :------ | :------ | :------ |
1783
- | `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) | Filtros a serem aplicados. |
1784
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros. |
1785
- | `checkLastFilter?` | `boolean` | Habilita a verificação da última requisição, evitando carga desnecessária. |
1786
- | `source?` | `string` | - |
1787
- | `selectFirstRecord?` | `boolean` | - |
1708
+ • **quickFilter?**: [`QuickFilter`](../interfaces/QuickFilter.md)
1709
+
1710
+ Filtros a serem aplicados.
1711
+
1712
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1713
+
1714
+ Contexto de execução do carregamento dos registros.
1715
+
1716
+ • **checkLastFilter?**: `boolean`
1717
+
1718
+ Habilita a verificação da última requisição, evitando carga desnecessária.
1719
+
1720
+ • **source?**: `string`
1721
+
1722
+ • **selectFirstRecord?**: `boolean`
1788
1723
 
1789
1724
  #### Returns
1790
1725
 
1791
- `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1726
+ `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1792
1727
 
1793
1728
  - Registros requisitados.
1794
1729
 
1795
- #### Defined in
1730
+ #### Source
1796
1731
 
1797
- src/dataunit/DataUnit.ts:291
1732
+ src/dataunit/DataUnit.ts:322
1798
1733
 
1799
- ___
1734
+ ***
1800
1735
 
1801
- ### loadMetadata
1736
+ ### loadMetadata()
1802
1737
 
1803
- ▸ **loadMetadata**(`executionCtx?`): `Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
1738
+ > **loadMetadata**(`executionCtx`?): `Promise`\<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
1804
1739
 
1805
1740
  Carrega os metadados do DataUnit.
1806
1741
 
1807
1742
  #### Parameters
1808
1743
 
1809
- | Name | Type | Description |
1810
- | :------ | :------ | :------ |
1811
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos metadados do DataUnit. |
1744
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1745
+
1746
+ Contexto de execução do carregamento dos metadados do DataUnit.
1812
1747
 
1813
1748
  #### Returns
1814
1749
 
1815
- `Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
1750
+ `Promise`\<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
1816
1751
 
1817
1752
  - Metadados carregados.
1818
1753
 
1819
- #### Defined in
1754
+ #### Source
1820
1755
 
1821
- src/dataunit/DataUnit.ts:262
1756
+ src/dataunit/DataUnit.ts:293
1822
1757
 
1823
- ___
1758
+ ***
1824
1759
 
1825
- ### nextPage
1760
+ ### nextPage()
1826
1761
 
1827
- ▸ **nextPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1762
+ > **nextPage**(`executionCtx`?): `Promise`\<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1828
1763
 
1829
1764
  Vai para os registros da página seguinte.
1830
1765
 
1831
1766
  #### Parameters
1832
1767
 
1833
- | Name | Type | Description |
1834
- | :------ | :------ | :------ |
1835
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
1768
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1769
+
1770
+ Contexto de execução do carregamento dos registros do DataUnit.
1836
1771
 
1837
1772
  #### Returns
1838
1773
 
1839
- `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1774
+ `Promise`\<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1840
1775
 
1841
1776
  - Registros da página seguinte.
1842
1777
 
1843
- #### Defined in
1778
+ #### Source
1844
1779
 
1845
- src/dataunit/DataUnit.ts:349
1780
+ src/dataunit/DataUnit.ts:383
1846
1781
 
1847
- ___
1782
+ ***
1848
1783
 
1849
- ### nextRecord
1784
+ ### nextRecord()
1850
1785
 
1851
- ▸ **nextRecord**(`executionCtx?`): `void`
1786
+ > **nextRecord**(`executionCtx`?): `void`
1852
1787
 
1853
1788
  Seleciona o próximo registro.
1854
1789
 
1855
1790
  #### Parameters
1856
1791
 
1857
- | Name | Type | Description |
1858
- | :------ | :------ | :------ |
1859
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
1792
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1793
+
1794
+ Contexto de execução da seleção do registro do DataUnit.
1860
1795
 
1861
1796
  #### Returns
1862
1797
 
1863
1798
  `void`
1864
1799
 
1865
- #### Defined in
1800
+ #### Source
1866
1801
 
1867
- src/dataunit/DataUnit.ts:1158
1802
+ src/dataunit/DataUnit.ts:1197
1868
1803
 
1869
- ___
1804
+ ***
1870
1805
 
1871
- ### notifySavingData
1806
+ ### notifySavingData()
1872
1807
 
1873
- ▸ `Private` **notifySavingData**(`executionCtx?`): `Promise`<`boolean`\>
1808
+ > `private` **notifySavingData**(`executionCtx`?): `Promise`\<`boolean`\>
1874
1809
 
1875
1810
  #### Parameters
1876
1811
 
1877
- | Name | Type |
1878
- | :------ | :------ |
1879
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1812
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1880
1813
 
1881
1814
  #### Returns
1882
1815
 
1883
- `Promise`<`boolean`\>
1816
+ `Promise`\<`boolean`\>
1884
1817
 
1885
- #### Defined in
1818
+ #### Source
1886
1819
 
1887
- src/dataunit/DataUnit.ts:386
1820
+ src/dataunit/DataUnit.ts:420
1888
1821
 
1889
- ___
1822
+ ***
1890
1823
 
1891
- ### onDataUnitParentEvent
1824
+ ### onDataUnitParentEvent()
1892
1825
 
1893
- ▸ `Private` **onDataUnitParentEvent**(`action`): `void`
1826
+ > `private` **onDataUnitParentEvent**(`action`): `void`
1894
1827
 
1895
1828
  Trata as Actions do DataUnit Parent
1896
1829
 
1897
1830
  #### Parameters
1898
1831
 
1899
- | Name | Type |
1900
- | :------ | :------ |
1901
- | `action` | [`DataUnitAction`](DataUnitAction.md) |
1832
+ • **action**: [`DataUnitAction`](DataUnitAction.md)
1902
1833
 
1903
1834
  #### Returns
1904
1835
 
1905
1836
  `void`
1906
1837
 
1907
- #### Defined in
1838
+ #### Source
1908
1839
 
1909
- src/dataunit/DataUnit.ts:154
1840
+ src/dataunit/DataUnit.ts:181
1910
1841
 
1911
- ___
1842
+ ***
1912
1843
 
1913
- ### previousPage
1844
+ ### previousPage()
1914
1845
 
1915
- ▸ **previousPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1846
+ > **previousPage**(`executionCtx`?): `Promise`\<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1916
1847
 
1917
1848
  Vai para os registros da página anterior.
1918
1849
 
1919
1850
  #### Parameters
1920
1851
 
1921
- | Name | Type | Description |
1922
- | :------ | :------ | :------ |
1923
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
1852
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1853
+
1854
+ Contexto de execução do carregamento dos registros do DataUnit.
1924
1855
 
1925
1856
  #### Returns
1926
1857
 
1927
- `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1858
+ `Promise`\<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1928
1859
 
1929
1860
  - Registros da página anterior.
1930
1861
 
1931
- #### Defined in
1862
+ #### Source
1932
1863
 
1933
- src/dataunit/DataUnit.ts:362
1864
+ src/dataunit/DataUnit.ts:396
1934
1865
 
1935
- ___
1866
+ ***
1936
1867
 
1937
- ### previousRecord
1868
+ ### previousRecord()
1938
1869
 
1939
- ▸ **previousRecord**(`executionCtx?`): `void`
1870
+ > **previousRecord**(`executionCtx`?): `void`
1940
1871
 
1941
1872
  Seleciona o registro anterior.
1942
1873
 
1943
1874
  #### Parameters
1944
1875
 
1945
- | Name | Type | Description |
1946
- | :------ | :------ | :------ |
1947
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
1876
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1877
+
1878
+ Contexto de execução da seleção do registro do DataUnit.
1948
1879
 
1949
1880
  #### Returns
1950
1881
 
1951
1882
  `void`
1952
1883
 
1953
- #### Defined in
1884
+ #### Source
1954
1885
 
1955
- src/dataunit/DataUnit.ts:1185
1886
+ src/dataunit/DataUnit.ts:1224
1956
1887
 
1957
- ___
1888
+ ***
1958
1889
 
1959
- ### processLoadingLockers
1890
+ ### processLoadingLockers()
1960
1891
 
1961
- ▸ `Private` **processLoadingLockers**(): `Promise`<`void`\>
1892
+ > `private` **processLoadingLockers**(): `Promise`\<`void`\>
1962
1893
 
1963
1894
  #### Returns
1964
1895
 
1965
- `Promise`<`void`\>
1896
+ `Promise`\<`void`\>
1966
1897
 
1967
- #### Defined in
1898
+ #### Source
1968
1899
 
1969
- src/dataunit/DataUnit.ts:1724
1900
+ src/dataunit/DataUnit.ts:1780
1970
1901
 
1971
- ___
1902
+ ***
1972
1903
 
1973
- ### redo
1904
+ ### redo()
1974
1905
 
1975
- ▸ **redo**(`executionCtx?`): `void`
1906
+ > **redo**(`executionCtx`?): `void`
1976
1907
 
1977
1908
  Refaz a última ação.
1978
1909
 
1979
1910
  #### Parameters
1980
1911
 
1981
- | Name | Type | Description |
1982
- | :------ | :------ | :------ |
1983
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de refazer a última ação. |
1912
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
1913
+
1914
+ Contexto de execução de refazer a última ação.
1984
1915
 
1985
1916
  #### Returns
1986
1917
 
1987
1918
  `void`
1988
1919
 
1989
- #### Defined in
1920
+ #### Source
1990
1921
 
1991
- src/dataunit/DataUnit.ts:1380
1922
+ src/dataunit/DataUnit.ts:1419
1992
1923
 
1993
- ___
1924
+ ***
1994
1925
 
1995
- ### release
1926
+ ### release()
1996
1927
 
1997
- ▸ **release**(): `void`
1928
+ > **release**(): `void`
1998
1929
 
1999
1930
  Desfaz vinculos do DataUnit. Chamado quando o DU não é mais necessário.
2000
1931
 
@@ -2002,15 +1933,15 @@ Desfaz vinculos do DataUnit. Chamado quando o DU não é mais necessário.
2002
1933
 
2003
1934
  `void`
2004
1935
 
2005
- #### Defined in
1936
+ #### Source
2006
1937
 
2007
- src/dataunit/DataUnit.ts:90
1938
+ src/dataunit/DataUnit.ts:94
2008
1939
 
2009
- ___
1940
+ ***
2010
1941
 
2011
- ### releaseCallbacks
1942
+ ### releaseCallbacks()
2012
1943
 
2013
- ▸ **releaseCallbacks**(): `void`
1944
+ > **releaseCallbacks**(): `void`
2014
1945
 
2015
1946
  Remove callbacks registrados internamente no dataunit, é util
2016
1947
  para evitar memory leak em cenários onde o dataunit é reaproveitado em cache.
@@ -2025,404 +1956,440 @@ Callbacks que são liberados:
2025
1956
 
2026
1957
  `void`
2027
1958
 
2028
- #### Defined in
1959
+ #### Source
2029
1960
 
2030
- src/dataunit/DataUnit.ts:110
1961
+ src/dataunit/DataUnit.ts:114
2031
1962
 
2032
- ___
1963
+ ***
2033
1964
 
2034
- ### reloadCurrentRecord
1965
+ ### reloadCurrentRecord()
2035
1966
 
2036
- ▸ **reloadCurrentRecord**(): `Promise`<[`Record`](../interfaces/Record.md)[]\>
1967
+ > **reloadCurrentRecord**(): `Promise`\<[`Record`](../interfaces/Record.md)[]\>
2037
1968
 
2038
1969
  Recarrega registro selecionado com dados atualizados do servidor.
2039
1970
 
2040
1971
  #### Returns
2041
1972
 
2042
- `Promise`<[`Record`](../interfaces/Record.md)[]\>
1973
+ `Promise`\<[`Record`](../interfaces/Record.md)[]\>
2043
1974
 
2044
1975
  - Dados atualizados do registro selecionado.
2045
1976
 
2046
- #### Defined in
1977
+ #### Source
2047
1978
 
2048
- src/dataunit/DataUnit.ts:1525
1979
+ src/dataunit/DataUnit.ts:1564
2049
1980
 
2050
- ___
1981
+ ***
2051
1982
 
2052
- ### removeChildDataunit
1983
+ ### removeChildDataunit()
2053
1984
 
2054
- ▸ **removeChildDataunit**(`name`): `void`
1985
+ > **removeChildDataunit**(`name`): `void`
2055
1986
 
2056
1987
  Remove um dataunit filho.
2057
1988
 
2058
1989
  #### Parameters
2059
1990
 
2060
- | Name | Type | Description |
2061
- | :------ | :------ | :------ |
2062
- | `name` | `string` | Nome do dataunit filho. |
1991
+ • **name**: `string`
1992
+
1993
+ Nome do dataunit filho.
2063
1994
 
2064
1995
  #### Returns
2065
1996
 
2066
1997
  `void`
2067
1998
 
2068
- #### Defined in
1999
+ #### Source
2069
2000
 
2070
- src/dataunit/DataUnit.ts:1491
2001
+ src/dataunit/DataUnit.ts:1530
2071
2002
 
2072
- ___
2003
+ ***
2073
2004
 
2074
- ### removeFilterProvider
2005
+ ### removeFilterProvider()
2075
2006
 
2076
- ▸ **removeFilterProvider**(`provider`): `boolean`
2007
+ > **removeFilterProvider**(`provider`): `boolean`
2077
2008
 
2078
2009
  Remove um FilterProvider.
2079
2010
 
2080
2011
  #### Parameters
2081
2012
 
2082
- | Name | Type | Description |
2083
- | :------ | :------ | :------ |
2084
- | `provider` | `FilterProvider` | FilterProvider que será removido. |
2013
+ • **provider**: `FilterProvider`
2014
+
2015
+ FilterProvider que será removido.
2085
2016
 
2086
2017
  #### Returns
2087
2018
 
2088
2019
  `boolean`
2089
2020
 
2090
- #### Defined in
2021
+ #### Source
2091
2022
 
2092
- src/dataunit/DataUnit.ts:670
2023
+ src/dataunit/DataUnit.ts:709
2093
2024
 
2094
- ___
2025
+ ***
2095
2026
 
2096
- ### removeInterceptor
2027
+ ### removeInterceptor()
2097
2028
 
2098
- ▸ **removeInterceptor**(`interceptor`): `void`
2029
+ > **removeInterceptor**(`interceptor`): `void`
2099
2030
 
2100
2031
  Remove um interceptor da lista de interceptors.
2101
2032
 
2102
2033
  #### Parameters
2103
2034
 
2104
- | Name | Type | Description |
2105
- | :------ | :------ | :------ |
2106
- | `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) | Interceptor a ser removido. |
2035
+ • **interceptor**: [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)
2036
+
2037
+ Interceptor a ser removido.
2107
2038
 
2108
2039
  #### Returns
2109
2040
 
2110
2041
  `void`
2111
2042
 
2112
- #### Defined in
2043
+ #### Source
2113
2044
 
2114
- src/dataunit/DataUnit.ts:648
2045
+ src/dataunit/DataUnit.ts:687
2115
2046
 
2116
- ___
2047
+ ***
2117
2048
 
2118
- ### removeRecords
2049
+ ### removeRecords()
2119
2050
 
2120
- ▸ **removeRecords**(`recordIds`, `cachedRecords`, `buffered?`, `executionCtx?`, `silent?`): `Promise`<`string`[]\>
2051
+ > **removeRecords**(`recordIds`, `cachedRecords`, `buffered`, `executionCtx`?, `silent`?): `Promise`\<`string`[]\>
2121
2052
 
2122
2053
  Efetua requisição para remoção dos registros.
2123
2054
 
2124
2055
  #### Parameters
2125
2056
 
2126
- | Name | Type | Default value | Description |
2127
- | :------ | :------ | :------ | :------ |
2128
- | `recordIds` | `string`[] | `undefined` | Lista de IDs dos registros que serão removidos. |
2129
- | `cachedRecords` | [`Record`](../interfaces/Record.md)[] | `undefined` | Dados dos registros que serão removidos. |
2130
- | `buffered` | `boolean` | `false` | Se será utilizado buffer na solicitação. |
2131
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` | Contexto de execução da remoção do registro do DataUnit. |
2132
- | `silent` | `boolean` | `false` | Define se haverá mensagem de confirmação da remoção |
2057
+ • **recordIds**: `string`[]
2058
+
2059
+ Lista de IDs dos registros que serão removidos.
2060
+
2061
+ • **cachedRecords**: [`Record`](../interfaces/Record.md)[]
2062
+
2063
+ Dados dos registros que serão removidos.
2064
+
2065
+ • **buffered**: `boolean`= `false`
2066
+
2067
+ Se será utilizado buffer na solicitação.
2068
+
2069
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2070
+
2071
+ Contexto de execução da remoção do registro do DataUnit.
2072
+
2073
+ • **silent?**: `boolean`= `false`
2074
+
2075
+ Define se haverá mensagem de confirmação da remoção
2133
2076
 
2134
2077
  #### Returns
2135
2078
 
2136
- `Promise`<`string`[]\>
2079
+ `Promise`\<`string`[]\>
2137
2080
 
2138
2081
  - ID's dos registros removidos.
2139
2082
 
2140
- #### Defined in
2083
+ #### Source
2141
2084
 
2142
- src/dataunit/DataUnit.ts:536
2085
+ src/dataunit/DataUnit.ts:573
2143
2086
 
2144
- ___
2087
+ ***
2145
2088
 
2146
- ### removeSelectedRecords
2089
+ ### removeSelectedRecords()
2147
2090
 
2148
- ▸ **removeSelectedRecords**(`buffered?`, `silent?`): `Promise`<`string`[]\>
2091
+ > **removeSelectedRecords**(`buffered`, `silent`): `Promise`\<`string`[]\>
2149
2092
 
2150
2093
  Remove o registro selecionado.
2151
2094
 
2152
2095
  #### Parameters
2153
2096
 
2154
- | Name | Type | Default value | Description |
2155
- | :------ | :------ | :------ | :------ |
2156
- | `buffered` | `boolean` | `false` | Se será utilizado buffer na solicitação. |
2157
- | `silent` | `boolean` | `false` | Define se haverá mensagem de confirmação da remoção |
2097
+ • **buffered**: `boolean`= `false`
2098
+
2099
+ Se será utilizado buffer na solicitação.
2100
+
2101
+ • **silent**: `boolean`= `false`
2102
+
2103
+ Define se haverá mensagem de confirmação da remoção
2158
2104
 
2159
2105
  #### Returns
2160
2106
 
2161
- `Promise`<`string`[]\>
2107
+ `Promise`\<`string`[]\>
2162
2108
 
2163
2109
  - ID's dos registros removidos.
2164
2110
 
2165
- #### Defined in
2111
+ #### Source
2166
2112
 
2167
- src/dataunit/DataUnit.ts:510
2113
+ src/dataunit/DataUnit.ts:547
2168
2114
 
2169
- ___
2115
+ ***
2170
2116
 
2171
- ### requestSelectFirst
2117
+ ### requestSelectFirst()
2172
2118
 
2173
- ▸ `Private` **requestSelectFirst**(`executionCtx?`): `void`
2119
+ > `private` **requestSelectFirst**(`executionCtx`?): `void`
2174
2120
 
2175
2121
  #### Parameters
2176
2122
 
2177
- | Name | Type |
2178
- | :------ | :------ |
2179
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
2123
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2180
2124
 
2181
2125
  #### Returns
2182
2126
 
2183
2127
  `void`
2184
2128
 
2185
- #### Defined in
2129
+ #### Source
2186
2130
 
2187
- src/dataunit/DataUnit.ts:241
2131
+ src/dataunit/DataUnit.ts:272
2188
2132
 
2189
- ___
2133
+ ***
2190
2134
 
2191
- ### saveData
2135
+ ### saveData()
2192
2136
 
2193
- ▸ **saveData**(`executionCtx?`): `Promise`<`void`\>
2137
+ > **saveData**(`executionCtx`?): `Promise`\<`void`\>
2194
2138
 
2195
2139
  Salva o estado do registro do DataUnit.
2196
2140
 
2197
2141
  #### Parameters
2198
2142
 
2199
- | Name | Type | Description |
2200
- | :------ | :------ | :------ |
2201
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da persistencia do registro do DataUnit. |
2143
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2144
+
2145
+ Contexto de execução da persistencia do registro do DataUnit.
2202
2146
 
2203
2147
  #### Returns
2204
2148
 
2205
- `Promise`<`void`\>
2149
+ `Promise`\<`void`\>
2206
2150
 
2207
2151
  - Resposta da solicitação.
2208
2152
 
2209
- #### Defined in
2153
+ #### Source
2210
2154
 
2211
- src/dataunit/DataUnit.ts:416
2155
+ src/dataunit/DataUnit.ts:450
2212
2156
 
2213
- ___
2157
+ ***
2214
2158
 
2215
- ### selectFirst
2159
+ ### selectFirst()
2216
2160
 
2217
- ▸ **selectFirst**(`executionCtx?`): `void`
2161
+ > **selectFirst**(`executionCtx`?): `void`
2218
2162
 
2219
2163
  Seleciona o primeiro registro.
2220
2164
 
2221
2165
  #### Parameters
2222
2166
 
2223
- | Name | Type | Description |
2224
- | :------ | :------ | :------ |
2225
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
2167
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2168
+
2169
+ Contexto de execução da seleção do registro do DataUnit.
2226
2170
 
2227
2171
  #### Returns
2228
2172
 
2229
2173
  `void`
2230
2174
 
2231
- #### Defined in
2175
+ #### Source
2232
2176
 
2233
- src/dataunit/DataUnit.ts:1025
2177
+ src/dataunit/DataUnit.ts:1064
2234
2178
 
2235
- ___
2179
+ ***
2236
2180
 
2237
- ### selectLast
2181
+ ### selectLast()
2238
2182
 
2239
- ▸ **selectLast**(`executionCtx?`): `void`
2183
+ > **selectLast**(`executionCtx`?): `void`
2240
2184
 
2241
2185
  Seleciona o último registro.
2242
2186
 
2243
2187
  #### Parameters
2244
2188
 
2245
- | Name | Type | Description |
2246
- | :------ | :------ | :------ |
2247
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
2189
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2190
+
2191
+ Contexto de execução da seleção do registro do DataUnit.
2248
2192
 
2249
2193
  #### Returns
2250
2194
 
2251
2195
  `void`
2252
2196
 
2253
- #### Defined in
2197
+ #### Source
2254
2198
 
2255
- src/dataunit/DataUnit.ts:1038
2199
+ src/dataunit/DataUnit.ts:1077
2256
2200
 
2257
- ___
2201
+ ***
2258
2202
 
2259
- ### setFieldValue
2203
+ ### setFieldValue()
2260
2204
 
2261
- ▸ **setFieldValue**(`fieldName`, `newValue`, `records?`): `Promise`<`boolean`\>
2205
+ > **setFieldValue**(`fieldName`, `newValue`, `records`?, `options`?): `Promise`\<`boolean`\>
2262
2206
 
2263
2207
  Insere valor no campo desejado.
2264
2208
 
2265
2209
  #### Parameters
2266
2210
 
2267
- | Name | Type | Description |
2268
- | :------ | :------ | :------ |
2269
- | `fieldName` | `string` | Identificador do campo a ser modificado. |
2270
- | `newValue` | `any` | Valor a ser inserido no campo. |
2271
- | `records?` | `string`[] | Indica quais registros foram afetados pela alteração no valor do campo. |
2211
+ • **fieldName**: `string`
2212
+
2213
+ Identificador do campo a ser modificado.
2214
+
2215
+ • **newValue**: `any`
2216
+
2217
+ Valor a ser inserido no campo.
2218
+
2219
+ • **records?**: `string`[]
2220
+
2221
+ Indica quais registros foram afetados pela alteração no valor do campo.
2222
+
2223
+ • **options?**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)
2272
2224
 
2273
2225
  #### Returns
2274
2226
 
2275
- `Promise`<`boolean`\>
2227
+ `Promise`\<`boolean`\>
2276
2228
 
2277
2229
  - Promise que será resolvida quando o novo valor for persistido no state.
2278
2230
 
2279
- #### Defined in
2231
+ #### Source
2280
2232
 
2281
- src/dataunit/DataUnit.ts:921
2233
+ src/dataunit/DataUnit.ts:960
2282
2234
 
2283
- ___
2235
+ ***
2284
2236
 
2285
- ### setInvalidField
2237
+ ### setInvalidField()
2286
2238
 
2287
- ▸ **setInvalidField**(`fieldName`, `message`, `recordId`): `void`
2239
+ > **setInvalidField**(`fieldName`, `message`, `recordId`): `void`
2288
2240
 
2289
2241
  Marca campos como inválidos.
2290
2242
 
2291
2243
  #### Parameters
2292
2244
 
2293
- | Name | Type | Description |
2294
- | :------ | :------ | :------ |
2295
- | `fieldName` | `string` | Nome do campo inválido. |
2296
- | `message` | `string` | Mensagem descrevendo o motivo da invalidade. |
2297
- | `recordId` | `string` | Indica qual registro está com o campo inválido. |
2245
+ • **fieldName**: `string`
2246
+
2247
+ Nome do campo inválido.
2248
+
2249
+ • **message**: `string`
2250
+
2251
+ Mensagem descrevendo o motivo da invalidade.
2252
+
2253
+ • **recordId**: `string`
2254
+
2255
+ Indica qual registro está com o campo inválido.
2298
2256
 
2299
2257
  #### Returns
2300
2258
 
2301
2259
  `void`
2302
2260
 
2303
- #### Defined in
2261
+ #### Source
2304
2262
 
2305
- src/dataunit/DataUnit.ts:957
2263
+ src/dataunit/DataUnit.ts:996
2306
2264
 
2307
- ___
2265
+ ***
2308
2266
 
2309
- ### setSelection
2267
+ ### setSelection()
2310
2268
 
2311
- ▸ **setSelection**(`selection`, `executionCtx?`): `Promise`<[`SelectionInfo`](SelectionInfo.md)\>
2269
+ > **setSelection**(`selection`, `executionCtx`?): `Promise`\<[`SelectionInfo`](SelectionInfo.md)\>
2312
2270
 
2313
2271
  Seleciona múltiplos registros por ID ou todos os registros (multipágina) .
2314
2272
 
2315
2273
  #### Parameters
2316
2274
 
2317
- | Name | Type | Description |
2318
- | :------ | :------ | :------ |
2319
- | `selection` | `string`[] \| [`ALL_RECORDS`](../enums/SelectionMode.md#all_records) | IDs para selecionar ou o modo de seleção completo. |
2320
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
2275
+ • **selection**: `string`[] \| [`ALL_RECORDS`](../enumerations/SelectionMode.md#all_records)
2276
+
2277
+ IDs para selecionar ou o modo de seleção completo.
2278
+
2279
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2280
+
2281
+ Contexto de execução da seleção dos registros do DataUnit.
2321
2282
 
2322
2283
  #### Returns
2323
2284
 
2324
- `Promise`<[`SelectionInfo`](SelectionInfo.md)\>
2285
+ `Promise`\<[`SelectionInfo`](SelectionInfo.md)\>
2325
2286
 
2326
- #### Defined in
2287
+ #### Source
2327
2288
 
2328
- src/dataunit/DataUnit.ts:1065
2289
+ src/dataunit/DataUnit.ts:1104
2329
2290
 
2330
- ___
2291
+ ***
2331
2292
 
2332
- ### setSelectionByIndex
2293
+ ### setSelectionByIndex()
2333
2294
 
2334
- ▸ **setSelectionByIndex**(`selection`, `executionCtx?`): `void`
2295
+ > **setSelectionByIndex**(`selection`, `executionCtx`?): `void`
2335
2296
 
2336
2297
  Seleciona múltiplos registros por índice.
2337
2298
 
2338
2299
  #### Parameters
2339
2300
 
2340
- | Name | Type | Description |
2341
- | :------ | :------ | :------ |
2342
- | `selection` | `number`[] | Índices desejados para a seleção. |
2343
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
2301
+ • **selection**: `number`[]
2302
+
2303
+ Índices desejados para a seleção.
2304
+
2305
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2306
+
2307
+ Contexto de execução da seleção do registro do DataUnit.
2344
2308
 
2345
2309
  #### Returns
2346
2310
 
2347
2311
  `void`
2348
2312
 
2349
- #### Defined in
2313
+ #### Source
2350
2314
 
2351
- src/dataunit/DataUnit.ts:1052
2315
+ src/dataunit/DataUnit.ts:1091
2352
2316
 
2353
- ___
2317
+ ***
2354
2318
 
2355
- ### showField
2319
+ ### showField()
2356
2320
 
2357
- ▸ **showField**(`fieldName`): `void`
2321
+ > **showField**(`fieldName`): `void`
2358
2322
 
2359
2323
  Deixa um campo do DataUnit visível
2360
2324
 
2361
2325
  #### Parameters
2362
2326
 
2363
- | Name | Type | Description |
2364
- | :------ | :------ | :------ |
2365
- | `fieldName` | `string` | nome do campo para ficar visível. |
2327
+ • **fieldName**: `string`
2328
+
2329
+ nome do campo para ficar visível.
2366
2330
 
2367
2331
  #### Returns
2368
2332
 
2369
2333
  `void`
2370
2334
 
2371
- #### Defined in
2335
+ #### Source
2372
2336
 
2373
- src/dataunit/DataUnit.ts:1645
2337
+ src/dataunit/DataUnit.ts:1688
2374
2338
 
2375
- ___
2339
+ ***
2376
2340
 
2377
- ### startChange
2341
+ ### startChange()
2378
2342
 
2379
- ▸ **startChange**(`fieldName`, `waitingChange`): `void`
2343
+ > **startChange**(`fieldName`, `waitingChange`): `void`
2380
2344
 
2381
2345
  Inicia alteração no campo.
2382
2346
 
2383
2347
  #### Parameters
2384
2348
 
2385
- | Name | Type | Description |
2386
- | :------ | :------ | :------ |
2387
- | `fieldName` | `string` | Identificador do campo a ser modificado. |
2388
- | `waitingChange` | [`WaitingChange`](../interfaces/WaitingChange.md) | Informa que uma mudança irá iniciar. |
2349
+ • **fieldName**: `string`
2350
+
2351
+ Identificador do campo a ser modificado.
2352
+
2353
+ • **waitingChange**: [`WaitingChange`](../interfaces/WaitingChange.md)
2354
+
2355
+ Informa que uma mudança irá iniciar.
2389
2356
 
2390
2357
  #### Returns
2391
2358
 
2392
2359
  `void`
2393
2360
 
2394
- #### Defined in
2361
+ #### Source
2395
2362
 
2396
- src/dataunit/DataUnit.ts:993
2363
+ src/dataunit/DataUnit.ts:1032
2397
2364
 
2398
- ___
2365
+ ***
2399
2366
 
2400
- ### subscribe
2367
+ ### subscribe()
2401
2368
 
2402
- ▸ **subscribe**(`observer`): `void`
2369
+ > **subscribe**(`observer`): `void`
2403
2370
 
2404
2371
  Adiciona um novo observer no DataUnit.
2405
2372
  Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
2406
2373
 
2407
2374
  #### Parameters
2408
2375
 
2409
- | Name | Type | Description |
2410
- | :------ | :------ | :------ |
2411
- | `observer` | (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void` | Função que recebe como parâmetro as ações que serão monitoradas. |
2376
+ • **observer**
2377
+
2378
+ Função que recebe como parâmetro as ações que serão monitoradas.
2412
2379
 
2413
2380
  #### Returns
2414
2381
 
2415
2382
  `void`
2416
2383
 
2417
- #### Defined in
2384
+ #### Source
2418
2385
 
2419
- src/dataunit/DataUnit.ts:1503
2386
+ src/dataunit/DataUnit.ts:1542
2420
2387
 
2421
- ___
2388
+ ***
2422
2389
 
2423
- ### toString
2390
+ ### toString()
2424
2391
 
2425
- ▸ **toString**(): `string`
2392
+ > **toString**(): `string`
2426
2393
 
2427
2394
  Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
2428
2395
 
@@ -2432,117 +2399,121 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
2432
2399
 
2433
2400
  - Valor contido na propriedade name.
2434
2401
 
2435
- #### Defined in
2402
+ #### Source
2436
2403
 
2437
- src/dataunit/DataUnit.ts:1391
2404
+ src/dataunit/DataUnit.ts:1430
2438
2405
 
2439
- ___
2406
+ ***
2440
2407
 
2441
- ### undo
2408
+ ### undo()
2442
2409
 
2443
- ▸ **undo**(`executionCtx?`): `void`
2410
+ > **undo**(`executionCtx`?): `void`
2444
2411
 
2445
2412
  Desfaz a última ação.
2446
2413
 
2447
2414
  #### Parameters
2448
2415
 
2449
- | Name | Type | Description |
2450
- | :------ | :------ | :------ |
2451
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de desfazer a última ação. |
2416
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2417
+
2418
+ Contexto de execução de desfazer a última ação.
2452
2419
 
2453
2420
  #### Returns
2454
2421
 
2455
2422
  `void`
2456
2423
 
2457
- #### Defined in
2424
+ #### Source
2458
2425
 
2459
- src/dataunit/DataUnit.ts:1369
2426
+ src/dataunit/DataUnit.ts:1408
2460
2427
 
2461
- ___
2428
+ ***
2462
2429
 
2463
- ### unsubscribe
2430
+ ### unsubscribe()
2464
2431
 
2465
- ▸ **unsubscribe**(`observer`): `void`
2432
+ > **unsubscribe**(`observer`): `void`
2466
2433
 
2467
2434
  Remove um observer existente.
2468
2435
 
2469
2436
  #### Parameters
2470
2437
 
2471
- | Name | Type | Description |
2472
- | :------ | :------ | :------ |
2473
- | `observer` | `Function` | Observer que se deseja remover. |
2438
+ • **observer**: `Function`
2439
+
2440
+ Observer que se deseja remover.
2474
2441
 
2475
2442
  #### Returns
2476
2443
 
2477
2444
  `void`
2478
2445
 
2479
- #### Defined in
2446
+ #### Source
2480
2447
 
2481
- src/dataunit/DataUnit.ts:1514
2448
+ src/dataunit/DataUnit.ts:1553
2482
2449
 
2483
- ___
2450
+ ***
2484
2451
 
2485
- ### updatePageSelection
2452
+ ### updatePageSelection()
2486
2453
 
2487
- ▸ **updatePageSelection**(`selection`, `executionCtx?`): `Promise`<`undefined` \| [`SelectionInfo`](SelectionInfo.md)\>
2454
+ > **updatePageSelection**(`selection`, `executionCtx`?): `Promise`\<`undefined` \| [`SelectionInfo`](SelectionInfo.md)\>
2488
2455
 
2489
2456
  Atualiza a seleção dos registros atuais.
2490
2457
 
2491
2458
  #### Parameters
2492
2459
 
2493
- | Name | Type | Description |
2494
- | :------ | :------ | :------ |
2495
- | `selection` | `string`[] | IDs dos registros selecionados no snapshot atual |
2496
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
2460
+ • **selection**: `string`[]
2461
+
2462
+ IDs dos registros selecionados no snapshot atual
2463
+
2464
+ • **executionCtx?**: [`ExecutionContext`](../interfaces/ExecutionContext.md)
2465
+
2466
+ Contexto de execução da seleção dos registros do DataUnit.
2497
2467
 
2498
2468
  #### Returns
2499
2469
 
2500
- `Promise`<`undefined` \| [`SelectionInfo`](SelectionInfo.md)\>
2470
+ `Promise`\<`undefined` \| [`SelectionInfo`](SelectionInfo.md)\>
2501
2471
 
2502
2472
  - Informações sobre a seleção.
2503
2473
 
2504
- #### Defined in
2474
+ #### Source
2505
2475
 
2506
- src/dataunit/DataUnit.ts:1092
2476
+ src/dataunit/DataUnit.ts:1131
2507
2477
 
2508
- ___
2478
+ ***
2509
2479
 
2510
- ### updatePagination
2480
+ ### updatePagination()
2511
2481
 
2512
- ▸ **updatePagination**(`info`): `Promise`<`boolean`\>
2482
+ > **updatePagination**(`info`): `Promise`\<`boolean`\>
2513
2483
 
2514
2484
  Obtém informações de paginação dos registros.
2515
2485
 
2516
2486
  #### Parameters
2517
2487
 
2518
- | Name | Type |
2519
- | :------ | :------ |
2520
- | `info` | [`PaginationInfo`](../interfaces/PaginationInfo.md) |
2488
+ • **info**: [`PaginationInfo`](../interfaces/PaginationInfo.md)
2521
2489
 
2522
2490
  #### Returns
2523
2491
 
2524
- `Promise`<`boolean`\>
2492
+ `Promise`\<`boolean`\>
2525
2493
 
2526
2494
  - Informações da paginação de registros.
2527
2495
 
2528
- #### Defined in
2496
+ #### Source
2529
2497
 
2530
- src/dataunit/DataUnit.ts:690
2498
+ src/dataunit/DataUnit.ts:729
2531
2499
 
2532
- ___
2500
+ ***
2533
2501
 
2534
- ### validateAndTypeValue
2502
+ ### validateAndTypeValue()
2535
2503
 
2536
- ▸ `Private` **validateAndTypeValue**(`fieldName`, `newValue`): `any`
2504
+ > `private` **validateAndTypeValue**(`fieldName`, `newValue`): `any`
2537
2505
 
2538
2506
  Obtém o valor convertido de acordo com o tipo do campo.
2539
2507
 
2540
2508
  #### Parameters
2541
2509
 
2542
- | Name | Type | Description |
2543
- | :------ | :------ | :------ |
2544
- | `fieldName` | `string` | Identificador do campo. |
2545
- | `newValue` | `any` | Novo valor que será atribuído ao campo pós validação. |
2510
+ • **fieldName**: `string`
2511
+
2512
+ Identificador do campo.
2513
+
2514
+ • **newValue**: `any`
2515
+
2516
+ Novo valor que será atribuído ao campo pós validação.
2546
2517
 
2547
2518
  #### Returns
2548
2519
 
@@ -2550,24 +2521,27 @@ Obtém o valor convertido de acordo com o tipo do campo.
2550
2521
 
2551
2522
  - Novo valor convertido em um tipo valido.
2552
2523
 
2553
- #### Defined in
2524
+ #### Source
2554
2525
 
2555
- src/dataunit/DataUnit.ts:143
2526
+ src/dataunit/DataUnit.ts:170
2556
2527
 
2557
- ___
2528
+ ***
2558
2529
 
2559
- ### valueFromString
2530
+ ### valueFromString()
2560
2531
 
2561
- ▸ **valueFromString**(`fieldName`, `value`): `any`
2532
+ > **valueFromString**(`fieldName`, `value`): `any`
2562
2533
 
2563
2534
  Obtém o valor do campo em seu formato/tipo correto a partir de uma string.
2564
2535
 
2565
2536
  #### Parameters
2566
2537
 
2567
- | Name | Type | Description |
2568
- | :------ | :------ | :------ |
2569
- | `fieldName` | `string` | Nome do campo que terá o tipo identificado para conversão. |
2570
- | `value` | `string` | Texto que será convertido de acordo com o tipo identificado no campo. |
2538
+ • **fieldName**: `string`
2539
+
2540
+ Nome do campo que terá o tipo identificado para conversão.
2541
+
2542
+ • **value**: `string`
2543
+
2544
+ Texto que será convertido de acordo com o tipo identificado no campo.
2571
2545
 
2572
2546
  #### Returns
2573
2547
 
@@ -2575,24 +2549,27 @@ Obtém o valor do campo em seu formato/tipo correto a partir de uma string.
2575
2549
 
2576
2550
  - Valor convertido ou ele mesmo.
2577
2551
 
2578
- #### Defined in
2552
+ #### Source
2579
2553
 
2580
- src/dataunit/DataUnit.ts:581
2554
+ src/dataunit/DataUnit.ts:621
2581
2555
 
2582
- ___
2556
+ ***
2583
2557
 
2584
- ### valueToString
2558
+ ### valueToString()
2585
2559
 
2586
- ▸ **valueToString**(`fieldName`, `value`): `string`
2560
+ > **valueToString**(`fieldName`, `value`): `string`
2587
2561
 
2588
2562
  Converte o valor informado para texto de acordo com o tipo do campo informado.
2589
2563
 
2590
2564
  #### Parameters
2591
2565
 
2592
- | Name | Type | Description |
2593
- | :------ | :------ | :------ |
2594
- | `fieldName` | `string` | Nome do campo utilizado para buscar o tipo de dado com o padrão de conversão para string. |
2595
- | `value` | `any` | Valor a ser convertido. |
2566
+ • **fieldName**: `string`
2567
+
2568
+ Nome do campo utilizado para buscar o tipo de dado com o padrão de conversão para string.
2569
+
2570
+ • **value**: `any`
2571
+
2572
+ Valor a ser convertido.
2596
2573
 
2597
2574
  #### Returns
2598
2575
 
@@ -2600,23 +2577,23 @@ Converte o valor informado para texto de acordo com o tipo do campo informado.
2600
2577
 
2601
2578
  - Valor informado convertido.
2602
2579
 
2603
- #### Defined in
2580
+ #### Source
2604
2581
 
2605
- src/dataunit/DataUnit.ts:596
2582
+ src/dataunit/DataUnit.ts:636
2606
2583
 
2607
- ___
2584
+ ***
2608
2585
 
2609
- ### waitingForChange
2586
+ ### waitingForChange()
2610
2587
 
2611
- ▸ **waitingForChange**(`fieldName`): `boolean`
2588
+ > **waitingForChange**(`fieldName`): `boolean`
2612
2589
 
2613
2590
  Retorna se a alteração no campo já foi concluída ou se ainda está incompleta.
2614
2591
 
2615
2592
  #### Parameters
2616
2593
 
2617
- | Name | Type | Description |
2618
- | :------ | :------ | :------ |
2619
- | `fieldName` | `string` | Identificador do campo a ser verificado. |
2594
+ • **fieldName**: `string`
2595
+
2596
+ Identificador do campo a ser verificado.
2620
2597
 
2621
2598
  #### Returns
2622
2599
 
@@ -2624,6 +2601,6 @@ Retorna se a alteração no campo já foi concluída ou se ainda está incomplet
2624
2601
 
2625
2602
  - Verdadeiro se ainda está pendente.
2626
2603
 
2627
- #### Defined in
2604
+ #### Source
2628
2605
 
2629
- src/dataunit/DataUnit.ts:894
2606
+ src/dataunit/DataUnit.ts:933