@sankhyalabs/core-docs 5.20.0-dev.2 → 5.20.0-dev.21

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