@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.41

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