@sankhyalabs/core-docs 5.20.0-dev.6 → 5.20.0-dev.61

package/classes/OverflowWatcher.md

@@ -0,0 +1,533 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverflowWatcher
+
+# Class: OverflowWatcher
+
+## Constructors
+
+### new OverflowWatcher()
+
+> **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
+
+Cria uma instancia do OverflowWatcher
+
+#### Parameters
+
+• **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
+
+#### Returns
+
+[`OverflowWatcher`](OverflowWatcher.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:35
+
+## Properties
+
+### DATA\_ELEMENT\_ID
+
+> `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:23
+
+***
+
+### \_deltaSize
+
+> `private` **\_deltaSize**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:20
+
+***
+
+### \_hiddenItemsProps
+
+> `private` **\_hiddenItemsProps**: `Map`\<`Element`, `SizeProps`\>
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:18
+
+***
+
+### \_lastContainerInstance
+
+> `private` **\_lastContainerInstance**: `undefined` \| `HTMLElement` = `undefined`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:15
+
+***
+
+### \_lastContainerSize
+
+> `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:14
+
+***
+
+### \_notOverFlow
+
+> `private` **\_notOverFlow**: `string`[] = `[]`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:21
+
+***
+
+### \_notOverFlowPros
+
+> `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:19
+
+***
+
+### \_onResize
+
+> `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:12
+
+***
+
+### \_propSize
+
+> `private` **\_propSize**: `string`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:17
+
+***
+
+### \_resizeObserver
+
+> `private` **\_resizeObserver**: `ResizeObserver`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:13
+
+***
+
+### \_scrollDirection
+
+> `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:16
+
+## Methods
+
+### addNotOverFlowElement()
+
+> **addNotOverFlowElement**(`elementId`): `void`
+
+#### Parameters
+
+• **elementId**: `string`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:52
+
+***
+
+### calcChildrenSize()
+
+> `private` **calcChildrenSize**(`children`): `number`
+
+#### Parameters
+
+• **children**: `Element`[]
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:205
+
+***
+
+### calcElementSize()
+
+> `private` **calcElementSize**(`el`): `number`
+
+#### Parameters
+
+• **el**: `Element`
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:212
+
+***
+
+### calculateVariation()
+
+> `private` **calculateVariation**(`elementIdsToCalculate`): `number`
+
+#### Parameters
+
+• **elementIdsToCalculate**: `string`[]
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:177
+
+***
+
+### canNotOverFlowNotIncludedIds()
+
+> `private` **canNotOverFlowNotIncludedIds**(`elements`): `string`[]
+
+#### Parameters
+
+• **elements**: `Element`[]
+
+#### Returns
+
+`string`[]
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:187
+
+***
+
+### canNotRegisterNotOverFlow()
+
+> `private` **canNotRegisterNotOverFlow**(`id`): `boolean`
+
+#### Parameters
+
+• **id**: `string`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:96
+
+***
+
+### canOverFlowElement()
+
+> `private` **canOverFlowElement**(`element`): `boolean`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:157
+
+***
+
+### clearOverFlow()
+
+> `private` **clearOverFlow**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:126
+
+***
+
+### destroy()
+
+> **destroy**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:58
+
+***
+
+### exceedsAvaliableSize()
+
+> `private` **exceedsAvaliableSize**(`sumElementsSize`, `elements`, `avaliableSize`): `boolean`
+
+#### Parameters
+
+• **sumElementsSize**: `number`
+
+• **elements**: `Element`[]
+
+• **avaliableSize**: `number`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:166
+
+***
+
+### forceUpdate()
+
+> **forceUpdate**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:62
+
+***
+
+### getDataElementId()
+
+> `private` **getDataElementId**(`element`): `string`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:162
+
+***
+
+### getElementSizeProps()
+
+> `private` **getElementSizeProps**(`element`): `SizeProps`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`SizeProps`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:197
+
+***
+
+### handleResize()
+
+> `private` **handleResize**(`entries`): `void`
+
+#### Parameters
+
+• **entries**: `ResizeObserverEntry`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:68
+
+***
+
+### hasChangedSize()
+
+> `private` **hasChangedSize**(`elementSize`): `boolean`
+
+#### Parameters
+
+• **elementSize**: `number`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:100
+
+***
+
+### isElementOverFlowing()
+
+> `private` **isElementOverFlowing**(`elementsThatFit`, `element`): `boolean`
+
+#### Parameters
+
+• **elementsThatFit**: `Element`[]
+
+• **element**: `Element`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:153
+
+***
+
+### isOverFlowed()
+
+> `private` **isOverFlowed**(`el`): `boolean`
+
+#### Parameters
+
+• **el**: `Element`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:226
+
+***
+
+### proccessElements()
+
+> `private` **proccessElements**(`elementSize`, `children`): `void`
+
+#### Parameters
+
+• **elementSize**: `number`
+
+• **children**: `Element`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:112
+
+***
+
+### proccessElementsOverFlow()
+
+> `private` **proccessElementsOverFlow**(`allElements`, `avaliableSize`): `void`
+
+#### Parameters
+
+• **allElements**: `Element`[]
+
+• **avaliableSize**: `number`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:131
+
+***
+
+### registerElementSize()
+
+> `private` **registerElementSize**(`element`): `void`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:192
+
+***
+
+### registerNotOverflowProps()
+
+> `private` **registerNotOverflowProps**(`children`): `void`
+
+#### Parameters
+
+• **children**: `Element`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:88
+
+***
+
+### updateOverFlowedItems()
+
+> `private` **updateOverFlowedItems**(`container`, `containerSize`): `void`
+
+#### Parameters
+
+• **container**: `HTMLElement`
+
+• **containerSize**: `number`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:80

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1914
+src/dataunit/DataUnit.ts:2035
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1914
 
 #### Source
 
-src/dataunit/DataUnit.ts:1908
+src/dataunit/DataUnit.ts:2032
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1908
 
 #### Source
 
-src/dataunit/DataUnit.ts:1910
+src/dataunit/DataUnit.ts:2033
 
 ***
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1910
 
 #### Source
 
-src/dataunit/DataUnit.ts:1911
+src/dataunit/DataUnit.ts:2029
+
+***
+
+### getAllRecords()?
+
+> `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/DataUnit.ts:2031
 
 ***
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1911
 
 #### Source
 
-src/dataunit/DataUnit.ts:1909
+src/dataunit/DataUnit.ts:2028
 
 ***
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1909
 
 #### Source
 
-src/dataunit/DataUnit.ts:1912
+src/dataunit/DataUnit.ts:2030
 
 ## Accessors
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1912
 
 #### Source
 
-src/dataunit/DataUnit.ts:1939
+src/dataunit/DataUnit.ts:2063
 
 ***
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1939
 
 #### Source
 
-src/dataunit/DataUnit.ts:1929
+src/dataunit/DataUnit.ts:2053
 
 ***
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1929
 
 #### Source
 
-src/dataunit/DataUnit.ts:1922
+src/dataunit/DataUnit.ts:2043
 
 ## Methods
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1922
 
 #### Source
 
-src/dataunit/DataUnit.ts:1946
+src/dataunit/DataUnit.ts:2070
 
 ***
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1946
 
 #### Source
 
-src/dataunit/DataUnit.ts:1950
+src/dataunit/DataUnit.ts:2074