@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.6

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