-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5b2fad4
commit 3f83993
Showing
544 changed files
with
26,015 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_count | ||
title: aggregationFn_count | ||
--- | ||
|
||
# Function: aggregationFn\_count() | ||
|
||
```ts | ||
function aggregationFn_count( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L162) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_extent | ||
title: aggregationFn_extent | ||
--- | ||
|
||
# Function: aggregationFn\_extent() | ||
|
||
```ts | ||
function aggregationFn_extent( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L70) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_max | ||
title: aggregationFn_max | ||
--- | ||
|
||
# Function: aggregationFn\_max() | ||
|
||
```ts | ||
function aggregationFn_max( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L47) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_mean | ||
title: aggregationFn_mean | ||
--- | ||
|
||
# Function: aggregationFn\_mean() | ||
|
||
```ts | ||
function aggregationFn_mean( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L96) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_median | ||
title: aggregationFn_median | ||
--- | ||
|
||
# Function: aggregationFn\_median() | ||
|
||
```ts | ||
function aggregationFn_median( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L118) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_min | ||
title: aggregationFn_min | ||
--- | ||
|
||
# Function: aggregationFn\_min() | ||
|
||
```ts | ||
function aggregationFn_min( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L23) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_sum | ||
title: aggregationFn_sum | ||
--- | ||
|
||
# Function: aggregationFn\_sum() | ||
|
||
```ts | ||
function aggregationFn_sum( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L7) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_unique | ||
title: aggregationFn_unique | ||
--- | ||
|
||
# Function: aggregationFn\_unique() | ||
|
||
```ts | ||
function aggregationFn_unique( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:142](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L142) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
id: aggregationFn_uniqueCount | ||
title: aggregationFn_uniqueCount | ||
--- | ||
|
||
# Function: aggregationFn\_uniqueCount() | ||
|
||
```ts | ||
function aggregationFn_uniqueCount( | ||
columnId, | ||
leafRows, | ||
childRows): any | ||
``` | ||
|
||
## Parameters | ||
|
||
• **columnId**: `string` | ||
|
||
• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[fns/aggregationFns.ts:152](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L152) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
id: assignAPIs | ||
title: assignAPIs | ||
--- | ||
|
||
# Function: assignAPIs() | ||
|
||
```ts | ||
function assignAPIs<TFeatures, TData, TObject, TDeps, TDepArgs>(obj, apis): void | ||
``` | ||
|
||
Takes a static function, looks at its name and assigns it to an object with optional memoization and debugging. | ||
|
||
## Type Parameters | ||
|
||
• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> | ||
|
||
• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) | ||
|
||
• **TObject** *extends* `Record`\<`string`, `any`\> | ||
|
||
• **TDeps** *extends* readonly `any`[] | ||
|
||
• **TDepArgs** | ||
|
||
## Parameters | ||
|
||
• **obj**: `TObject` *extends* `Record`\<`string`, `U`\> ? `U` : `never` | ||
|
||
• **apis**: `API`\<`TDeps`, [`NoInfer`](../type-aliases/noinfer.md)\<`TDepArgs`\>\>[] | ||
|
||
## Returns | ||
|
||
`void` | ||
|
||
## Defined in | ||
|
||
[utils.ts:201](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L201) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
id: buildHeaderGroups | ||
title: buildHeaderGroups | ||
--- | ||
|
||
# Function: buildHeaderGroups() | ||
|
||
```ts | ||
function buildHeaderGroups<TFeatures, TData, TValue>( | ||
allColumns, | ||
columnsToGroup, | ||
table, | ||
headerFamily?): HeaderGroup<TFeatures, TData>[] | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> | ||
|
||
• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) | ||
|
||
• **TValue** *extends* `unknown` = `unknown` | ||
|
||
## Parameters | ||
|
||
• **allColumns**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] | ||
|
||
• **columnsToGroup**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] | ||
|
||
• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> | ||
|
||
• **headerFamily?**: `"left"` \| `"right"` \| `"center"` | ||
|
||
## Returns | ||
|
||
[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] | ||
|
||
## Defined in | ||
|
||
[core/headers/buildHeaderGroups.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/buildHeaderGroups.ts#L10) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
id: callMemoOrStaticFn | ||
title: callMemoOrStaticFn | ||
--- | ||
|
||
# Function: callMemoOrStaticFn() | ||
|
||
```ts | ||
function callMemoOrStaticFn<TFeatures, TData>( | ||
obj, | ||
staticFn, | ||
args): any | ||
``` | ||
|
||
Looks to run the memoized function with the builder pattern on the object if it exists, otherwise fallback to the static method passed in. | ||
|
||
## Type Parameters | ||
|
||
• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> | ||
|
||
• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) | ||
|
||
## Parameters | ||
|
||
• **obj**: | ||
\| [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> | ||
\| [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> | ||
\| [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`\> | ||
\| [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`\> | ||
\| [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`\> | ||
|
||
• **staticFn**: `AnyFunction` | ||
|
||
• **args**: `any`[] | ||
|
||
## Returns | ||
|
||
`any` | ||
|
||
## Defined in | ||
|
||
[utils.ts:234](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L234) |
Oops, something went wrong.