@sankhyalabs/core-docs 5.15.5 → 5.16.0

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