@sankhyalabs/core-docs 3.1.2 → 4.0.1

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 (27) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +385 -104
  3. package/classes/DataUnitStorage.md +116 -0
  4. package/classes/DateUtils.md +87 -10
  5. package/classes/MaskFormatter-1.md +25 -14
  6. package/classes/NumberUtils.md +45 -0
  7. package/enums/Action.md +11 -0
  8. package/enums/ChangeOperation.md +4 -4
  9. package/enums/DependencyType.md +3 -3
  10. package/enums/SortMode.md +2 -2
  11. package/enums/UserInterface.md +17 -17
  12. package/interfaces/ChildDescriptor.md +41 -0
  13. package/interfaces/ChildLink.md +30 -0
  14. package/interfaces/DUActionInterceptor.md +1 -1
  15. package/interfaces/FieldDescriptor.md +11 -11
  16. package/interfaces/Filter.md +3 -3
  17. package/interfaces/PageRequest.md +3 -3
  18. package/interfaces/QuickFilter.md +2 -2
  19. package/interfaces/Record.md +24 -2
  20. package/interfaces/SavedRecord.md +33 -3
  21. package/interfaces/Sort.md +3 -3
  22. package/interfaces/SortingProvider.md +1 -1
  23. package/interfaces/UnitMetadata.md +1 -1
  24. package/interfaces/WaitingChange.md +3 -3
  25. package/modules/MaskFormatter.md +4 -4
  26. package/modules.md +3 -0
  27. 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,10 +42,13 @@
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)
50
54
  - [disableField](DataUnit.md#disablefield)
@@ -52,35 +56,45 @@
52
56
  - [doDispatchAction](DataUnit.md#dodispatchaction)
53
57
  - [enableField](DataUnit.md#enablefield)
54
58
  - [executeLoadData](DataUnit.md#executeloaddata)
59
+ - [getAllChangesToSave](DataUnit.md#getallchangestosave)
55
60
  - [getChildDataunit](DataUnit.md#getchilddataunit)
56
61
  - [getChildInfo](DataUnit.md#getchildinfo)
57
62
  - [getField](DataUnit.md#getfield)
58
63
  - [getFieldValue](DataUnit.md#getfieldvalue)
59
64
  - [getFielterProviderKey](DataUnit.md#getfielterproviderkey)
60
65
  - [getFilters](DataUnit.md#getfilters)
66
+ - [getFormattedValue](DataUnit.md#getformattedvalue)
61
67
  - [getModifiedRecords](DataUnit.md#getmodifiedrecords)
62
68
  - [getPaginationInfo](DataUnit.md#getpaginationinfo)
69
+ - [getParentRecordId](DataUnit.md#getparentrecordid)
70
+ - [getRecordsByDataUnit](DataUnit.md#getrecordsbydataunit)
63
71
  - [getSelectedRecord](DataUnit.md#getselectedrecord)
64
72
  - [getSelectedRecords](DataUnit.md#getselectedrecords)
65
73
  - [getSelection](DataUnit.md#getselection)
66
74
  - [getSort](DataUnit.md#getsort)
67
75
  - [gotoPage](DataUnit.md#gotopage)
76
+ - [hasCopiedRecord](DataUnit.md#hascopiedrecord)
68
77
  - [hasDirtyRecords](DataUnit.md#hasdirtyrecords)
78
+ - [hasNewRecord](DataUnit.md#hasnewrecord)
69
79
  - [hasNext](DataUnit.md#hasnext)
70
80
  - [hasPrevious](DataUnit.md#hasprevious)
71
81
  - [hideField](DataUnit.md#hidefield)
72
82
  - [intercept](DataUnit.md#intercept)
73
83
  - [isDirty](DataUnit.md#isdirty)
74
84
  - [isNewRecord](DataUnit.md#isnewrecord)
85
+ - [isSameRequest](DataUnit.md#issamerequest)
75
86
  - [loadData](DataUnit.md#loaddata)
76
87
  - [loadMetadata](DataUnit.md#loadmetadata)
77
88
  - [nextPage](DataUnit.md#nextpage)
78
89
  - [nextRecord](DataUnit.md#nextrecord)
90
+ - [notifySavingData](DataUnit.md#notifysavingdata)
79
91
  - [onDataUnitParentEvent](DataUnit.md#ondataunitparentevent)
80
92
  - [previousPage](DataUnit.md#previouspage)
81
93
  - [previousRecord](DataUnit.md#previousrecord)
82
94
  - [redo](DataUnit.md#redo)
95
+ - [release](DataUnit.md#release)
83
96
  - [reloadCurrentRecord](DataUnit.md#reloadcurrentrecord)
97
+ - [removeChildDataunit](DataUnit.md#removechilddataunit)
84
98
  - [removeInterceptor](DataUnit.md#removeinterceptor)
85
99
  - [removeRecords](DataUnit.md#removerecords)
86
100
  - [removeSelectedRecords](DataUnit.md#removeselectedrecords)
@@ -105,18 +119,18 @@
105
119
 
106
120
  ### constructor
107
121
 
108
- • **new DataUnit**(`name`, `parentDataUnit?`)
122
+ • **new DataUnit**(`name?`, `parentDataUnit?`)
109
123
 
110
124
  #### Parameters
111
125
 
112
- | Name | Type |
113
- | :------ | :------ |
114
- | `name` | `string` |
115
- | `parentDataUnit?` | [`DataUnit`](DataUnit.md) |
126
+ | Name | Type | Default value |
127
+ | :------ | :------ | :------ |
128
+ | `name` | `string` | `DEFAULT_DATAUNIT_NAME` |
129
+ | `parentDataUnit?` | [`DataUnit`](DataUnit.md) | `undefined` |
116
130
 
117
131
  #### Defined in
118
132
 
119
- src/dataunit/DataUnit.ts:46
133
+ src/dataunit/DataUnit.ts:51
120
134
 
121
135
  ## Properties
122
136
 
@@ -126,7 +140,7 @@ src/dataunit/DataUnit.ts:46
126
140
 
127
141
  #### Defined in
128
142
 
129
- src/dataunit/DataUnit.ts:36
143
+ src/dataunit/DataUnit.ts:42
130
144
 
131
145
  ___
132
146
 
@@ -136,7 +150,7 @@ ___
136
150
 
137
151
  #### Defined in
138
152
 
139
- src/dataunit/DataUnit.ts:32
153
+ src/dataunit/DataUnit.ts:38
140
154
 
141
155
  ___
142
156
 
@@ -146,7 +160,7 @@ ___
146
160
 
147
161
  #### Defined in
148
162
 
149
- src/dataunit/DataUnit.ts:34
163
+ src/dataunit/DataUnit.ts:40
150
164
 
151
165
  ___
152
166
 
@@ -156,7 +170,7 @@ ___
156
170
 
157
171
  #### Defined in
158
172
 
159
- src/dataunit/DataUnit.ts:29
173
+ src/dataunit/DataUnit.ts:35
160
174
 
161
175
  ___
162
176
 
@@ -166,7 +180,7 @@ ___
166
180
 
167
181
  #### Defined in
168
182
 
169
- src/dataunit/DataUnit.ts:30
183
+ src/dataunit/DataUnit.ts:36
170
184
 
171
185
  ___
172
186
 
@@ -176,7 +190,7 @@ ___
176
190
 
177
191
  #### Defined in
178
192
 
179
- src/dataunit/DataUnit.ts:35
193
+ src/dataunit/DataUnit.ts:41
180
194
 
181
195
  ___
182
196
 
@@ -186,37 +200,37 @@ ___
186
200
 
187
201
  #### Defined in
188
202
 
189
- src/dataunit/DataUnit.ts:37
203
+ src/dataunit/DataUnit.ts:43
190
204
 
191
205
  ___
192
206
 
193
- ### \_parentSelectedRecordID
207
+ ### \_sortingProvider
194
208
 
195
- • `Private` **\_parentSelectedRecordID**: `undefined` \| `string`
209
+ • `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
196
210
 
197
211
  #### Defined in
198
212
 
199
- src/dataunit/DataUnit.ts:38
213
+ src/dataunit/DataUnit.ts:37
200
214
 
201
215
  ___
202
216
 
203
- ### \_sortingProvider
217
+ ### \_stateManager
204
218
 
205
- • `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
219
+ • `Private` **\_stateManager**: `default`
206
220
 
207
221
  #### Defined in
208
222
 
209
- src/dataunit/DataUnit.ts:31
223
+ src/dataunit/DataUnit.ts:39
210
224
 
211
225
  ___
212
226
 
213
- ### \_stateManager
227
+ ### \_uuid
214
228
 
215
- • `Private` **\_stateManager**: `default`
229
+ • `Private` **\_uuid**: `string`
216
230
 
217
231
  #### Defined in
218
232
 
219
- src/dataunit/DataUnit.ts:33
233
+ src/dataunit/DataUnit.ts:34
220
234
 
221
235
  ___
222
236
 
@@ -241,7 +255,7 @@ ___
241
255
 
242
256
  #### Defined in
243
257
 
244
- src/dataunit/DataUnit.ts:41
258
+ src/dataunit/DataUnit.ts:46
245
259
 
246
260
  ___
247
261
 
@@ -265,7 +279,7 @@ ___
265
279
 
266
280
  #### Defined in
267
281
 
268
- src/dataunit/DataUnit.ts:40
282
+ src/dataunit/DataUnit.ts:45
269
283
 
270
284
  ___
271
285
 
@@ -290,7 +304,7 @@ ___
290
304
 
291
305
  #### Defined in
292
306
 
293
- src/dataunit/DataUnit.ts:44
307
+ src/dataunit/DataUnit.ts:49
294
308
 
295
309
  ___
296
310
 
@@ -315,7 +329,7 @@ ___
315
329
 
316
330
  #### Defined in
317
331
 
318
- src/dataunit/DataUnit.ts:43
332
+ src/dataunit/DataUnit.ts:48
319
333
 
320
334
  ___
321
335
 
@@ -340,10 +354,24 @@ ___
340
354
 
341
355
  #### Defined in
342
356
 
343
- src/dataunit/DataUnit.ts:42
357
+ src/dataunit/DataUnit.ts:47
344
358
 
345
359
  ## Accessors
346
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
+
347
375
  ### metadata
348
376
 
349
377
  • `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
@@ -356,7 +384,7 @@ Obtém os metadados do DataUnit.
356
384
 
357
385
  #### Defined in
358
386
 
359
- src/dataunit/DataUnit.ts:494
387
+ src/dataunit/DataUnit.ts:619
360
388
 
361
389
  • `set` **metadata**(`md`): `void`
362
390
 
@@ -374,7 +402,7 @@ Define a propriedade metadata da instância da classe com um novo valor e chama
374
402
 
375
403
  #### Defined in
376
404
 
377
- src/dataunit/DataUnit.ts:485
405
+ src/dataunit/DataUnit.ts:610
378
406
 
379
407
  ___
380
408
 
@@ -392,7 +420,7 @@ Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uni
392
420
 
393
421
  #### Defined in
394
422
 
395
- src/dataunit/DataUnit.ts:79
423
+ src/dataunit/DataUnit.ts:100
396
424
 
397
425
  ___
398
426
 
@@ -410,7 +438,7 @@ Obtém a quantidade de registros que está sendo exibido por página.
410
438
 
411
439
  #### Defined in
412
440
 
413
- src/dataunit/DataUnit.ts:555
441
+ src/dataunit/DataUnit.ts:680
414
442
 
415
443
  • `set` **pageSize**(`size`): `void`
416
444
 
@@ -428,7 +456,7 @@ Define a quantidade de registros que será exibido por página.
428
456
 
429
457
  #### Defined in
430
458
 
431
- src/dataunit/DataUnit.ts:544
459
+ src/dataunit/DataUnit.ts:669
432
460
 
433
461
  ___
434
462
 
@@ -446,7 +474,7 @@ Obtém todos os registros atuais.
446
474
 
447
475
  #### Defined in
448
476
 
449
- src/dataunit/DataUnit.ts:532
477
+ src/dataunit/DataUnit.ts:657
450
478
 
451
479
  • `set` **records**(`records`): `void`
452
480
 
@@ -464,7 +492,7 @@ Define a propriedade records da instância da classe com um novo valor e chama o
464
492
 
465
493
  #### Defined in
466
494
 
467
- src/dataunit/DataUnit.ts:521
495
+ src/dataunit/DataUnit.ts:646
468
496
 
469
497
  ___
470
498
 
@@ -486,7 +514,7 @@ Define a lógica de ordenação dos registros.
486
514
 
487
515
  #### Defined in
488
516
 
489
- src/dataunit/DataUnit.ts:476
517
+ src/dataunit/DataUnit.ts:601
490
518
 
491
519
  ## Methods
492
520
 
@@ -508,7 +536,7 @@ Adiciona um FilterProvider.
508
536
 
509
537
  #### Defined in
510
538
 
511
- src/dataunit/DataUnit.ts:455
539
+ src/dataunit/DataUnit.ts:580
512
540
 
513
541
  ___
514
542
 
@@ -530,7 +558,7 @@ Adiciona um interceptor correspondente a uma ação do DataUnit para fazer um pr
530
558
 
531
559
  #### Defined in
532
560
 
533
- src/dataunit/DataUnit.ts:433
561
+ src/dataunit/DataUnit.ts:558
534
562
 
535
563
  ___
536
564
 
@@ -552,7 +580,46 @@ Adiciona um novo registro.
552
580
 
553
581
  #### Defined in
554
582
 
555
- 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
556
623
 
557
624
  ___
558
625
 
@@ -570,7 +637,7 @@ Verdadeiro se for possível refazer a ação.
570
637
 
571
638
  #### Defined in
572
639
 
573
- src/dataunit/DataUnit.ts:930
640
+ src/dataunit/DataUnit.ts:1132
574
641
 
575
642
  ___
576
643
 
@@ -588,13 +655,13 @@ Verdadeiro se for possível desfazer a ação.
588
655
 
589
656
  #### Defined in
590
657
 
591
- src/dataunit/DataUnit.ts:919
658
+ src/dataunit/DataUnit.ts:1121
592
659
 
593
660
  ___
594
661
 
595
662
  ### cancelEdition
596
663
 
597
- ▸ **cancelEdition**(`executionCtx?`): `void`
664
+ ▸ **cancelEdition**(`executionCtx?`, `fromParent?`): `Promise`<`void`\>
598
665
 
599
666
  Cancela edição do registro atual.
600
667
 
@@ -603,14 +670,15 @@ Cancela edição do registro atual.
603
670
  | Name | Type | Description |
604
671
  | :------ | :------ | :------ |
605
672
  | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do cancelamento da seleção dos registros. |
673
+ | `fromParent?` | `boolean` | - |
606
674
 
607
675
  #### Returns
608
676
 
609
- `void`
677
+ `Promise`<`void`\>
610
678
 
611
679
  #### Defined in
612
680
 
613
- src/dataunit/DataUnit.ts:839
681
+ src/dataunit/DataUnit.ts:990
614
682
 
615
683
  ___
616
684
 
@@ -632,7 +700,25 @@ Cancela o início de uma alteração no campo.
632
700
 
633
701
  #### Defined in
634
702
 
635
- 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
636
722
 
637
723
  ___
638
724
 
@@ -648,7 +734,7 @@ Limpa todos os registros do DataUnit
648
734
 
649
735
  #### Defined in
650
736
 
651
- src/dataunit/DataUnit.ts:773
737
+ src/dataunit/DataUnit.ts:924
652
738
 
653
739
  ___
654
740
 
@@ -670,7 +756,7 @@ Efetua a cópia do registro selecionado.
670
756
 
671
757
  #### Defined in
672
758
 
673
- src/dataunit/DataUnit.ts:601
759
+ src/dataunit/DataUnit.ts:726
674
760
 
675
761
  ___
676
762
 
@@ -692,7 +778,7 @@ Desabilita um campo do DataUnit
692
778
 
693
779
  #### Defined in
694
780
 
695
- src/dataunit/DataUnit.ts:1153
781
+ src/dataunit/DataUnit.ts:1367
696
782
 
697
783
  ___
698
784
 
@@ -718,7 +804,7 @@ Lança ação do DataUnit para que sejam processadas.
718
804
 
719
805
  #### Defined in
720
806
 
721
- src/dataunit/DataUnit.ts:980
807
+ src/dataunit/DataUnit.ts:1182
722
808
 
723
809
  ___
724
810
 
@@ -740,7 +826,7 @@ Processa as ações no DataUnit e notifica os observers.
740
826
 
741
827
  #### Defined in
742
828
 
743
- src/dataunit/DataUnit.ts:1028
829
+ src/dataunit/DataUnit.ts:1230
744
830
 
745
831
  ___
746
832
 
@@ -762,13 +848,13 @@ Habilita um campo do DataUnit
762
848
 
763
849
  #### Defined in
764
850
 
765
- src/dataunit/DataUnit.ts:1138
851
+ src/dataunit/DataUnit.ts:1352
766
852
 
767
853
  ___
768
854
 
769
855
  ### executeLoadData
770
856
 
771
- ▸ `Private` **executeLoadData**(`request`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
857
+ ▸ `Private` **executeLoadData**(`request`, `executionCtx?`, `checkLastFilter?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
772
858
 
773
859
  Executa o carregamento dos registros.
774
860
 
@@ -778,6 +864,7 @@ Executa o carregamento dos registros.
778
864
  | :------ | :------ | :------ |
779
865
  | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) | Dados da requisição para carregamento dos registros. |
780
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. |
781
868
 
782
869
  #### Returns
783
870
 
@@ -787,7 +874,25 @@ Executa o carregamento dos registros.
787
874
 
788
875
  #### Defined in
789
876
 
790
- 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
791
896
 
792
897
  ___
793
898
 
@@ -809,13 +914,13 @@ Cria um dataunit filho.
809
914
 
810
915
  #### Defined in
811
916
 
812
- src/dataunit/DataUnit.ts:1050
917
+ src/dataunit/DataUnit.ts:1253
813
918
 
814
919
  ___
815
920
 
816
921
  ### getChildInfo
817
922
 
818
- ▸ **getChildInfo**(`name`): `undefined` \| `ChildDescriptor`
923
+ ▸ **getChildInfo**(`name`): `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
819
924
 
820
925
  Obtém informações da ligação para um DataUnit filho.
821
926
 
@@ -827,13 +932,13 @@ Obtém informações da ligação para um DataUnit filho.
827
932
 
828
933
  #### Returns
829
934
 
830
- `undefined` \| `ChildDescriptor`
935
+ `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
831
936
 
832
937
  - As informações sobre a ligação solicitada. Pode retornar undefined.
833
938
 
834
939
  #### Defined in
835
940
 
836
- src/dataunit/DataUnit.ts:507
941
+ src/dataunit/DataUnit.ts:632
837
942
 
838
943
  ___
839
944
 
@@ -857,7 +962,7 @@ Obtém metadados de um campo específico.
857
962
 
858
963
  #### Defined in
859
964
 
860
- src/dataunit/DataUnit.ts:579
965
+ src/dataunit/DataUnit.ts:704
861
966
 
862
967
  ___
863
968
 
@@ -881,7 +986,7 @@ Obtém valor do campo desejado.
881
986
 
882
987
  #### Defined in
883
988
 
884
- src/dataunit/DataUnit.ts:630
989
+ src/dataunit/DataUnit.ts:781
885
990
 
886
991
  ___
887
992
 
@@ -905,7 +1010,7 @@ Obtém chave única para identificação do FilterProvider.
905
1010
 
906
1011
  #### Defined in
907
1012
 
908
- src/dataunit/DataUnit.ts:127
1013
+ src/dataunit/DataUnit.ts:148
909
1014
 
910
1015
  ___
911
1016
 
@@ -923,7 +1028,34 @@ Obtém todos os filtros de dados.
923
1028
 
924
1029
  #### Defined in
925
1030
 
926
- 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
927
1059
 
928
1060
  ___
929
1061
 
@@ -941,7 +1073,7 @@ Obtém os registros modificados e ainda não salvos no DataUnit.
941
1073
 
942
1074
  #### Defined in
943
1075
 
944
- src/dataunit/DataUnit.ts:566
1076
+ src/dataunit/DataUnit.ts:691
945
1077
 
946
1078
  ___
947
1079
 
@@ -959,7 +1091,41 @@ Obtém informações de paginação dos registros.
959
1091
 
960
1092
  #### Defined in
961
1093
 
962
- 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
963
1129
 
964
1130
  ___
965
1131
 
@@ -977,7 +1143,7 @@ Retorna apenas um registro selecionado no Dataunit
977
1143
 
978
1144
  #### Defined in
979
1145
 
980
- src/dataunit/DataUnit.ts:760
1146
+ src/dataunit/DataUnit.ts:911
981
1147
 
982
1148
  ___
983
1149
 
@@ -995,7 +1161,7 @@ Obtém todos os registros selecionados.
995
1161
 
996
1162
  #### Defined in
997
1163
 
998
- src/dataunit/DataUnit.ts:745
1164
+ src/dataunit/DataUnit.ts:896
999
1165
 
1000
1166
  ___
1001
1167
 
@@ -1013,7 +1179,7 @@ Obtém registros selecionados.
1013
1179
 
1014
1180
  #### Defined in
1015
1181
 
1016
- src/dataunit/DataUnit.ts:683
1182
+ src/dataunit/DataUnit.ts:834
1017
1183
 
1018
1184
  ___
1019
1185
 
@@ -1031,7 +1197,7 @@ Obtém a estrutura de ordenação das colunas dos dados.
1031
1197
 
1032
1198
  #### Defined in
1033
1199
 
1034
- src/dataunit/DataUnit.ts:1110
1200
+ src/dataunit/DataUnit.ts:1324
1035
1201
 
1036
1202
  ___
1037
1203
 
@@ -1056,7 +1222,25 @@ Alterna entre os registros por número de página.
1056
1222
 
1057
1223
  #### Defined in
1058
1224
 
1059
- 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
1060
1244
 
1061
1245
  ___
1062
1246
 
@@ -1074,7 +1258,25 @@ Verdadeiro se existir alterações de registros pendentes.
1074
1258
 
1075
1259
  #### Defined in
1076
1260
 
1077
- 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
1078
1280
 
1079
1281
  ___
1080
1282
 
@@ -1092,7 +1294,7 @@ Verdadeiro se existir uma próxima página.
1092
1294
 
1093
1295
  #### Defined in
1094
1296
 
1095
- src/dataunit/DataUnit.ts:872
1297
+ src/dataunit/DataUnit.ts:1042
1096
1298
 
1097
1299
  ___
1098
1300
 
@@ -1110,7 +1312,7 @@ Verdadeiro se existir uma página anterior.
1110
1312
 
1111
1313
  #### Defined in
1112
1314
 
1113
- src/dataunit/DataUnit.ts:887
1315
+ src/dataunit/DataUnit.ts:1057
1114
1316
 
1115
1317
  ___
1116
1318
 
@@ -1132,7 +1334,7 @@ Deixa um campo do DataUnit invisível
1132
1334
 
1133
1335
  #### Defined in
1134
1336
 
1135
- src/dataunit/DataUnit.ts:1168
1337
+ src/dataunit/DataUnit.ts:1382
1136
1338
 
1137
1339
  ___
1138
1340
 
@@ -1157,7 +1359,7 @@ Notifica os interceptors de que uma ação foi executada, para que cada intercep
1157
1359
 
1158
1360
  #### Defined in
1159
1361
 
1160
- src/dataunit/DataUnit.ts:1011
1362
+ src/dataunit/DataUnit.ts:1213
1161
1363
 
1162
1364
  ___
1163
1365
 
@@ -1175,7 +1377,7 @@ Verdadeiro se existir alterações pendentes.
1175
1377
 
1176
1378
  #### Defined in
1177
1379
 
1178
- src/dataunit/DataUnit.ts:850
1380
+ src/dataunit/DataUnit.ts:1006
1179
1381
 
1180
1382
  ___
1181
1383
 
@@ -1199,13 +1401,33 @@ Verdadeiro se o id solicitado é de um registro novo.
1199
1401
 
1200
1402
  #### Defined in
1201
1403
 
1202
- 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
1203
1425
 
1204
1426
  ___
1205
1427
 
1206
1428
  ### loadData
1207
1429
 
1208
- ▸ **loadData**(`quickFilter?`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1430
+ ▸ **loadData**(`quickFilter?`, `executionCtx?`, `checkLastFilter?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
1209
1431
 
1210
1432
  Carrega os registros do DataUnit.
1211
1433
 
@@ -1215,6 +1437,7 @@ Carrega os registros do DataUnit.
1215
1437
  | :------ | :------ | :------ |
1216
1438
  | `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) | Filtros a serem aplicados. |
1217
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. |
1218
1441
 
1219
1442
  #### Returns
1220
1443
 
@@ -1224,7 +1447,7 @@ Carrega os registros do DataUnit.
1224
1447
 
1225
1448
  #### Defined in
1226
1449
 
1227
- src/dataunit/DataUnit.ts:200
1450
+ src/dataunit/DataUnit.ts:240
1228
1451
 
1229
1452
  ___
1230
1453
 
@@ -1248,7 +1471,7 @@ Carrega os metadados do DataUnit.
1248
1471
 
1249
1472
  #### Defined in
1250
1473
 
1251
- src/dataunit/DataUnit.ts:172
1474
+ src/dataunit/DataUnit.ts:211
1252
1475
 
1253
1476
  ___
1254
1477
 
@@ -1272,7 +1495,7 @@ Vai para os registros da página seguinte.
1272
1495
 
1273
1496
  #### Defined in
1274
1497
 
1275
- src/dataunit/DataUnit.ts:265
1498
+ src/dataunit/DataUnit.ts:304
1276
1499
 
1277
1500
  ___
1278
1501
 
@@ -1294,7 +1517,27 @@ Seleciona o próximo registro.
1294
1517
 
1295
1518
  #### Defined in
1296
1519
 
1297
- 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
1298
1541
 
1299
1542
  ___
1300
1543
 
@@ -1316,7 +1559,7 @@ Trata as Actions do DataUnit Parent
1316
1559
 
1317
1560
  #### Defined in
1318
1561
 
1319
- src/dataunit/DataUnit.ts:104
1562
+ src/dataunit/DataUnit.ts:125
1320
1563
 
1321
1564
  ___
1322
1565
 
@@ -1340,7 +1583,7 @@ Vai para os registros da página anterior.
1340
1583
 
1341
1584
  #### Defined in
1342
1585
 
1343
- src/dataunit/DataUnit.ts:278
1586
+ src/dataunit/DataUnit.ts:317
1344
1587
 
1345
1588
  ___
1346
1589
 
@@ -1362,7 +1605,7 @@ Seleciona o registro anterior.
1362
1605
 
1363
1606
  #### Defined in
1364
1607
 
1365
- src/dataunit/DataUnit.ts:812
1608
+ src/dataunit/DataUnit.ts:963
1366
1609
 
1367
1610
  ___
1368
1611
 
@@ -1384,7 +1627,23 @@ Refaz a última ação.
1384
1627
 
1385
1628
  #### Defined in
1386
1629
 
1387
- 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
1388
1647
 
1389
1648
  ___
1390
1649
 
@@ -1402,7 +1661,29 @@ Recarrega registro selecionado com dados atualizados do servidor.
1402
1661
 
1403
1662
  #### Defined in
1404
1663
 
1405
- 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
1406
1687
 
1407
1688
  ___
1408
1689
 
@@ -1424,7 +1705,7 @@ Remove um interceptor da lista de interceptors.
1424
1705
 
1425
1706
  #### Defined in
1426
1707
 
1427
- src/dataunit/DataUnit.ts:444
1708
+ src/dataunit/DataUnit.ts:569
1428
1709
 
1429
1710
  ___
1430
1711
 
@@ -1451,7 +1732,7 @@ Efetua requisição para remoção dos registros.
1451
1732
 
1452
1733
  #### Defined in
1453
1734
 
1454
- src/dataunit/DataUnit.ts:357
1735
+ src/dataunit/DataUnit.ts:459
1455
1736
 
1456
1737
  ___
1457
1738
 
@@ -1475,7 +1756,7 @@ Remove o registro selecionado.
1475
1756
 
1476
1757
  #### Defined in
1477
1758
 
1478
- src/dataunit/DataUnit.ts:336
1759
+ src/dataunit/DataUnit.ts:438
1479
1760
 
1480
1761
  ___
1481
1762
 
@@ -1499,7 +1780,7 @@ Salva o estado do registro do DataUnit.
1499
1780
 
1500
1781
  #### Defined in
1501
1782
 
1502
- src/dataunit/DataUnit.ts:291
1783
+ src/dataunit/DataUnit.ts:346
1503
1784
 
1504
1785
  ___
1505
1786
 
@@ -1521,7 +1802,7 @@ Seleciona o primeiro registro.
1521
1802
 
1522
1803
  #### Defined in
1523
1804
 
1524
- src/dataunit/DataUnit.ts:706
1805
+ src/dataunit/DataUnit.ts:857
1525
1806
 
1526
1807
  ___
1527
1808
 
@@ -1543,7 +1824,7 @@ Seleciona o último registro.
1543
1824
 
1544
1825
  #### Defined in
1545
1826
 
1546
- src/dataunit/DataUnit.ts:719
1827
+ src/dataunit/DataUnit.ts:870
1547
1828
 
1548
1829
  ___
1549
1830
 
@@ -1567,7 +1848,7 @@ Insere valor no campo desejado.
1567
1848
 
1568
1849
  #### Defined in
1569
1850
 
1570
- src/dataunit/DataUnit.ts:643
1851
+ src/dataunit/DataUnit.ts:794
1571
1852
 
1572
1853
  ___
1573
1854
 
@@ -1590,7 +1871,7 @@ Seleciona múltiplos registros por ID.
1590
1871
 
1591
1872
  #### Defined in
1592
1873
 
1593
- src/dataunit/DataUnit.ts:695
1874
+ src/dataunit/DataUnit.ts:846
1594
1875
 
1595
1876
  ___
1596
1877
 
@@ -1613,7 +1894,7 @@ Seleciona múltiplos registros por índice.
1613
1894
 
1614
1895
  #### Defined in
1615
1896
 
1616
- src/dataunit/DataUnit.ts:734
1897
+ src/dataunit/DataUnit.ts:885
1617
1898
 
1618
1899
  ___
1619
1900
 
@@ -1635,7 +1916,7 @@ Deixa um campo do DataUnit visível
1635
1916
 
1636
1917
  #### Defined in
1637
1918
 
1638
- src/dataunit/DataUnit.ts:1183
1919
+ src/dataunit/DataUnit.ts:1397
1639
1920
 
1640
1921
  ___
1641
1922
 
@@ -1658,7 +1939,7 @@ Inicia alteração no campo.
1658
1939
 
1659
1940
  #### Defined in
1660
1941
 
1661
- src/dataunit/DataUnit.ts:661
1942
+ src/dataunit/DataUnit.ts:812
1662
1943
 
1663
1944
  ___
1664
1945
 
@@ -1681,7 +1962,7 @@ Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
1681
1962
 
1682
1963
  #### Defined in
1683
1964
 
1684
- src/dataunit/DataUnit.ts:1064
1965
+ src/dataunit/DataUnit.ts:1278
1685
1966
 
1686
1967
  ___
1687
1968
 
@@ -1699,7 +1980,7 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
1699
1980
 
1700
1981
  #### Defined in
1701
1982
 
1702
- src/dataunit/DataUnit.ts:964
1983
+ src/dataunit/DataUnit.ts:1166
1703
1984
 
1704
1985
  ___
1705
1986
 
@@ -1721,7 +2002,7 @@ Desfaz a última ação.
1721
2002
 
1722
2003
  #### Defined in
1723
2004
 
1724
- src/dataunit/DataUnit.ts:942
2005
+ src/dataunit/DataUnit.ts:1144
1725
2006
 
1726
2007
  ___
1727
2008
 
@@ -1743,7 +2024,7 @@ Remove um observer existente.
1743
2024
 
1744
2025
  #### Defined in
1745
2026
 
1746
- src/dataunit/DataUnit.ts:1075
2027
+ src/dataunit/DataUnit.ts:1289
1747
2028
 
1748
2029
  ___
1749
2030
 
@@ -1768,7 +2049,7 @@ Obtém o valor convertido de acordo com o tipo do campo.
1768
2049
 
1769
2050
  #### Defined in
1770
2051
 
1771
- src/dataunit/DataUnit.ts:93
2052
+ src/dataunit/DataUnit.ts:114
1772
2053
 
1773
2054
  ___
1774
2055
 
@@ -1793,7 +2074,7 @@ Obtém o valor do campo em seu formato/tipo correto a partir de uma string.
1793
2074
 
1794
2075
  #### Defined in
1795
2076
 
1796
- src/dataunit/DataUnit.ts:406
2077
+ src/dataunit/DataUnit.ts:508
1797
2078
 
1798
2079
  ___
1799
2080
 
@@ -1818,7 +2099,7 @@ Converte o valor informado para texto de acordo com o tipo do campo informado.
1818
2099
 
1819
2100
  #### Defined in
1820
2101
 
1821
- src/dataunit/DataUnit.ts:421
2102
+ src/dataunit/DataUnit.ts:523
1822
2103
 
1823
2104
  ___
1824
2105
 
@@ -1842,4 +2123,4 @@ Retorna se a alteração no campo já foi concluída ou se ainda está incomplet
1842
2123
 
1843
2124
  #### Defined in
1844
2125
 
1845
- src/dataunit/DataUnit.ts:617
2126
+ src/dataunit/DataUnit.ts:768