@sankhyalabs/core-docs 5.20.0-dev.7 → 5.20.0-dev.70

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/ColumnFilterManager.md +145 -0
  3. package/classes/DataUnit.md +405 -137
  4. package/classes/DataUnitInMemoryLoader.md +303 -0
  5. package/classes/DataUnitLoaderUtils.md +151 -0
  6. package/classes/DateUtils.md +8 -8
  7. package/classes/FieldComparator.md +2 -2
  8. package/classes/IDBRepository.md +22 -0
  9. package/classes/LockManager.md +249 -0
  10. package/classes/MaskFormatter.md +66 -14
  11. package/classes/ObjectUtils.md +141 -0
  12. package/classes/OverflowWatcher.md +533 -0
  13. package/classes/SelectionInfo.md +25 -11
  14. package/classes/ServiceCanceledException.md +193 -0
  15. package/classes/ServiceUtils.md +67 -0
  16. package/classes/SilentException.md +193 -0
  17. package/classes/UserAgentUtils.md +15 -1
  18. package/enumerations/Action.md +41 -21
  19. package/enumerations/ChangeOperation.md +4 -4
  20. package/enumerations/LockManagerOperation.md +33 -0
  21. package/enumerations/OverflowDirection.md +29 -0
  22. package/enumerations/RECORD_DATE_FORMAT.md +27 -0
  23. package/enumerations/SelectionMode.md +2 -2
  24. package/enumerations/StorageType.md +37 -0
  25. package/globals.md +24 -0
  26. package/interfaces/DUActionInterceptor.md +1 -1
  27. package/interfaces/DataUnitInMemoryLoaderConfig.md +37 -0
  28. package/interfaces/IRepository.md +18 -0
  29. package/interfaces/LoadDataRequest.md +1 -1
  30. package/interfaces/OverFlowWatcherParams.md +67 -0
  31. package/interfaces/PageRequest.md +3 -3
  32. package/interfaces/PaginationInfo.md +25 -0
  33. package/interfaces/PaginationInfoBuilderParams.md +37 -0
  34. package/interfaces/QuickFilter.md +3 -3
  35. package/interfaces/Record.md +4 -4
  36. package/interfaces/SavedRecord.md +5 -5
  37. package/interfaces/WaitingChange.md +3 -3
  38. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  39. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  40. package/package.json +1 -1
  41. package/type-aliases/DataUnitEventOptions.md +17 -0
  42. package/type-aliases/OnOverflowCallBack.md +25 -0
  43. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
@@ -0,0 +1,533 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverflowWatcher
6
+
7
+ # Class: OverflowWatcher
8
+
9
+ ## Constructors
10
+
11
+ ### new OverflowWatcher()
12
+
13
+ > **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
14
+
15
+ Cria uma instancia do OverflowWatcher
16
+
17
+ #### Parameters
18
+
19
+ • **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
20
+
21
+ #### Returns
22
+
23
+ [`OverflowWatcher`](OverflowWatcher.md)
24
+
25
+ #### Source
26
+
27
+ src/utils/OverflowWatcher/index.ts:35
28
+
29
+ ## Properties
30
+
31
+ ### DATA\_ELEMENT\_ID
32
+
33
+ > `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
34
+
35
+ #### Source
36
+
37
+ src/utils/OverflowWatcher/index.ts:23
38
+
39
+ ***
40
+
41
+ ### \_deltaSize
42
+
43
+ > `private` **\_deltaSize**: `number`
44
+
45
+ #### Source
46
+
47
+ src/utils/OverflowWatcher/index.ts:20
48
+
49
+ ***
50
+
51
+ ### \_hiddenItemsProps
52
+
53
+ > `private` **\_hiddenItemsProps**: `Map`\<`Element`, `SizeProps`\>
54
+
55
+ #### Source
56
+
57
+ src/utils/OverflowWatcher/index.ts:18
58
+
59
+ ***
60
+
61
+ ### \_lastContainerInstance
62
+
63
+ > `private` **\_lastContainerInstance**: `undefined` \| `HTMLElement` = `undefined`
64
+
65
+ #### Source
66
+
67
+ src/utils/OverflowWatcher/index.ts:15
68
+
69
+ ***
70
+
71
+ ### \_lastContainerSize
72
+
73
+ > `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
74
+
75
+ #### Source
76
+
77
+ src/utils/OverflowWatcher/index.ts:14
78
+
79
+ ***
80
+
81
+ ### \_notOverFlow
82
+
83
+ > `private` **\_notOverFlow**: `string`[] = `[]`
84
+
85
+ #### Source
86
+
87
+ src/utils/OverflowWatcher/index.ts:21
88
+
89
+ ***
90
+
91
+ ### \_notOverFlowPros
92
+
93
+ > `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
94
+
95
+ #### Source
96
+
97
+ src/utils/OverflowWatcher/index.ts:19
98
+
99
+ ***
100
+
101
+ ### \_onResize
102
+
103
+ > `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
104
+
105
+ #### Source
106
+
107
+ src/utils/OverflowWatcher/index.ts:12
108
+
109
+ ***
110
+
111
+ ### \_propSize
112
+
113
+ > `private` **\_propSize**: `string`
114
+
115
+ #### Source
116
+
117
+ src/utils/OverflowWatcher/index.ts:17
118
+
119
+ ***
120
+
121
+ ### \_resizeObserver
122
+
123
+ > `private` **\_resizeObserver**: `ResizeObserver`
124
+
125
+ #### Source
126
+
127
+ src/utils/OverflowWatcher/index.ts:13
128
+
129
+ ***
130
+
131
+ ### \_scrollDirection
132
+
133
+ > `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
134
+
135
+ #### Source
136
+
137
+ src/utils/OverflowWatcher/index.ts:16
138
+
139
+ ## Methods
140
+
141
+ ### addNotOverFlowElement()
142
+
143
+ > **addNotOverFlowElement**(`elementId`): `void`
144
+
145
+ #### Parameters
146
+
147
+ • **elementId**: `string`
148
+
149
+ #### Returns
150
+
151
+ `void`
152
+
153
+ #### Source
154
+
155
+ src/utils/OverflowWatcher/index.ts:52
156
+
157
+ ***
158
+
159
+ ### calcChildrenSize()
160
+
161
+ > `private` **calcChildrenSize**(`children`): `number`
162
+
163
+ #### Parameters
164
+
165
+ • **children**: `Element`[]
166
+
167
+ #### Returns
168
+
169
+ `number`
170
+
171
+ #### Source
172
+
173
+ src/utils/OverflowWatcher/index.ts:205
174
+
175
+ ***
176
+
177
+ ### calcElementSize()
178
+
179
+ > `private` **calcElementSize**(`el`): `number`
180
+
181
+ #### Parameters
182
+
183
+ • **el**: `Element`
184
+
185
+ #### Returns
186
+
187
+ `number`
188
+
189
+ #### Source
190
+
191
+ src/utils/OverflowWatcher/index.ts:212
192
+
193
+ ***
194
+
195
+ ### calculateVariation()
196
+
197
+ > `private` **calculateVariation**(`elementIdsToCalculate`): `number`
198
+
199
+ #### Parameters
200
+
201
+ • **elementIdsToCalculate**: `string`[]
202
+
203
+ #### Returns
204
+
205
+ `number`
206
+
207
+ #### Source
208
+
209
+ src/utils/OverflowWatcher/index.ts:177
210
+
211
+ ***
212
+
213
+ ### canNotOverFlowNotIncludedIds()
214
+
215
+ > `private` **canNotOverFlowNotIncludedIds**(`elements`): `string`[]
216
+
217
+ #### Parameters
218
+
219
+ • **elements**: `Element`[]
220
+
221
+ #### Returns
222
+
223
+ `string`[]
224
+
225
+ #### Source
226
+
227
+ src/utils/OverflowWatcher/index.ts:187
228
+
229
+ ***
230
+
231
+ ### canNotRegisterNotOverFlow()
232
+
233
+ > `private` **canNotRegisterNotOverFlow**(`id`): `boolean`
234
+
235
+ #### Parameters
236
+
237
+ • **id**: `string`
238
+
239
+ #### Returns
240
+
241
+ `boolean`
242
+
243
+ #### Source
244
+
245
+ src/utils/OverflowWatcher/index.ts:96
246
+
247
+ ***
248
+
249
+ ### canOverFlowElement()
250
+
251
+ > `private` **canOverFlowElement**(`element`): `boolean`
252
+
253
+ #### Parameters
254
+
255
+ • **element**: `Element`
256
+
257
+ #### Returns
258
+
259
+ `boolean`
260
+
261
+ #### Source
262
+
263
+ src/utils/OverflowWatcher/index.ts:157
264
+
265
+ ***
266
+
267
+ ### clearOverFlow()
268
+
269
+ > `private` **clearOverFlow**(): `void`
270
+
271
+ #### Returns
272
+
273
+ `void`
274
+
275
+ #### Source
276
+
277
+ src/utils/OverflowWatcher/index.ts:126
278
+
279
+ ***
280
+
281
+ ### destroy()
282
+
283
+ > **destroy**(): `void`
284
+
285
+ #### Returns
286
+
287
+ `void`
288
+
289
+ #### Source
290
+
291
+ src/utils/OverflowWatcher/index.ts:58
292
+
293
+ ***
294
+
295
+ ### exceedsAvaliableSize()
296
+
297
+ > `private` **exceedsAvaliableSize**(`sumElementsSize`, `elements`, `avaliableSize`): `boolean`
298
+
299
+ #### Parameters
300
+
301
+ • **sumElementsSize**: `number`
302
+
303
+ • **elements**: `Element`[]
304
+
305
+ • **avaliableSize**: `number`
306
+
307
+ #### Returns
308
+
309
+ `boolean`
310
+
311
+ #### Source
312
+
313
+ src/utils/OverflowWatcher/index.ts:166
314
+
315
+ ***
316
+
317
+ ### forceUpdate()
318
+
319
+ > **forceUpdate**(): `void`
320
+
321
+ #### Returns
322
+
323
+ `void`
324
+
325
+ #### Source
326
+
327
+ src/utils/OverflowWatcher/index.ts:62
328
+
329
+ ***
330
+
331
+ ### getDataElementId()
332
+
333
+ > `private` **getDataElementId**(`element`): `string`
334
+
335
+ #### Parameters
336
+
337
+ • **element**: `Element`
338
+
339
+ #### Returns
340
+
341
+ `string`
342
+
343
+ #### Source
344
+
345
+ src/utils/OverflowWatcher/index.ts:162
346
+
347
+ ***
348
+
349
+ ### getElementSizeProps()
350
+
351
+ > `private` **getElementSizeProps**(`element`): `SizeProps`
352
+
353
+ #### Parameters
354
+
355
+ • **element**: `Element`
356
+
357
+ #### Returns
358
+
359
+ `SizeProps`
360
+
361
+ #### Source
362
+
363
+ src/utils/OverflowWatcher/index.ts:197
364
+
365
+ ***
366
+
367
+ ### handleResize()
368
+
369
+ > `private` **handleResize**(`entries`): `void`
370
+
371
+ #### Parameters
372
+
373
+ • **entries**: `ResizeObserverEntry`[]
374
+
375
+ #### Returns
376
+
377
+ `void`
378
+
379
+ #### Source
380
+
381
+ src/utils/OverflowWatcher/index.ts:68
382
+
383
+ ***
384
+
385
+ ### hasChangedSize()
386
+
387
+ > `private` **hasChangedSize**(`elementSize`): `boolean`
388
+
389
+ #### Parameters
390
+
391
+ • **elementSize**: `number`
392
+
393
+ #### Returns
394
+
395
+ `boolean`
396
+
397
+ #### Source
398
+
399
+ src/utils/OverflowWatcher/index.ts:100
400
+
401
+ ***
402
+
403
+ ### isElementOverFlowing()
404
+
405
+ > `private` **isElementOverFlowing**(`elementsThatFit`, `element`): `boolean`
406
+
407
+ #### Parameters
408
+
409
+ • **elementsThatFit**: `Element`[]
410
+
411
+ • **element**: `Element`
412
+
413
+ #### Returns
414
+
415
+ `boolean`
416
+
417
+ #### Source
418
+
419
+ src/utils/OverflowWatcher/index.ts:153
420
+
421
+ ***
422
+
423
+ ### isOverFlowed()
424
+
425
+ > `private` **isOverFlowed**(`el`): `boolean`
426
+
427
+ #### Parameters
428
+
429
+ • **el**: `Element`
430
+
431
+ #### Returns
432
+
433
+ `boolean`
434
+
435
+ #### Source
436
+
437
+ src/utils/OverflowWatcher/index.ts:226
438
+
439
+ ***
440
+
441
+ ### proccessElements()
442
+
443
+ > `private` **proccessElements**(`elementSize`, `children`): `void`
444
+
445
+ #### Parameters
446
+
447
+ • **elementSize**: `number`
448
+
449
+ • **children**: `Element`[]
450
+
451
+ #### Returns
452
+
453
+ `void`
454
+
455
+ #### Source
456
+
457
+ src/utils/OverflowWatcher/index.ts:112
458
+
459
+ ***
460
+
461
+ ### proccessElementsOverFlow()
462
+
463
+ > `private` **proccessElementsOverFlow**(`allElements`, `avaliableSize`): `void`
464
+
465
+ #### Parameters
466
+
467
+ • **allElements**: `Element`[]
468
+
469
+ • **avaliableSize**: `number`
470
+
471
+ #### Returns
472
+
473
+ `void`
474
+
475
+ #### Source
476
+
477
+ src/utils/OverflowWatcher/index.ts:131
478
+
479
+ ***
480
+
481
+ ### registerElementSize()
482
+
483
+ > `private` **registerElementSize**(`element`): `void`
484
+
485
+ #### Parameters
486
+
487
+ • **element**: `Element`
488
+
489
+ #### Returns
490
+
491
+ `void`
492
+
493
+ #### Source
494
+
495
+ src/utils/OverflowWatcher/index.ts:192
496
+
497
+ ***
498
+
499
+ ### registerNotOverflowProps()
500
+
501
+ > `private` **registerNotOverflowProps**(`children`): `void`
502
+
503
+ #### Parameters
504
+
505
+ • **children**: `Element`[]
506
+
507
+ #### Returns
508
+
509
+ `void`
510
+
511
+ #### Source
512
+
513
+ src/utils/OverflowWatcher/index.ts:88
514
+
515
+ ***
516
+
517
+ ### updateOverFlowedItems()
518
+
519
+ > `private` **updateOverFlowedItems**(`container`, `containerSize`): `void`
520
+
521
+ #### Parameters
522
+
523
+ • **container**: `HTMLElement`
524
+
525
+ • **containerSize**: `number`
526
+
527
+ #### Returns
528
+
529
+ `void`
530
+
531
+ #### Source
532
+
533
+ src/utils/OverflowWatcher/index.ts:80
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1915
33
+ src/dataunit/DataUnit.ts:2074
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1915
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1909
43
+ src/dataunit/DataUnit.ts:2071
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1909
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1911
53
+ src/dataunit/DataUnit.ts:2072
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1911
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1912
63
+ src/dataunit/DataUnit.ts:2068
64
+
65
+ ***
66
+
67
+ ### getAllRecords()?
68
+
69
+ > `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
70
+
71
+ #### Returns
72
+
73
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
74
+
75
+ #### Source
76
+
77
+ src/dataunit/DataUnit.ts:2070
64
78
 
65
79
  ***
66
80
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1912
70
84
 
71
85
  #### Source
72
86
 
73
- src/dataunit/DataUnit.ts:1910
87
+ src/dataunit/DataUnit.ts:2067
74
88
 
75
89
  ***
76
90
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1910
80
94
 
81
95
  #### Source
82
96
 
83
- src/dataunit/DataUnit.ts:1913
97
+ src/dataunit/DataUnit.ts:2069
84
98
 
85
99
  ## Accessors
86
100
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1913
94
108
 
95
109
  #### Source
96
110
 
97
- src/dataunit/DataUnit.ts:1940
111
+ src/dataunit/DataUnit.ts:2102
98
112
 
99
113
  ***
100
114
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1940
108
122
 
109
123
  #### Source
110
124
 
111
- src/dataunit/DataUnit.ts:1930
125
+ src/dataunit/DataUnit.ts:2092
112
126
 
113
127
  ***
114
128
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1930
122
136
 
123
137
  #### Source
124
138
 
125
- src/dataunit/DataUnit.ts:1923
139
+ src/dataunit/DataUnit.ts:2082
126
140
 
127
141
  ## Methods
128
142
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1923
136
150
 
137
151
  #### Source
138
152
 
139
- src/dataunit/DataUnit.ts:1947
153
+ src/dataunit/DataUnit.ts:2109
140
154
 
141
155
  ***
142
156
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1947
150
164
 
151
165
  #### Source
152
166
 
153
- src/dataunit/DataUnit.ts:1951
167
+ src/dataunit/DataUnit.ts:2113