@sankhyalabs/core-docs 3.1.1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +473 -100
  3. package/classes/DataUnitStorage.md +116 -0
  4. package/classes/DateUtils.md +87 -10
  5. package/classes/MaskFormatter-1.md +25 -14
  6. package/enums/Action.md +11 -0
  7. package/enums/ChangeOperation.md +4 -4
  8. package/enums/DependencyType.md +3 -3
  9. package/enums/SortMode.md +2 -2
  10. package/enums/UserInterface.md +17 -17
  11. package/interfaces/ChildDescriptor.md +41 -0
  12. package/interfaces/ChildLink.md +30 -0
  13. package/interfaces/DUActionInterceptor.md +1 -1
  14. package/interfaces/FieldDescriptor.md +11 -11
  15. package/interfaces/Filter.md +3 -3
  16. package/interfaces/PageRequest.md +3 -3
  17. package/interfaces/QuickFilter.md +2 -2
  18. package/interfaces/Record.md +24 -2
  19. package/interfaces/SavedRecord.md +33 -3
  20. package/interfaces/Sort.md +3 -3
  21. package/interfaces/SortingProvider.md +1 -1
  22. package/interfaces/UnitMetadata.md +1 -1
  23. package/interfaces/WaitingChange.md +3 -3
  24. package/modules/MaskFormatter.md +4 -4
  25. package/modules.md +3 -0
  26. package/package.json +1 -1
package/classes/DataUnit.md CHANGED
@@ -19,9 +19,9 @@
19
19
  - [\_observers](DataUnit.md#_observers)
20
20
  - [\_pageSize](DataUnit.md#_pagesize)
21
21
  - [\_parentDataUnit](DataUnit.md#_parentdataunit)
22
- - [\_parentSelectedRecordID](DataUnit.md#_parentselectedrecordid)
23
22
  - [\_sortingProvider](DataUnit.md#_sortingprovider)
24
23
  - [\_stateManager](DataUnit.md#_statemanager)
24
+ - [\_uuid](DataUnit.md#_uuid)
25
25
  - [dataLoader](DataUnit.md#dataloader)
26
26
  - [metadataLoader](DataUnit.md#metadataloader)
27
27
  - [recordLoader](DataUnit.md#recordloader)
@@ -30,6 +30,7 @@
30
30
 
31
31
  ### Accessors
32
32
 
33
+ - [dataUnitId](DataUnit.md#dataunitid)
33
34
  - [metadata](DataUnit.md#metadata)
34
35
  - [name](DataUnit.md#name)
35
36
  - [pageSize](DataUnit.md#pagesize)
@@ -41,43 +42,59 @@
41
42
  - [addFilterProvider](DataUnit.md#addfilterprovider)
42
43
  - [addInterceptor](DataUnit.md#addinterceptor)
43
44
  - [addRecord](DataUnit.md#addrecord)
45
+ - [buildChangesToSave](DataUnit.md#buildchangestosave)
46
+ - [buildChangesToSaveFromChild](DataUnit.md#buildchangestosavefromchild)
44
47
  - [canRedo](DataUnit.md#canredo)
45
48
  - [canUndo](DataUnit.md#canundo)
46
49
  - [cancelEdition](DataUnit.md#canceledition)
47
50
  - [cancelWaitingChange](DataUnit.md#cancelwaitingchange)
51
+ - [childrenIsDirty](DataUnit.md#childrenisdirty)
48
52
  - [clearDataUnit](DataUnit.md#cleardataunit)
49
53
  - [copySelected](DataUnit.md#copyselected)
54
+ - [disableField](DataUnit.md#disablefield)
50
55
  - [dispatchAction](DataUnit.md#dispatchaction)
51
56
  - [doDispatchAction](DataUnit.md#dodispatchaction)
57
+ - [enableField](DataUnit.md#enablefield)
52
58
  - [executeLoadData](DataUnit.md#executeloaddata)
59
+ - [getAllChangesToSave](DataUnit.md#getallchangestosave)
53
60
  - [getChildDataunit](DataUnit.md#getchilddataunit)
54
61
  - [getChildInfo](DataUnit.md#getchildinfo)
55
62
  - [getField](DataUnit.md#getfield)
56
63
  - [getFieldValue](DataUnit.md#getfieldvalue)
57
64
  - [getFielterProviderKey](DataUnit.md#getfielterproviderkey)
58
65
  - [getFilters](DataUnit.md#getfilters)
66
+ - [getFormattedValue](DataUnit.md#getformattedvalue)
59
67
  - [getModifiedRecords](DataUnit.md#getmodifiedrecords)
60
68
  - [getPaginationInfo](DataUnit.md#getpaginationinfo)
69
+ - [getParentRecordId](DataUnit.md#getparentrecordid)
70
+ - [getRecordsByDataUnit](DataUnit.md#getrecordsbydataunit)
61
71
  - [getSelectedRecord](DataUnit.md#getselectedrecord)
62
72
  - [getSelectedRecords](DataUnit.md#getselectedrecords)
63
73
  - [getSelection](DataUnit.md#getselection)
64
74
  - [getSort](DataUnit.md#getsort)
65
75
  - [gotoPage](DataUnit.md#gotopage)
76
+ - [hasCopiedRecord](DataUnit.md#hascopiedrecord)
66
77
  - [hasDirtyRecords](DataUnit.md#hasdirtyrecords)
78
+ - [hasNewRecord](DataUnit.md#hasnewrecord)
67
79
  - [hasNext](DataUnit.md#hasnext)
68
80
  - [hasPrevious](DataUnit.md#hasprevious)
81
+ - [hideField](DataUnit.md#hidefield)
69
82
  - [intercept](DataUnit.md#intercept)
70
83
  - [isDirty](DataUnit.md#isdirty)
71
84
  - [isNewRecord](DataUnit.md#isnewrecord)
85
+ - [isSameRequest](DataUnit.md#issamerequest)
72
86
  - [loadData](DataUnit.md#loaddata)
73
87
  - [loadMetadata](DataUnit.md#loadmetadata)
74
88
  - [nextPage](DataUnit.md#nextpage)
75
89
  - [nextRecord](DataUnit.md#nextrecord)
90
+ - [notifySavingData](DataUnit.md#notifysavingdata)
76
91
  - [onDataUnitParentEvent](DataUnit.md#ondataunitparentevent)
77
92
  - [previousPage](DataUnit.md#previouspage)
78
93
  - [previousRecord](DataUnit.md#previousrecord)
79
94
  - [redo](DataUnit.md#redo)
95
+ - [release](DataUnit.md#release)
80
96
  - [reloadCurrentRecord](DataUnit.md#reloadcurrentrecord)
97
+ - [removeChildDataunit](DataUnit.md#removechilddataunit)
81
98
  - [removeInterceptor](DataUnit.md#removeinterceptor)
82
99
  - [removeRecords](DataUnit.md#removerecords)
83
100
  - [removeSelectedRecords](DataUnit.md#removeselectedrecords)
@@ -87,6 +104,7 @@
87
104
  - [setFieldValue](DataUnit.md#setfieldvalue)
88
105
  - [setSelection](DataUnit.md#setselection)
89
106
  - [setSelectionByIndex](DataUnit.md#setselectionbyindex)
107
+ - [showField](DataUnit.md#showfield)
90
108
  - [startChange](DataUnit.md#startchange)
91
109
  - [subscribe](DataUnit.md#subscribe)
92
110
  - [toString](DataUnit.md#tostring)
@@ -101,18 +119,18 @@
101
119
 
102
120
  ### constructor
103
121
 
104
- • **new DataUnit**(`name`, `parentDataUnit?`)
122
+ • **new DataUnit**(`name?`, `parentDataUnit?`)
105
123
 
106
124
  #### Parameters
107
125
 
108
- | Name | Type |
109
- | :------ | :------ |
110
- | `name` | `string` |
111
- | `parentDataUnit?` | [`DataUnit`](DataUnit.md) |
126
+ | Name | Type | Default value |
127
+ | :------ | :------ | :------ |
128
+ | `name` | `string` | `DEFAULT_DATAUNIT_NAME` |
129
+ | `parentDataUnit?` | [`DataUnit`](DataUnit.md) | `undefined` |
112
130
 
113
131
  #### Defined in
114
132
 
115
- src/dataunit/DataUnit.ts:46
133
+ src/dataunit/DataUnit.ts:51
116
134
 
117
135
  ## Properties
118
136
 
@@ -122,7 +140,7 @@ src/dataunit/DataUnit.ts:46
122
140
 
123
141
  #### Defined in
124
142
 
125
- src/dataunit/DataUnit.ts:36
143
+ src/dataunit/DataUnit.ts:42
126
144
 
127
145
  ___
128
146
 
@@ -132,7 +150,7 @@ ___
132
150
 
133
151
  #### Defined in
134
152
 
135
- src/dataunit/DataUnit.ts:32
153
+ src/dataunit/DataUnit.ts:38
136
154
 
137
155
  ___
138
156
 
@@ -142,7 +160,7 @@ ___
142
160
 
143
161
  #### Defined in
144
162
 
145
- src/dataunit/DataUnit.ts:34
163
+ src/dataunit/DataUnit.ts:40
146
164
 
147
165
  ___
148
166
 
@@ -152,7 +170,7 @@ ___
152
170
 
153
171
  #### Defined in
154
172
 
155
- src/dataunit/DataUnit.ts:29
173
+ src/dataunit/DataUnit.ts:35
156
174
 
157
175
  ___
158
176
 
@@ -162,7 +180,7 @@ ___
162
180
 
163
181
  #### Defined in
164
182
 
165
- src/dataunit/DataUnit.ts:30
183
+ src/dataunit/DataUnit.ts:36
166
184
 
167
185
  ___
168
186
 
@@ -172,7 +190,7 @@ ___
172
190
 
173
191
  #### Defined in
174
192
 
175
- src/dataunit/DataUnit.ts:35
193
+ src/dataunit/DataUnit.ts:41
176
194
 
177
195
  ___
178
196
 
@@ -182,37 +200,37 @@ ___
182
200
 
183
201
  #### Defined in
184
202
 
185
- src/dataunit/DataUnit.ts:37
203
+ src/dataunit/DataUnit.ts:43
186
204
 
187
205
  ___
188
206
 
189
- ### \_parentSelectedRecordID
207
+ ### \_sortingProvider
190
208
 
191
- • `Private` **\_parentSelectedRecordID**: `undefined` \| `string`
209
+ • `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
192
210
 
193
211
  #### Defined in
194
212
 
195
- src/dataunit/DataUnit.ts:38
213
+ src/dataunit/DataUnit.ts:37
196
214
 
197
215
  ___
198
216
 
199
- ### \_sortingProvider
217
+ ### \_stateManager
200
218
 
201
- • `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
219
+ • `Private` **\_stateManager**: `default`
202
220
 
203
221
  #### Defined in
204
222
 
205
- src/dataunit/DataUnit.ts:31
223
+ src/dataunit/DataUnit.ts:39
206
224
 
207
225
  ___
208
226
 
209
- ### \_stateManager
227
+ ### \_uuid
210
228
 
211
- • `Private` **\_stateManager**: `default`
229
+ • `Private` **\_uuid**: `string`
212
230
 
213
231
  #### Defined in
214
232
 
215
- src/dataunit/DataUnit.ts:33
233
+ src/dataunit/DataUnit.ts:34
216
234
 
217
235
  ___
218
236
 
@@ -237,7 +255,7 @@ ___
237
255
 
238
256
  #### Defined in
239
257
 
240
- src/dataunit/DataUnit.ts:41
258
+ src/dataunit/DataUnit.ts:46
241
259
 
242
260
  ___
243
261
 
@@ -261,7 +279,7 @@ ___
261
279
 
262
280
  #### Defined in
263
281
 
264
- src/dataunit/DataUnit.ts:40
282
+ src/dataunit/DataUnit.ts:45
265
283
 
266
284
  ___
267
285
 
@@ -286,7 +304,7 @@ ___
286
304
 
287
305
  #### Defined in
288
306
 
289
- src/dataunit/DataUnit.ts:44
307
+ src/dataunit/DataUnit.ts:49
290
308
 
291
309
  ___
292
310
 
@@ -311,7 +329,7 @@ ___
311
329
 
312
330
  #### Defined in
313
331
 
314
- src/dataunit/DataUnit.ts:43
332
+ src/dataunit/DataUnit.ts:48
315
333
 
316
334
  ___
317
335
 
@@ -336,10 +354,24 @@ ___
336
354
 
337
355
  #### Defined in
338
356
 
339
- src/dataunit/DataUnit.ts:42
357
+ src/dataunit/DataUnit.ts:47
340
358
 
341
359
  ## Accessors
342
360
 
361
+ ### dataUnitId
362
+
363
+ • `get` **dataUnitId**(): `string`
364
+
365
+ #### Returns
366
+
367
+ `string`
368
+
369
+ #### Defined in
370
+
371
+ src/dataunit/DataUnit.ts:89
372
+
373
+ ___
374
+
343
375
  ### metadata
344
376
 
345
377
  • `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
@@ -352,7 +384,7 @@ Obtém os metadados do DataUnit.
352
384
 
353
385
  #### Defined in
354
386
 
355
- src/dataunit/DataUnit.ts:494
387
+ src/dataunit/DataUnit.ts:619
356
388
 
357
389
  • `set` **metadata**(`md`): `void`
358
390
 
@@ -370,7 +402,7 @@ Define a propriedade metadata da instância da classe com um novo valor e chama
370
402
 
371
403
  #### Defined in
372
404
 
373
- src/dataunit/DataUnit.ts:485
405
+ src/dataunit/DataUnit.ts:610
374
406
 
375
407
  ___
376
408
 
@@ -388,7 +420,7 @@ Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uni
388
420
 
389
421
  #### Defined in
390
422
 
391
- src/dataunit/DataUnit.ts:79
423
+ src/dataunit/DataUnit.ts:100
392
424
 
393
425
  ___
394
426
 
@@ -406,7 +438,7 @@ Obtém a quantidade de registros que está sendo exibido por página.
406
438
 
407
439
  #### Defined in
408
440
 
409
- src/dataunit/DataUnit.ts:555
441
+ src/dataunit/DataUnit.ts:680
410
442
 
411
443
  • `set` **pageSize**(`size`): `void`
412
444
 
@@ -424,7 +456,7 @@ Define a quantidade de registros que será exibido por página.
424
456
 
425
457
  #### Defined in
426
458
 
427
- src/dataunit/DataUnit.ts:544
459
+ src/dataunit/DataUnit.ts:669
428
460
 
429
461
  ___
430
462
 
@@ -442,7 +474,7 @@ Obtém todos os registros atuais.
442
474
 
443
475
  #### Defined in
444
476
 
445
- src/dataunit/DataUnit.ts:532
477
+ src/dataunit/DataUnit.ts:657
446
478
 
447
479
  • `set` **records**(`records`): `void`
448
480
 
@@ -460,7 +492,7 @@ Define a propriedade records da instância da classe com um novo valor e chama o
460
492
 
461
493
  #### Defined in
462
494
 
463
- src/dataunit/DataUnit.ts:521
495
+ src/dataunit/DataUnit.ts:646
464
496
 
465
497
  ___
466
498
 
@@ -482,7 +514,7 @@ Define a lógica de ordenação dos registros.
482
514
 
483
515
  #### Defined in
484
516
 
485
- src/dataunit/DataUnit.ts:476
517
+ src/dataunit/DataUnit.ts:601
486
518
 
487
519
  ## Methods
488
520
 
@@ -504,7 +536,7 @@ Adiciona um FilterProvider.
504
536
 
505
537
  #### Defined in
506
538
 
507
- src/dataunit/DataUnit.ts:455
539
+ src/dataunit/DataUnit.ts:580
508
540
 
509
541
  ___
510
542
 
@@ -526,7 +558,7 @@ Adiciona um interceptor correspondente a uma ação do DataUnit para fazer um pr
526
558
 
527
559
  #### Defined in
528
560
 
529
- src/dataunit/DataUnit.ts:433
561
+ src/dataunit/DataUnit.ts:558
530
562
 
531
563
  ___
532
564
 
@@ -548,7 +580,46 @@ Adiciona um novo registro.
548
580
 
549
581
  #### Defined in
550
582
 
551
- src/dataunit/DataUnit.ts:590
583
+ src/dataunit/DataUnit.ts:715
584
+
585
+ ___
586
+
587
+ ### buildChangesToSave
588
+
589
+ ▸ **buildChangesToSave**(): [`Change`](Change.md)[]
590
+
591
+ Retorna as alterações a serem salvas no DataUnit atual.
592
+
593
+ #### Returns
594
+
595
+ [`Change`](Change.md)[]
596
+
597
+ - Mudanças realizadas no DataUnit atual
598
+
599
+ #### Defined in
600
+
601
+ src/dataunit/DataUnit.ts:400
602
+
603
+ ___
604
+
605
+ ### buildChangesToSaveFromChild
606
+
607
+ ▸ **buildChangesToSaveFromChild**(`allChanges`, `dataUnit`): `void`
608
+
609
+ #### Parameters
610
+
611
+ | Name | Type |
612
+ | :------ | :------ |
613
+ | `allChanges` | [`Change`](Change.md)[] |
614
+ | `dataUnit` | [`DataUnit`](DataUnit.md) |
615
+
616
+ #### Returns
617
+
618
+ `void`
619
+
620
+ #### Defined in
621
+
622
+ src/dataunit/DataUnit.ts:404
552
623
 
553
624
  ___
554
625
 
@@ -566,7 +637,7 @@ Verdadeiro se for possível refazer a ação.
566
637
 
567
638
  #### Defined in
568
639
 
569
- src/dataunit/DataUnit.ts:930
640
+ src/dataunit/DataUnit.ts:1132
570
641
 
571
642
  ___
572
643
 
@@ -584,13 +655,13 @@ Verdadeiro se for possível desfazer a ação.
584
655
 
585
656
  #### Defined in
586
657
 
587
- src/dataunit/DataUnit.ts:919
658
+ src/dataunit/DataUnit.ts:1121
588
659
 
589
660
  ___
590
661
 
591
662
  ### cancelEdition
592
663
 
593
- ▸ **cancelEdition**(`executionCtx?`): `void`
664
+ ▸ **cancelEdition**(`executionCtx?`, `fromParent?`): `Promise`<`void`\>
594
665
 
595
666
  Cancela edição do registro atual.
596
667
 
@@ -599,14 +670,15 @@ Cancela edição do registro atual.
599
670
  | Name | Type | Description |
600
671
  | :------ | :------ | :------ |
601
672
  | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do cancelamento da seleção dos registros. |
673
+ | `fromParent?` | `boolean` | - |
602
674
 
603
675
  #### Returns
604
676
 
605
- `void`
677
+ `Promise`<`void`\>
606
678
 
607
679
  #### Defined in
608
680
 
609
- src/dataunit/DataUnit.ts:839
681
+ src/dataunit/DataUnit.ts:990
610
682
 
611
683
  ___
612
684
 
@@ -628,7 +700,25 @@ Cancela o início de uma alteração no campo.
628
700
 
629
701
  #### Defined in
630
702
 
631
- src/dataunit/DataUnit.ts:672
703
+ src/dataunit/DataUnit.ts:823
704
+
705
+ ___
706
+
707
+ ### childrenIsDirty
708
+
709
+ ▸ `Private` **childrenIsDirty**(): `boolean`
710
+
711
+ Retorna se existe algum DataUnit detail com alterações pendentes.
712
+
713
+ #### Returns
714
+
715
+ `boolean`
716
+
717
+ Verdadeiro se existir alterações pendentes em algum DataUnit detail.
718
+
719
+ #### Defined in
720
+
721
+ src/dataunit/DataUnit.ts:1017
632
722
 
633
723
  ___
634
724
 
@@ -644,7 +734,7 @@ Limpa todos os registros do DataUnit
644
734
 
645
735
  #### Defined in
646
736
 
647
- src/dataunit/DataUnit.ts:773
737
+ src/dataunit/DataUnit.ts:924
648
738
 
649
739
  ___
650
740
 
@@ -666,7 +756,29 @@ Efetua a cópia do registro selecionado.
666
756
 
667
757
  #### Defined in
668
758
 
669
- src/dataunit/DataUnit.ts:601
759
+ src/dataunit/DataUnit.ts:726
760
+
761
+ ___
762
+
763
+ ### disableField
764
+
765
+ ▸ **disableField**(`fieldName`): `void`
766
+
767
+ Desabilita um campo do DataUnit
768
+
769
+ #### Parameters
770
+
771
+ | Name | Type | Description |
772
+ | :------ | :------ | :------ |
773
+ | `fieldName` | `string` | nome do campo para ficar desabilitado. |
774
+
775
+ #### Returns
776
+
777
+ `void`
778
+
779
+ #### Defined in
780
+
781
+ src/dataunit/DataUnit.ts:1367
670
782
 
671
783
  ___
672
784
 
@@ -692,7 +804,7 @@ Lança ação do DataUnit para que sejam processadas.
692
804
 
693
805
  #### Defined in
694
806
 
695
- src/dataunit/DataUnit.ts:980
807
+ src/dataunit/DataUnit.ts:1182
696
808
 
697
809
  ___
698
810
 
@@ -714,13 +826,35 @@ Processa as ações no DataUnit e notifica os observers.
714
826
 
715
827
  #### Defined in
716
828
 
717
- src/dataunit/DataUnit.ts:1028
829
+ src/dataunit/DataUnit.ts:1230
830
+
831
+ ___
832
+
833
+ ### enableField
834
+
835
+ ▸ **enableField**(`fieldName`): `void`
836
+
837
+ Habilita um campo do DataUnit
838
+
839
+ #### Parameters
840
+
841
+ | Name | Type | Description |
842
+ | :------ | :------ | :------ |
843
+ | `fieldName` | `string` | nome do campo para ser habilitado. |
844
+
845
+ #### Returns
846
+
847
+ `void`
848
+
849
+ #### Defined in
850
+
851
+ src/dataunit/DataUnit.ts:1352
718
852
 
719
853
  ___
720
854
 
721
855
  ### executeLoadData
722
856
 
723
- ▸ `Private` **executeLoadData**(`request`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
857
+ ▸ `Private` **executeLoadData**(`request`, `executionCtx?`, `checkLastFilter?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
724
858
 
725
859
  Executa o carregamento dos registros.
726
860
 
@@ -730,6 +864,7 @@ Executa o carregamento dos registros.
730
864
  | :------ | :------ | :------ |
731
865
  | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) | Dados da requisição para carregamento dos registros. |
732
866
  | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
867
+ | `checkLastFilter?` | `boolean` | Habilita a verificação da última requisição, evitando carga desnecessária. |
733
868
 
734
869
  #### Returns
735
870
 
@@ -739,7 +874,25 @@ Executa o carregamento dos registros.
739
874
 
740
875
  #### Defined in
741
876
 
742
- src/dataunit/DataUnit.ts:144
877
+ src/dataunit/DataUnit.ts:166
878
+
879
+ ___
880
+
881
+ ### getAllChangesToSave
882
+
883
+ ▸ **getAllChangesToSave**(): [`Change`](Change.md)[]
884
+
885
+ Retorna todas as alterações do DataUnit a serem salvas, incluindo no nível Master e Detail.
886
+
887
+ #### Returns
888
+
889
+ [`Change`](Change.md)[]
890
+
891
+ - Todas as mudanças realizadas no DataUnit, tanto Master quanto Detail;
892
+
893
+ #### Defined in
894
+
895
+ src/dataunit/DataUnit.ts:422
743
896
 
744
897
  ___
745
898
 
@@ -761,13 +914,13 @@ Cria um dataunit filho.
761
914
 
762
915
  #### Defined in
763
916
 
764
- src/dataunit/DataUnit.ts:1050
917
+ src/dataunit/DataUnit.ts:1253
765
918
 
766
919
  ___
767
920
 
768
921
  ### getChildInfo
769
922
 
770
- ▸ **getChildInfo**(`name`): `undefined` \| `ChildDescriptor`
923
+ ▸ **getChildInfo**(`name`): `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
771
924
 
772
925
  Obtém informações da ligação para um DataUnit filho.
773
926
 
@@ -779,13 +932,13 @@ Obtém informações da ligação para um DataUnit filho.
779
932
 
780
933
  #### Returns
781
934
 
782
- `undefined` \| `ChildDescriptor`
935
+ `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
783
936
 
784
937
  - As informações sobre a ligação solicitada. Pode retornar undefined.
785
938
 
786
939
  #### Defined in
787
940
 
788
- src/dataunit/DataUnit.ts:507
941
+ src/dataunit/DataUnit.ts:632
789
942
 
790
943
  ___
791
944
 
@@ -809,7 +962,7 @@ Obtém metadados de um campo específico.
809
962
 
810
963
  #### Defined in
811
964
 
812
- src/dataunit/DataUnit.ts:579
965
+ src/dataunit/DataUnit.ts:704
813
966
 
814
967
  ___
815
968
 
@@ -833,7 +986,7 @@ Obtém valor do campo desejado.
833
986
 
834
987
  #### Defined in
835
988
 
836
- src/dataunit/DataUnit.ts:630
989
+ src/dataunit/DataUnit.ts:781
837
990
 
838
991
  ___
839
992
 
@@ -857,7 +1010,7 @@ Obtém chave única para identificação do FilterProvider.
857
1010
 
858
1011
  #### Defined in
859
1012
 
860
- src/dataunit/DataUnit.ts:127
1013
+ src/dataunit/DataUnit.ts:148
861
1014
 
862
1015
  ___
863
1016
 
@@ -875,7 +1028,34 @@ Obtém todos os filtros de dados.
875
1028
 
876
1029
  #### Defined in
877
1030
 
878
- src/dataunit/DataUnit.ts:1121
1031
+ src/dataunit/DataUnit.ts:1335
1032
+
1033
+ ___
1034
+
1035
+ ### getFormattedValue
1036
+
1037
+ ▸ **getFormattedValue**(`fieldName`): `string`
1038
+
1039
+ Formata o valor do campo considerando as informações do descriptor.
1040
+ Diferente do método "valueToString" que retorna o dado em valor textual,
1041
+ getFormattedValue retorna uma informação amigável ao usuário, geralmente
1042
+ usada na interface.
1043
+
1044
+ #### Parameters
1045
+
1046
+ | Name | Type | Description |
1047
+ | :------ | :------ | :------ |
1048
+ | `fieldName` | `string` | Nome do campo utilizado do qual se quer obter valor. |
1049
+
1050
+ #### Returns
1051
+
1052
+ `string`
1053
+
1054
+ - Valor formatado.
1055
+
1056
+ #### Defined in
1057
+
1058
+ src/dataunit/DataUnit.ts:540
879
1059
 
880
1060
  ___
881
1061
 
@@ -893,7 +1073,7 @@ Obtém os registros modificados e ainda não salvos no DataUnit.
893
1073
 
894
1074
  #### Defined in
895
1075
 
896
- src/dataunit/DataUnit.ts:566
1076
+ src/dataunit/DataUnit.ts:691
897
1077
 
898
1078
  ___
899
1079
 
@@ -911,7 +1091,41 @@ Obtém informações de paginação dos registros.
911
1091
 
912
1092
  #### Defined in
913
1093
 
914
- src/dataunit/DataUnit.ts:465
1094
+ src/dataunit/DataUnit.ts:590
1095
+
1096
+ ___
1097
+
1098
+ ### getParentRecordId
1099
+
1100
+ ▸ `Private` **getParentRecordId**(): `undefined` \| `string`
1101
+
1102
+ #### Returns
1103
+
1104
+ `undefined` \| `string`
1105
+
1106
+ #### Defined in
1107
+
1108
+ src/dataunit/DataUnit.ts:754
1109
+
1110
+ ___
1111
+
1112
+ ### getRecordsByDataUnit
1113
+
1114
+ ▸ `Private` **getRecordsByDataUnit**(`records`): `Map`<`string`, [`Record`](../interfaces/Record.md)[]\>
1115
+
1116
+ #### Parameters
1117
+
1118
+ | Name | Type |
1119
+ | :------ | :------ |
1120
+ | `records` | [`Record`](../interfaces/Record.md)[] |
1121
+
1122
+ #### Returns
1123
+
1124
+ `Map`<`string`, [`Record`](../interfaces/Record.md)[]\>
1125
+
1126
+ #### Defined in
1127
+
1128
+ src/dataunit/DataUnit.ts:733
915
1129
 
916
1130
  ___
917
1131
 
@@ -929,7 +1143,7 @@ Retorna apenas um registro selecionado no Dataunit
929
1143
 
930
1144
  #### Defined in
931
1145
 
932
- src/dataunit/DataUnit.ts:760
1146
+ src/dataunit/DataUnit.ts:911
933
1147
 
934
1148
  ___
935
1149
 
@@ -947,7 +1161,7 @@ Obtém todos os registros selecionados.
947
1161
 
948
1162
  #### Defined in
949
1163
 
950
- src/dataunit/DataUnit.ts:745
1164
+ src/dataunit/DataUnit.ts:896
951
1165
 
952
1166
  ___
953
1167
 
@@ -965,7 +1179,7 @@ Obtém registros selecionados.
965
1179
 
966
1180
  #### Defined in
967
1181
 
968
- src/dataunit/DataUnit.ts:683
1182
+ src/dataunit/DataUnit.ts:834
969
1183
 
970
1184
  ___
971
1185
 
@@ -983,7 +1197,7 @@ Obtém a estrutura de ordenação das colunas dos dados.
983
1197
 
984
1198
  #### Defined in
985
1199
 
986
- src/dataunit/DataUnit.ts:1110
1200
+ src/dataunit/DataUnit.ts:1324
987
1201
 
988
1202
  ___
989
1203
 
@@ -1008,7 +1222,25 @@ Alterna entre os registros por número de página.
1008
1222
 
1009
1223
  #### Defined in
1010
1224
 
1011
- src/dataunit/DataUnit.ts:236
1225
+ src/dataunit/DataUnit.ts:275
1226
+
1227
+ ___
1228
+
1229
+ ### hasCopiedRecord
1230
+
1231
+ ▸ **hasCopiedRecord**(): `boolean`
1232
+
1233
+ Retorna se existe pelo menos um registro novo.
1234
+
1235
+ #### Returns
1236
+
1237
+ `boolean`
1238
+
1239
+ Verdadeiro se algum registro foi adicionado.
1240
+
1241
+ #### Defined in
1242
+
1243
+ src/dataunit/DataUnit.ts:1101
1012
1244
 
1013
1245
  ___
1014
1246
 
@@ -1026,7 +1258,25 @@ Verdadeiro se existir alterações de registros pendentes.
1026
1258
 
1027
1259
  #### Defined in
1028
1260
 
1029
- src/dataunit/DataUnit.ts:861
1261
+ src/dataunit/DataUnit.ts:1031
1262
+
1263
+ ___
1264
+
1265
+ ### hasNewRecord
1266
+
1267
+ ▸ **hasNewRecord**(): `boolean`
1268
+
1269
+ Retorna se existe pelo menos um registro novo.
1270
+
1271
+ #### Returns
1272
+
1273
+ `boolean`
1274
+
1275
+ Verdadeiro se algum registro foi adicionado.
1276
+
1277
+ #### Defined in
1278
+
1279
+ src/dataunit/DataUnit.ts:1089
1030
1280
 
1031
1281
  ___
1032
1282
 
@@ -1044,7 +1294,7 @@ Verdadeiro se existir uma próxima página.
1044
1294
 
1045
1295
  #### Defined in
1046
1296
 
1047
- src/dataunit/DataUnit.ts:872
1297
+ src/dataunit/DataUnit.ts:1042
1048
1298
 
1049
1299
  ___
1050
1300
 
@@ -1062,7 +1312,29 @@ Verdadeiro se existir uma página anterior.
1062
1312
 
1063
1313
  #### Defined in
1064
1314
 
1065
- src/dataunit/DataUnit.ts:887
1315
+ src/dataunit/DataUnit.ts:1057
1316
+
1317
+ ___
1318
+
1319
+ ### hideField
1320
+
1321
+ ▸ **hideField**(`fieldName`): `void`
1322
+
1323
+ Deixa um campo do DataUnit invisível
1324
+
1325
+ #### Parameters
1326
+
1327
+ | Name | Type | Description |
1328
+ | :------ | :------ | :------ |
1329
+ | `fieldName` | `string` | nome do campo para ficar invisível. |
1330
+
1331
+ #### Returns
1332
+
1333
+ `void`
1334
+
1335
+ #### Defined in
1336
+
1337
+ src/dataunit/DataUnit.ts:1382
1066
1338
 
1067
1339
  ___
1068
1340
 
@@ -1087,7 +1359,7 @@ Notifica os interceptors de que uma ação foi executada, para que cada intercep
1087
1359
 
1088
1360
  #### Defined in
1089
1361
 
1090
- src/dataunit/DataUnit.ts:1011
1362
+ src/dataunit/DataUnit.ts:1213
1091
1363
 
1092
1364
  ___
1093
1365
 
@@ -1105,7 +1377,7 @@ Verdadeiro se existir alterações pendentes.
1105
1377
 
1106
1378
  #### Defined in
1107
1379
 
1108
- src/dataunit/DataUnit.ts:850
1380
+ src/dataunit/DataUnit.ts:1006
1109
1381
 
1110
1382
  ___
1111
1383
 
@@ -1129,13 +1401,33 @@ Verdadeiro se o id solicitado é de um registro novo.
1129
1401
 
1130
1402
  #### Defined in
1131
1403
 
1132
- src/dataunit/DataUnit.ts:903
1404
+ src/dataunit/DataUnit.ts:1073
1405
+
1406
+ ___
1407
+
1408
+ ### isSameRequest
1409
+
1410
+ ▸ `Private` **isSameRequest**(`request`): `boolean`
1411
+
1412
+ #### Parameters
1413
+
1414
+ | Name | Type |
1415
+ | :------ | :------ |
1416
+ | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
1417
+
1418
+ #### Returns
1419
+
1420
+ `boolean`
1421
+
1422
+ #### Defined in
1423
+
1424
+ src/dataunit/DataUnit.ts:196
1133
1425
 
1134
1426
  ___
1135
1427
 
1136
1428
  ### loadData
1137
1429
 
1138
- ▸ **loadData**(`quickFilter?`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1430
+ ▸ **loadData**(`quickFilter?`, `executionCtx?`, `checkLastFilter?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1139
1431
 
1140
1432
  Carrega os registros do DataUnit.
1141
1433
 
@@ -1145,6 +1437,7 @@ Carrega os registros do DataUnit.
1145
1437
  | :------ | :------ | :------ |
1146
1438
  | `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) | Filtros a serem aplicados. |
1147
1439
  | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros. |
1440
+ | `checkLastFilter?` | `boolean` | Habilita a verificação da última requisição, evitando carga desnecessária. |
1148
1441
 
1149
1442
  #### Returns
1150
1443
 
@@ -1154,7 +1447,7 @@ Carrega os registros do DataUnit.
1154
1447
 
1155
1448
  #### Defined in
1156
1449
 
1157
- src/dataunit/DataUnit.ts:200
1450
+ src/dataunit/DataUnit.ts:240
1158
1451
 
1159
1452
  ___
1160
1453
 
@@ -1178,7 +1471,7 @@ Carrega os metadados do DataUnit.
1178
1471
 
1179
1472
  #### Defined in
1180
1473
 
1181
- src/dataunit/DataUnit.ts:172
1474
+ src/dataunit/DataUnit.ts:211
1182
1475
 
1183
1476
  ___
1184
1477
 
@@ -1202,7 +1495,7 @@ Vai para os registros da página seguinte.
1202
1495
 
1203
1496
  #### Defined in
1204
1497
 
1205
- src/dataunit/DataUnit.ts:265
1498
+ src/dataunit/DataUnit.ts:304
1206
1499
 
1207
1500
  ___
1208
1501
 
@@ -1224,7 +1517,27 @@ Seleciona o próximo registro.
1224
1517
 
1225
1518
  #### Defined in
1226
1519
 
1227
- src/dataunit/DataUnit.ts:785
1520
+ src/dataunit/DataUnit.ts:936
1521
+
1522
+ ___
1523
+
1524
+ ### notifySavingData
1525
+
1526
+ ▸ `Private` **notifySavingData**(`executionCtx?`): `Promise`<`boolean`\>
1527
+
1528
+ #### Parameters
1529
+
1530
+ | Name | Type |
1531
+ | :------ | :------ |
1532
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1533
+
1534
+ #### Returns
1535
+
1536
+ `Promise`<`boolean`\>
1537
+
1538
+ #### Defined in
1539
+
1540
+ src/dataunit/DataUnit.ts:322
1228
1541
 
1229
1542
  ___
1230
1543
 
@@ -1246,7 +1559,7 @@ Trata as Actions do DataUnit Parent
1246
1559
 
1247
1560
  #### Defined in
1248
1561
 
1249
- src/dataunit/DataUnit.ts:104
1562
+ src/dataunit/DataUnit.ts:125
1250
1563
 
1251
1564
  ___
1252
1565
 
@@ -1270,7 +1583,7 @@ Vai para os registros da página anterior.
1270
1583
 
1271
1584
  #### Defined in
1272
1585
 
1273
- src/dataunit/DataUnit.ts:278
1586
+ src/dataunit/DataUnit.ts:317
1274
1587
 
1275
1588
  ___
1276
1589
 
@@ -1292,7 +1605,7 @@ Seleciona o registro anterior.
1292
1605
 
1293
1606
  #### Defined in
1294
1607
 
1295
- src/dataunit/DataUnit.ts:812
1608
+ src/dataunit/DataUnit.ts:963
1296
1609
 
1297
1610
  ___
1298
1611
 
@@ -1314,7 +1627,23 @@ Refaz a última ação.
1314
1627
 
1315
1628
  #### Defined in
1316
1629
 
1317
- src/dataunit/DataUnit.ts:953
1630
+ src/dataunit/DataUnit.ts:1155
1631
+
1632
+ ___
1633
+
1634
+ ### release
1635
+
1636
+ ▸ **release**(): `void`
1637
+
1638
+ Desfaz vinculos do DataUnit. Chamado quando o DU não é mais necessário.
1639
+
1640
+ #### Returns
1641
+
1642
+ `void`
1643
+
1644
+ #### Defined in
1645
+
1646
+ src/dataunit/DataUnit.ts:81
1318
1647
 
1319
1648
  ___
1320
1649
 
@@ -1332,7 +1661,29 @@ Recarrega registro selecionado com dados atualizados do servidor.
1332
1661
 
1333
1662
  #### Defined in
1334
1663
 
1335
- src/dataunit/DataUnit.ts:1086
1664
+ src/dataunit/DataUnit.ts:1300
1665
+
1666
+ ___
1667
+
1668
+ ### removeChildDataunit
1669
+
1670
+ ▸ **removeChildDataunit**(`name`): `void`
1671
+
1672
+ Remove um dataunit filho.
1673
+
1674
+ #### Parameters
1675
+
1676
+ | Name | Type | Description |
1677
+ | :------ | :------ | :------ |
1678
+ | `name` | `string` | Nome do dataunit filho. |
1679
+
1680
+ #### Returns
1681
+
1682
+ `void`
1683
+
1684
+ #### Defined in
1685
+
1686
+ src/dataunit/DataUnit.ts:1266
1336
1687
 
1337
1688
  ___
1338
1689
 
@@ -1354,7 +1705,7 @@ Remove um interceptor da lista de interceptors.
1354
1705
 
1355
1706
  #### Defined in
1356
1707
 
1357
- src/dataunit/DataUnit.ts:444
1708
+ src/dataunit/DataUnit.ts:569
1358
1709
 
1359
1710
  ___
1360
1711
 
@@ -1381,7 +1732,7 @@ Efetua requisição para remoção dos registros.
1381
1732
 
1382
1733
  #### Defined in
1383
1734
 
1384
- src/dataunit/DataUnit.ts:357
1735
+ src/dataunit/DataUnit.ts:459
1385
1736
 
1386
1737
  ___
1387
1738
 
@@ -1405,7 +1756,7 @@ Remove o registro selecionado.
1405
1756
 
1406
1757
  #### Defined in
1407
1758
 
1408
- src/dataunit/DataUnit.ts:336
1759
+ src/dataunit/DataUnit.ts:438
1409
1760
 
1410
1761
  ___
1411
1762
 
@@ -1429,7 +1780,7 @@ Salva o estado do registro do DataUnit.
1429
1780
 
1430
1781
  #### Defined in
1431
1782
 
1432
- src/dataunit/DataUnit.ts:291
1783
+ src/dataunit/DataUnit.ts:346
1433
1784
 
1434
1785
  ___
1435
1786
 
@@ -1451,7 +1802,7 @@ Seleciona o primeiro registro.
1451
1802
 
1452
1803
  #### Defined in
1453
1804
 
1454
- src/dataunit/DataUnit.ts:706
1805
+ src/dataunit/DataUnit.ts:857
1455
1806
 
1456
1807
  ___
1457
1808
 
@@ -1473,7 +1824,7 @@ Seleciona o último registro.
1473
1824
 
1474
1825
  #### Defined in
1475
1826
 
1476
- src/dataunit/DataUnit.ts:719
1827
+ src/dataunit/DataUnit.ts:870
1477
1828
 
1478
1829
  ___
1479
1830
 
@@ -1497,7 +1848,7 @@ Insere valor no campo desejado.
1497
1848
 
1498
1849
  #### Defined in
1499
1850
 
1500
- src/dataunit/DataUnit.ts:643
1851
+ src/dataunit/DataUnit.ts:794
1501
1852
 
1502
1853
  ___
1503
1854
 
@@ -1520,7 +1871,7 @@ Seleciona múltiplos registros por ID.
1520
1871
 
1521
1872
  #### Defined in
1522
1873
 
1523
- src/dataunit/DataUnit.ts:695
1874
+ src/dataunit/DataUnit.ts:846
1524
1875
 
1525
1876
  ___
1526
1877
 
@@ -1543,7 +1894,29 @@ Seleciona múltiplos registros por índice.
1543
1894
 
1544
1895
  #### Defined in
1545
1896
 
1546
- src/dataunit/DataUnit.ts:734
1897
+ src/dataunit/DataUnit.ts:885
1898
+
1899
+ ___
1900
+
1901
+ ### showField
1902
+
1903
+ ▸ **showField**(`fieldName`): `void`
1904
+
1905
+ Deixa um campo do DataUnit visível
1906
+
1907
+ #### Parameters
1908
+
1909
+ | Name | Type | Description |
1910
+ | :------ | :------ | :------ |
1911
+ | `fieldName` | `string` | nome do campo para ficar visível. |
1912
+
1913
+ #### Returns
1914
+
1915
+ `void`
1916
+
1917
+ #### Defined in
1918
+
1919
+ src/dataunit/DataUnit.ts:1397
1547
1920
 
1548
1921
  ___
1549
1922
 
@@ -1566,7 +1939,7 @@ Inicia alteração no campo.
1566
1939
 
1567
1940
  #### Defined in
1568
1941
 
1569
- src/dataunit/DataUnit.ts:661
1942
+ src/dataunit/DataUnit.ts:812
1570
1943
 
1571
1944
  ___
1572
1945
 
@@ -1589,7 +1962,7 @@ Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
1589
1962
 
1590
1963
  #### Defined in
1591
1964
 
1592
- src/dataunit/DataUnit.ts:1064
1965
+ src/dataunit/DataUnit.ts:1278
1593
1966
 
1594
1967
  ___
1595
1968
 
@@ -1607,7 +1980,7 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
1607
1980
 
1608
1981
  #### Defined in
1609
1982
 
1610
- src/dataunit/DataUnit.ts:964
1983
+ src/dataunit/DataUnit.ts:1166
1611
1984
 
1612
1985
  ___
1613
1986
 
@@ -1629,7 +2002,7 @@ Desfaz a última ação.
1629
2002
 
1630
2003
  #### Defined in
1631
2004
 
1632
- src/dataunit/DataUnit.ts:942
2005
+ src/dataunit/DataUnit.ts:1144
1633
2006
 
1634
2007
  ___
1635
2008
 
@@ -1651,7 +2024,7 @@ Remove um observer existente.
1651
2024
 
1652
2025
  #### Defined in
1653
2026
 
1654
- src/dataunit/DataUnit.ts:1075
2027
+ src/dataunit/DataUnit.ts:1289
1655
2028
 
1656
2029
  ___
1657
2030
 
@@ -1676,7 +2049,7 @@ Obtém o valor convertido de acordo com o tipo do campo.
1676
2049
 
1677
2050
  #### Defined in
1678
2051
 
1679
- src/dataunit/DataUnit.ts:93
2052
+ src/dataunit/DataUnit.ts:114
1680
2053
 
1681
2054
  ___
1682
2055
 
@@ -1701,7 +2074,7 @@ Obtém o valor do campo em seu formato/tipo correto a partir de uma string.
1701
2074
 
1702
2075
  #### Defined in
1703
2076
 
1704
- src/dataunit/DataUnit.ts:406
2077
+ src/dataunit/DataUnit.ts:508
1705
2078
 
1706
2079
  ___
1707
2080
 
@@ -1726,7 +2099,7 @@ Converte o valor informado para texto de acordo com o tipo do campo informado.
1726
2099
 
1727
2100
  #### Defined in
1728
2101
 
1729
- src/dataunit/DataUnit.ts:421
2102
+ src/dataunit/DataUnit.ts:523
1730
2103
 
1731
2104
  ___
1732
2105
 
@@ -1750,4 +2123,4 @@ Retorna se a alteração no campo já foi concluída ou se ainda está incomplet
1750
2123
 
1751
2124
  #### Defined in
1752
2125
 
1753
- src/dataunit/DataUnit.ts:617
2126
+ src/dataunit/DataUnit.ts:768