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