@sankhyalabs/core-docs 5.16.4 → 5.17.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 (19) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +185 -115
  3. package/classes/ObjectUtils.md +48 -0
  4. package/classes/OverflowWatcher.md +310 -46
  5. package/classes/SelectionInfo.md +11 -11
  6. package/enumerations/Action.md +32 -22
  7. package/enumerations/ChangeOperation.md +4 -4
  8. package/enumerations/SelectionMode.md +2 -2
  9. package/globals.md +6 -0
  10. package/interfaces/DUActionInterceptor.md +1 -1
  11. package/interfaces/OverFlowWatcherParams.md +67 -0
  12. package/interfaces/PageRequest.md +3 -3
  13. package/interfaces/QuickFilter.md +3 -3
  14. package/interfaces/Record.md +4 -4
  15. package/interfaces/SavedRecord.md +5 -5
  16. package/interfaces/WaitingChange.md +3 -3
  17. package/package.json +1 -1
  18. package/type-aliases/DataUnitEventOptions.md +17 -0
  19. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
package/enumerations/Action.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/state/action/DataUnitAction.ts:52
17
+ src/dataunit/state/action/DataUnitAction.ts:53
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/state/action/DataUnitAction.ts:52
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/state/action/DataUnitAction.ts:51
27
+ src/dataunit/state/action/DataUnitAction.ts:52
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/state/action/DataUnitAction.ts:51
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/state/action/DataUnitAction.ts:45
37
+ src/dataunit/state/action/DataUnitAction.ts:46
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ src/dataunit/state/action/DataUnitAction.ts:45
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/state/action/DataUnitAction.ts:63
47
+ src/dataunit/state/action/DataUnitAction.ts:64
48
48
 
49
49
  ***
50
50
 
@@ -54,7 +54,7 @@ src/dataunit/state/action/DataUnitAction.ts:63
54
54
 
55
55
  #### Source
56
56
 
57
- src/dataunit/state/action/DataUnitAction.ts:47
57
+ src/dataunit/state/action/DataUnitAction.ts:48
58
58
 
59
59
  ***
60
60
 
@@ -74,7 +74,7 @@ src/dataunit/state/action/DataUnitAction.ts:33
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/state/action/DataUnitAction.ts:48
77
+ src/dataunit/state/action/DataUnitAction.ts:49
78
78
 
79
79
  ***
80
80
 
@@ -94,7 +94,7 @@ src/dataunit/state/action/DataUnitAction.ts:37
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/state/action/DataUnitAction.ts:50
97
+ src/dataunit/state/action/DataUnitAction.ts:51
98
98
 
99
99
  ***
100
100
 
@@ -104,7 +104,7 @@ src/dataunit/state/action/DataUnitAction.ts:50
104
104
 
105
105
  #### Source
106
106
 
107
- src/dataunit/state/action/DataUnitAction.ts:65
107
+ src/dataunit/state/action/DataUnitAction.ts:66
108
108
 
109
109
  ***
110
110
 
@@ -114,7 +114,7 @@ src/dataunit/state/action/DataUnitAction.ts:65
114
114
 
115
115
  #### Source
116
116
 
117
- src/dataunit/state/action/DataUnitAction.ts:66
117
+ src/dataunit/state/action/DataUnitAction.ts:67
118
118
 
119
119
  ***
120
120
 
@@ -144,7 +144,7 @@ src/dataunit/state/action/DataUnitAction.ts:29
144
144
 
145
145
  #### Source
146
146
 
147
- src/dataunit/state/action/DataUnitAction.ts:69
147
+ src/dataunit/state/action/DataUnitAction.ts:70
148
148
 
149
149
  ***
150
150
 
@@ -154,7 +154,7 @@ src/dataunit/state/action/DataUnitAction.ts:69
154
154
 
155
155
  #### Source
156
156
 
157
- src/dataunit/state/action/DataUnitAction.ts:68
157
+ src/dataunit/state/action/DataUnitAction.ts:69
158
158
 
159
159
  ***
160
160
 
@@ -164,7 +164,7 @@ src/dataunit/state/action/DataUnitAction.ts:68
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/state/action/DataUnitAction.ts:60
167
+ src/dataunit/state/action/DataUnitAction.ts:61
168
168
 
169
169
  ***
170
170
 
@@ -184,7 +184,7 @@ src/dataunit/state/action/DataUnitAction.ts:30
184
184
 
185
185
  #### Source
186
186
 
187
- src/dataunit/state/action/DataUnitAction.ts:55
187
+ src/dataunit/state/action/DataUnitAction.ts:56
188
188
 
189
189
  ***
190
190
 
@@ -204,7 +204,7 @@ src/dataunit/state/action/DataUnitAction.ts:34
204
204
 
205
205
  #### Source
206
206
 
207
- src/dataunit/state/action/DataUnitAction.ts:56
207
+ src/dataunit/state/action/DataUnitAction.ts:57
208
208
 
209
209
  ***
210
210
 
@@ -214,7 +214,7 @@ src/dataunit/state/action/DataUnitAction.ts:56
214
214
 
215
215
  #### Source
216
216
 
217
- src/dataunit/state/action/DataUnitAction.ts:42
217
+ src/dataunit/state/action/DataUnitAction.ts:43
218
218
 
219
219
  ***
220
220
 
@@ -224,7 +224,7 @@ src/dataunit/state/action/DataUnitAction.ts:42
224
224
 
225
225
  #### Source
226
226
 
227
- src/dataunit/state/action/DataUnitAction.ts:43
227
+ src/dataunit/state/action/DataUnitAction.ts:44
228
228
 
229
229
  ***
230
230
 
@@ -234,7 +234,7 @@ src/dataunit/state/action/DataUnitAction.ts:43
234
234
 
235
235
  #### Source
236
236
 
237
- src/dataunit/state/action/DataUnitAction.ts:40
237
+ src/dataunit/state/action/DataUnitAction.ts:41
238
238
 
239
239
  ***
240
240
 
@@ -244,7 +244,7 @@ src/dataunit/state/action/DataUnitAction.ts:40
244
244
 
245
245
  #### Source
246
246
 
247
- src/dataunit/state/action/DataUnitAction.ts:61
247
+ src/dataunit/state/action/DataUnitAction.ts:62
248
248
 
249
249
  ***
250
250
 
@@ -254,7 +254,7 @@ src/dataunit/state/action/DataUnitAction.ts:61
254
254
 
255
255
  #### Source
256
256
 
257
- src/dataunit/state/action/DataUnitAction.ts:39
257
+ src/dataunit/state/action/DataUnitAction.ts:40
258
258
 
259
259
  ***
260
260
 
@@ -268,13 +268,23 @@ src/dataunit/state/action/DataUnitAction.ts:36
268
268
 
269
269
  ***
270
270
 
271
+ ### SAVING\_ERROR
272
+
273
+ > **SAVING\_ERROR**: `"savingError"`
274
+
275
+ #### Source
276
+
277
+ src/dataunit/state/action/DataUnitAction.ts:38
278
+
279
+ ***
280
+
271
281
  ### SELECTION\_CHANGED
272
282
 
273
283
  > **SELECTION\_CHANGED**: `"selectionChanged"`
274
284
 
275
285
  #### Source
276
286
 
277
- src/dataunit/state/action/DataUnitAction.ts:54
287
+ src/dataunit/state/action/DataUnitAction.ts:55
278
288
 
279
289
  ***
280
290
 
@@ -284,7 +294,7 @@ src/dataunit/state/action/DataUnitAction.ts:54
284
294
 
285
295
  #### Source
286
296
 
287
- src/dataunit/state/action/DataUnitAction.ts:58
297
+ src/dataunit/state/action/DataUnitAction.ts:59
288
298
 
289
299
  ***
290
300
 
@@ -294,4 +304,4 @@ src/dataunit/state/action/DataUnitAction.ts:58
294
304
 
295
305
  #### Source
296
306
 
297
- src/dataunit/state/action/DataUnitAction.ts:46
307
+ src/dataunit/state/action/DataUnitAction.ts:47
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1795
17
+ src/dataunit/DataUnit.ts:1832
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1795
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1797
27
+ src/dataunit/DataUnit.ts:1834
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1797
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1794
37
+ src/dataunit/DataUnit.ts:1831
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1794
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1796
47
+ src/dataunit/DataUnit.ts:1833
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1903
17
+ src/dataunit/DataUnit.ts:1940
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1903
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1904
27
+ src/dataunit/DataUnit.ts:1941
package/globals.md CHANGED
@@ -71,6 +71,7 @@
71
71
  - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
72
72
  - [LoadDataRequest](interfaces/LoadDataRequest.md)
73
73
  - [LoadDataResponse](interfaces/LoadDataResponse.md)
74
+ - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
74
75
  - [PageRequest](interfaces/PageRequest.md)
75
76
  - [PaginationInfo](interfaces/PaginationInfo.md)
76
77
  - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -84,8 +85,13 @@
84
85
 
85
86
  ## Type Aliases
86
87
 
88
+ - [DataUnitEventOptions](type-aliases/DataUnitEventOptions.md)
87
89
  - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
88
90
 
91
+ ## Variables
92
+
93
+ - [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
94
+
89
95
  ## Functions
90
96
 
91
97
  - [defaultDataLoader](functions/defaultDataLoader.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1778
25
+ src/dataunit/DataUnit.ts:1815
package/interfaces/OverFlowWatcherParams.md ADDED
@@ -0,0 +1,67 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverFlowWatcherParams
6
+
7
+ # Interface: OverFlowWatcherParams
8
+
9
+ ## Properties
10
+
11
+ ### callback
12
+
13
+ > **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
14
+
15
+ #### Source
16
+
17
+ src/utils/OverflowWatcher/index.ts:233
18
+
19
+ ***
20
+
21
+ ### debounce?
22
+
23
+ > `optional` **debounce**: `number`
24
+
25
+ #### Source
26
+
27
+ src/utils/OverflowWatcher/index.ts:236
28
+
29
+ ***
30
+
31
+ ### deltaSize?
32
+
33
+ > `optional` **deltaSize**: `number`
34
+
35
+ #### Source
36
+
37
+ src/utils/OverflowWatcher/index.ts:235
38
+
39
+ ***
40
+
41
+ ### element
42
+
43
+ > **element**: `HTMLElement`
44
+
45
+ #### Source
46
+
47
+ src/utils/OverflowWatcher/index.ts:232
48
+
49
+ ***
50
+
51
+ ### notOverFlow?
52
+
53
+ > `optional` **notOverFlow**: `string`[]
54
+
55
+ #### Source
56
+
57
+ src/utils/OverflowWatcher/index.ts:237
58
+
59
+ ***
60
+
61
+ ### overFlowDirection?
62
+
63
+ > `optional` **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)
64
+
65
+ #### Source
66
+
67
+ src/utils/OverflowWatcher/index.ts:234
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1883
17
+ src/dataunit/DataUnit.ts:1920
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1883
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1884
27
+ src/dataunit/DataUnit.ts:1921
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1884
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1885
37
+ src/dataunit/DataUnit.ts:1922
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1890
17
+ src/dataunit/DataUnit.ts:1927
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1890
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1891
27
+ src/dataunit/DataUnit.ts:1928
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1891
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1889
37
+ src/dataunit/DataUnit.ts:1926
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1785
25
+ src/dataunit/DataUnit.ts:1822
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1785
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1784
35
+ src/dataunit/DataUnit.ts:1821
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1784
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1782
45
+ src/dataunit/DataUnit.ts:1819
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1782
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1783
55
+ src/dataunit/DataUnit.ts:1820
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1790
21
+ src/dataunit/DataUnit.ts:1827
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1790
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1785
35
+ src/dataunit/DataUnit.ts:1822
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1785
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1784
49
+ src/dataunit/DataUnit.ts:1821
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1784
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1782
63
+ src/dataunit/DataUnit.ts:1819
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1782
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1783
77
+ src/dataunit/DataUnit.ts:1820
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1878
17
+ src/dataunit/DataUnit.ts:1915
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1878
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1879
27
+ src/dataunit/DataUnit.ts:1916
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1879
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1877
37
+ src/dataunit/DataUnit.ts:1914
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.16.4",
3
+ "version": "5.17.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md ADDED
@@ -0,0 +1,17 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / DataUnitEventOptions
6
+
7
+ # Type alias: DataUnitEventOptions
8
+
9
+ > **DataUnitEventOptions**: `object`
10
+
11
+ ## Index signature
12
+
13
+ \[`key`: `string`\]: `any`
14
+
15
+ ## Source
16
+
17
+ src/dataunit/DataUnit.ts:1993
package/variables/OVERFLOWED_CLASS_NAME.md ADDED
@@ -0,0 +1,13 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
6
+
7
+ # Variable: OVERFLOWED\_CLASS\_NAME
8
+
9
+ > `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
10
+
11
+ ## Source
12
+
13
+ src/utils/OverflowWatcher/index.ts:9