@genesislcap/grid-tabulator 14.226.0 → 14.226.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.
- package/dist/dts/datasource/client-side.datasource.d.ts +72 -110
- package/dist/dts/datasource/client-side.datasource.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.d.ts +34 -50
- package/dist/dts/grid-tabulator.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.types.d.ts +1 -1
- package/dist/dts/grid-tabulator.types.d.ts.map +1 -1
- package/dist/dts/tsdoc-metadata.json +1 -1
- package/dist/esm/datasource/client-side.datasource.js +2 -2
- package/dist/grid-tabulator.api.json +119 -1585
- package/dist/grid-tabulator.d.ts +107 -161
- package/docs/api/grid-tabulator.foundationgridtabulatoractionrenderer.md +1 -11
- package/docs/api/grid-tabulator.md +4 -7
- package/docs/api/grid-tabulator.themefontsid.md +1 -14
- package/docs/api/grid-tabulator.themetokenmapclassname.md +1 -14
- package/docs/api/grid-tabulator.themetokenmapcss.md +1 -15
- package/docs/{api-report.md.api.md → api-report.md} +1 -3
- package/package.json +14 -14
- package/docs/api/grid-tabulator.foundationgridtabulator.md +0 -41
- package/docs/api/grid-tabulator.gridtabulator.autocellrendererbytype.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.classnames.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.downloaddataas.md +0 -27
- package/docs/api/grid-tabulator.gridtabulator.grid.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.griddiv.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.gridfontface.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.gridoptions.md +0 -30
- package/docs/api/grid-tabulator.gridtabulator.md +0 -40
- package/docs/api/grid-tabulator.gridtabulator.onlytemplatecoldefs.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.persistcolumnstatekey.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.rowdata.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.rowheight.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.setfilter.md +0 -27
- package/docs/api/grid-tabulator.gridtabulator.statepersistanceenabled.md +0 -14
- package/docs/api/grid-tabulator.gridtabulator.theme.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.auth.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.connect.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.criteria.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.datasource.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.deferredgridoptions.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.destroy.md +0 -17
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.fields.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.init.md +0 -21
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.issnapshot.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.maxrows.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.maxview.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.md +0 -49
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.movingview.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.orderby.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.pollinginterval.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.request.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.resourcename.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.restart.md +0 -17
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.restartonreconnection.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.reverse.md +0 -14
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.rowdatamapper.md +0 -16
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.rowidattr.md +0 -18
|
@@ -9,8 +9,6 @@
|
|
|
9
9
|
| Class | Description |
|
|
10
10
|
| --- | --- |
|
|
11
11
|
| [ActionRenderer](./grid-tabulator.actionrenderer.md) | The Tabulator Action Renderer element. |
|
|
12
|
-
| [GridTabulator](./grid-tabulator.gridtabulator.md) | **_(ALPHA)_** |
|
|
13
|
-
| [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) | **_(ALPHA)_** The Genesis Datasource element, for client-side data fetching and used exclusively by the GridTabulator element. |
|
|
14
12
|
|
|
15
13
|
## Enumerations
|
|
16
14
|
|
|
@@ -27,14 +25,9 @@
|
|
|
27
25
|
| [dateTimeValueFormatter({ value })](./grid-tabulator.datetimevalueformatter.md) | Format a date time value to a readable string. |
|
|
28
26
|
| [dateValueFormatter({ value })](./grid-tabulator.datevalueformatter.md) | Format a date value. |
|
|
29
27
|
| [formatDateExtra(epoch)](./grid-tabulator.formatdateextra.md) | Format am epoch value to a readable ISO date string. |
|
|
30
|
-
| [foundationGridTabulator(overrideDefinition)](./grid-tabulator.foundationgridtabulator.md) | **_(ALPHA)_** The Foundation grid-tabulator |
|
|
31
|
-
| [foundationGridTabulatorActionRenderer(overrideDefinition)](./grid-tabulator.foundationgridtabulatoractionrenderer.md) | A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem. |
|
|
32
28
|
| [getColumnType(metadataType)](./grid-tabulator.getcolumntype.md) | Get the column type based on the metadata type. |
|
|
33
29
|
| [getFilterByFieldType(type)](./grid-tabulator.getfilterbyfieldtype.md) | Get the filter type based on the field type. |
|
|
34
30
|
| [getFilterParamsByFieldType(type)](./grid-tabulator.getfilterparamsbyfieldtype.md) | Get the filter params based on the field type. |
|
|
35
|
-
| [themeFontsId(themeName)](./grid-tabulator.themefontsid.md) | Get the Fonts ID for the theme's name |
|
|
36
|
-
| [themeTokenMapClassname(themeName)](./grid-tabulator.themetokenmapclassname.md) | Get the token map class name for the <code>grid-tabulator</code> themes |
|
|
37
|
-
| [themeTokenMapCSS(themeName, tokenMap)](./grid-tabulator.themetokenmapcss.md) | Get the CSS for the theme's token map |
|
|
38
31
|
|
|
39
32
|
## Interfaces
|
|
40
33
|
|
|
@@ -48,6 +41,7 @@
|
|
|
48
41
|
| --- | --- |
|
|
49
42
|
| [actionHeightMultiplier](./grid-tabulator.actionheightmultiplier.md) | The base height multiplier for the action renderer. |
|
|
50
43
|
| [defaultGridTabulatorConfig](./grid-tabulator.defaultgridtabulatorconfig.md) | The default grid-tabulator configuration. |
|
|
44
|
+
| [foundationGridTabulatorActionRenderer](./grid-tabulator.foundationgridtabulatoractionrenderer.md) | A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem. |
|
|
51
45
|
| [foundationGridTabulatorComponents](./grid-tabulator.foundationgridtabulatorcomponents.md) | All <code>grid-tabulator</code> components. |
|
|
52
46
|
| [gridTabulatorShadowOptions](./grid-tabulator.gridtabulatorshadowoptions.md) | The grid-tabulator component registration. |
|
|
53
47
|
| [gridTabulatorStyles](./grid-tabulator.gridtabulatorstyles.md) | The styles for the grid-tabulator component |
|
|
@@ -56,6 +50,9 @@
|
|
|
56
50
|
| [tabulatorActionRendererStyles](./grid-tabulator.tabulatoractionrendererstyles.md) | The Tabulator Action Renderer Styles. |
|
|
57
51
|
| [tabulatorExternalStockStyles](./grid-tabulator.tabulatorexternalstockstyles.md) | External styles for the Tabulator grid. |
|
|
58
52
|
| [tabulatorThemeSimpleCSS](./grid-tabulator.tabulatorthemesimplecss.md) | External styles for the Tabulator grid. |
|
|
53
|
+
| [themeFontsId](./grid-tabulator.themefontsid.md) | Get the Fonts ID for the theme's name |
|
|
54
|
+
| [themeTokenMapClassname](./grid-tabulator.themetokenmapclassname.md) | Get the token map class name for the <code>grid-tabulator</code> themes |
|
|
55
|
+
| [themeTokenMapCSS](./grid-tabulator.themetokenmapcss.md) | Get the CSS for the theme's token map |
|
|
59
56
|
|
|
60
57
|
## Type Aliases
|
|
61
58
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [themeFontsId](./grid-tabulator.themefontsid.md)
|
|
4
4
|
|
|
5
|
-
## themeFontsId
|
|
5
|
+
## themeFontsId variable
|
|
6
6
|
|
|
7
7
|
Get the Fonts ID for the theme's name
|
|
8
8
|
|
|
@@ -11,16 +11,3 @@ Get the Fonts ID for the theme's name
|
|
|
11
11
|
```typescript
|
|
12
12
|
themeFontsId: (themeName: string) => string
|
|
13
13
|
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| themeName | string | The theme name |
|
|
20
|
-
|
|
21
|
-
**Returns:**
|
|
22
|
-
|
|
23
|
-
string
|
|
24
|
-
|
|
25
|
-
The theme's fonts ID
|
|
26
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [themeTokenMapClassname](./grid-tabulator.themetokenmapclassname.md)
|
|
4
4
|
|
|
5
|
-
## themeTokenMapClassname
|
|
5
|
+
## themeTokenMapClassname variable
|
|
6
6
|
|
|
7
7
|
Get the token map class name for the `grid-tabulator` themes
|
|
8
8
|
|
|
@@ -11,16 +11,3 @@ Get the token map class name for the `grid-tabulator` themes
|
|
|
11
11
|
```typescript
|
|
12
12
|
themeTokenMapClassname: (themeName: string) => string
|
|
13
13
|
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| themeName | string | The theme name |
|
|
20
|
-
|
|
21
|
-
**Returns:**
|
|
22
|
-
|
|
23
|
-
string
|
|
24
|
-
|
|
25
|
-
The token map class name for the `grid-tabulator` themes
|
|
26
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [themeTokenMapCSS](./grid-tabulator.themetokenmapcss.md)
|
|
4
4
|
|
|
5
|
-
## themeTokenMapCSS
|
|
5
|
+
## themeTokenMapCSS variable
|
|
6
6
|
|
|
7
7
|
Get the CSS for the theme's token map
|
|
8
8
|
|
|
@@ -11,17 +11,3 @@ Get the CSS for the theme's token map
|
|
|
11
11
|
```typescript
|
|
12
12
|
themeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => import("@microsoft/fast-element").ElementStyles
|
|
13
13
|
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| themeName | string | The theme name |
|
|
20
|
-
| tokenMap | CSSVarTokenMap<any> | The token map |
|
|
21
|
-
|
|
22
|
-
**Returns:**
|
|
23
|
-
|
|
24
|
-
import("@microsoft/fast-element").ElementStyles
|
|
25
|
-
|
|
26
|
-
The CSS for the theme's token map
|
|
27
|
-
|
|
@@ -4,8 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
|
-
/// <reference types="node" />
|
|
8
|
-
|
|
9
7
|
import { Auth } from '@genesislcap/foundation-comms';
|
|
10
8
|
import { Connect } from '@genesislcap/foundation-comms';
|
|
11
9
|
import type { Container } from '@microsoft/fast-foundation';
|
|
@@ -190,7 +188,7 @@ export enum GridTabulatorCellRendererTypes {
|
|
|
190
188
|
// (undocumented)
|
|
191
189
|
boolean = "boolean",
|
|
192
190
|
// (undocumented)
|
|
193
|
-
select = "select"
|
|
191
|
+
select = "select",
|
|
194
192
|
// (undocumented)
|
|
195
193
|
text = "text"
|
|
196
194
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/grid-tabulator",
|
|
3
3
|
"description": "Genesis Foundation Grid Tabulator",
|
|
4
|
-
"version": "14.226.
|
|
4
|
+
"version": "14.226.1",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -39,28 +39,28 @@
|
|
|
39
39
|
}
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@genesislcap/foundation-testing": "14.226.
|
|
43
|
-
"@genesislcap/genx": "14.226.
|
|
44
|
-
"@genesislcap/rollup-builder": "14.226.
|
|
45
|
-
"@genesislcap/ts-builder": "14.226.
|
|
46
|
-
"@genesislcap/uvu-playwright-builder": "14.226.
|
|
47
|
-
"@genesislcap/vite-builder": "14.226.
|
|
48
|
-
"@genesislcap/webpack-builder": "14.226.
|
|
42
|
+
"@genesislcap/foundation-testing": "14.226.1",
|
|
43
|
+
"@genesislcap/genx": "14.226.1",
|
|
44
|
+
"@genesislcap/rollup-builder": "14.226.1",
|
|
45
|
+
"@genesislcap/ts-builder": "14.226.1",
|
|
46
|
+
"@genesislcap/uvu-playwright-builder": "14.226.1",
|
|
47
|
+
"@genesislcap/vite-builder": "14.226.1",
|
|
48
|
+
"@genesislcap/webpack-builder": "14.226.1",
|
|
49
49
|
"@types/tabulator-tables": "6.2.3",
|
|
50
50
|
"rimraf": "^5.0.0"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
|
-
"@genesislcap/foundation-comms": "14.226.
|
|
54
|
-
"@genesislcap/foundation-logger": "14.226.
|
|
55
|
-
"@genesislcap/foundation-ui": "14.226.
|
|
56
|
-
"@genesislcap/foundation-utils": "14.226.
|
|
53
|
+
"@genesislcap/foundation-comms": "14.226.1",
|
|
54
|
+
"@genesislcap/foundation-logger": "14.226.1",
|
|
55
|
+
"@genesislcap/foundation-ui": "14.226.1",
|
|
56
|
+
"@genesislcap/foundation-utils": "14.226.1",
|
|
57
57
|
"@microsoft/fast-colors": "5.3.1",
|
|
58
58
|
"@microsoft/fast-components": "2.30.6",
|
|
59
59
|
"@microsoft/fast-element": "1.14.0",
|
|
60
60
|
"@microsoft/fast-foundation": "2.49.6",
|
|
61
61
|
"@microsoft/fast-web-utilities": "5.4.1",
|
|
62
62
|
"rxjs": "^7.5.4",
|
|
63
|
-
"tslib": "2.
|
|
63
|
+
"tslib": "^2.3.1"
|
|
64
64
|
},
|
|
65
65
|
"peerDependencies": {
|
|
66
66
|
"tabulator-tables": "6.3.0"
|
|
@@ -74,5 +74,5 @@
|
|
|
74
74
|
"access": "public"
|
|
75
75
|
},
|
|
76
76
|
"customElements": "dist/custom-elements.json",
|
|
77
|
-
"gitHead": "
|
|
77
|
+
"gitHead": "e691c1741d135edca5271f338f62df8154efb99c"
|
|
78
78
|
}
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [foundationGridTabulator](./grid-tabulator.foundationgridtabulator.md)
|
|
4
|
-
|
|
5
|
-
## foundationGridTabulator() function
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
The Foundation grid-tabulator
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
foundationGridTabulator: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
16
|
-
shadowOptions: any;
|
|
17
|
-
baseName: string;
|
|
18
|
-
styles: import("@microsoft/fast-element").ElementStyles;
|
|
19
|
-
template: import("@microsoft/fast-element").ViewTemplate<any, any>;
|
|
20
|
-
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
21
|
-
shadowOptions: any;
|
|
22
|
-
baseName: string;
|
|
23
|
-
styles: import("@microsoft/fast-element").ElementStyles;
|
|
24
|
-
template: import("@microsoft/fast-element").ViewTemplate<any, any>;
|
|
25
|
-
}, typeof GridTabulator>
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## Parameters
|
|
29
|
-
|
|
30
|
-
| Parameter | Type | Description |
|
|
31
|
-
| --- | --- | --- |
|
|
32
|
-
| overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{ shadowOptions: any; baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate<any, any>; }> | _(Optional)_ |
|
|
33
|
-
|
|
34
|
-
**Returns:**
|
|
35
|
-
|
|
36
|
-
import("@microsoft/fast-foundation").FoundationElementRegistry<{ shadowOptions: any; baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate<any, any>; }, typeof [GridTabulator](./grid-tabulator.gridtabulator.md)<!-- -->>
|
|
37
|
-
|
|
38
|
-
## Remarks
|
|
39
|
-
|
|
40
|
-
HTML Element: <<!-- -->grid-tabulator<!-- -->>
|
|
41
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [autoCellRendererByType](./grid-tabulator.gridtabulator.autocellrendererbytype.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.autoCellRendererByType property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
autoCellRendererByType: boolean;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [classNames](./grid-tabulator.gridtabulator.classnames.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.classNames property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
classNames: string;
|
|
14
|
-
```
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [downloadDataAs](./grid-tabulator.gridtabulator.downloaddataas.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.downloadDataAs() method
|
|
6
|
-
|
|
7
|
-
Download the Grid data as a file of the specified type.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
downloadDataAs(type: 'csv' | 'json' | 'html', fileName: string, params?: DownloadOptions, filter?: RowRangeLookup): void;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| type | 'csv' \| 'json' \| 'html' | csv \| json \| html |
|
|
20
|
-
| fileName | string | name of the file to download |
|
|
21
|
-
| params | DownloadOptions | _(Optional)_ optional download params |
|
|
22
|
-
| filter | RowRangeLookup | _(Optional)_ optional row range lookup filter |
|
|
23
|
-
|
|
24
|
-
**Returns:**
|
|
25
|
-
|
|
26
|
-
void
|
|
27
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [grid](./grid-tabulator.gridtabulator.grid.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.grid property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
grid: Tabulator | undefined;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [gridDiv](./grid-tabulator.gridtabulator.griddiv.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.gridDiv property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
gridDiv: HTMLDivElement;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [gridFontFace](./grid-tabulator.gridtabulator.gridfontface.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.gridFontFace property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
gridFontFace: string;
|
|
14
|
-
```
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [gridOptions](./grid-tabulator.gridtabulator.gridoptions.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.gridOptions property
|
|
6
|
-
|
|
7
|
-
The current grid options.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
get gridOptions(): Options;
|
|
13
|
-
|
|
14
|
-
set gridOptions(options: Options);
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Remarks
|
|
18
|
-
|
|
19
|
-
See https://tabulator.info/docs/6.3/options for more details.
|
|
20
|
-
|
|
21
|
-
## Example
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
```ts
|
|
25
|
-
...
|
|
26
|
-
const options = this.grid.getOptions();
|
|
27
|
-
logger.debug(options); // { data: [...], columns: [...], filterMode: "local", groupBy: false, ... }
|
|
28
|
-
...
|
|
29
|
-
```
|
|
30
|
-
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator class
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
export declare class GridTabulator extends GridTabulator_base
|
|
14
|
-
```
|
|
15
|
-
**Extends:** GridTabulator\_base
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
| Property | Modifiers | Type | Description |
|
|
20
|
-
| --- | --- | --- | --- |
|
|
21
|
-
| [autoCellRendererByType](./grid-tabulator.gridtabulator.autocellrendererbytype.md) | | boolean | **_(ALPHA)_** |
|
|
22
|
-
| [classNames](./grid-tabulator.gridtabulator.classnames.md) | | string | **_(ALPHA)_** |
|
|
23
|
-
| [grid](./grid-tabulator.gridtabulator.grid.md) | | Tabulator \| undefined | **_(ALPHA)_** |
|
|
24
|
-
| [gridDiv](./grid-tabulator.gridtabulator.griddiv.md) | | HTMLDivElement | **_(ALPHA)_** |
|
|
25
|
-
| [gridFontFace](./grid-tabulator.gridtabulator.gridfontface.md) | | string | **_(ALPHA)_** |
|
|
26
|
-
| [gridOptions](./grid-tabulator.gridtabulator.gridoptions.md) | | Options | The current grid options. |
|
|
27
|
-
| [onlyTemplateColDefs](./grid-tabulator.gridtabulator.onlytemplatecoldefs.md) | | boolean | **_(ALPHA)_** |
|
|
28
|
-
| [persistColumnStateKey](./grid-tabulator.gridtabulator.persistcolumnstatekey.md) | | string | **_(ALPHA)_** |
|
|
29
|
-
| [rowData](./grid-tabulator.gridtabulator.rowdata.md) | | any\[\] | **_(ALPHA)_** |
|
|
30
|
-
| [rowHeight](./grid-tabulator.gridtabulator.rowheight.md) | | number | **_(ALPHA)_** |
|
|
31
|
-
| [statePersistanceEnabled](./grid-tabulator.gridtabulator.statepersistanceenabled.md) | <code>readonly</code> | boolean | **_(ALPHA)_** |
|
|
32
|
-
| [theme](./grid-tabulator.gridtabulator.theme.md) | | string | **_(ALPHA)_** |
|
|
33
|
-
|
|
34
|
-
## Methods
|
|
35
|
-
|
|
36
|
-
| Method | Modifiers | Description |
|
|
37
|
-
| --- | --- | --- |
|
|
38
|
-
| [downloadDataAs(type, fileName, params, filter)](./grid-tabulator.gridtabulator.downloaddataas.md) | | Download the Grid data as a file of the specified type. |
|
|
39
|
-
| [setFilter(column, operator, value, filterParams)](./grid-tabulator.gridtabulator.setfilter.md) | | Set the Grid client-side filters. |
|
|
40
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [onlyTemplateColDefs](./grid-tabulator.gridtabulator.onlytemplatecoldefs.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.onlyTemplateColDefs property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
onlyTemplateColDefs: boolean;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [persistColumnStateKey](./grid-tabulator.gridtabulator.persistcolumnstatekey.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.persistColumnStateKey property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
persistColumnStateKey: string;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [rowData](./grid-tabulator.gridtabulator.rowdata.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.rowData property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
rowData: any[];
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [rowHeight](./grid-tabulator.gridtabulator.rowheight.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.rowHeight property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
rowHeight: number;
|
|
14
|
-
```
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [setFilter](./grid-tabulator.gridtabulator.setfilter.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.setFilter() method
|
|
6
|
-
|
|
7
|
-
Set the Grid client-side filters.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
setFilter(column: string, operator: string, value: string, filterParams?: FilterParams): void;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| column | string | column name |
|
|
20
|
-
| operator | string | filter operator |
|
|
21
|
-
| value | string | filter value |
|
|
22
|
-
| filterParams | FilterParams | _(Optional)_ optional filter params |
|
|
23
|
-
|
|
24
|
-
**Returns:**
|
|
25
|
-
|
|
26
|
-
void
|
|
27
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [statePersistanceEnabled](./grid-tabulator.gridtabulator.statepersistanceenabled.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.statePersistanceEnabled property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
get statePersistanceEnabled(): boolean;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulator](./grid-tabulator.gridtabulator.md) > [theme](./grid-tabulator.gridtabulator.theme.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulator.theme property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
theme: string;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [auth](./grid-tabulator.gridtabulatorclientsidedatasource.auth.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.auth property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
auth: Auth;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [connect](./grid-tabulator.gridtabulatorclientsidedatasource.connect.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.connect property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
connect: Connect;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [criteria](./grid-tabulator.gridtabulatorclientsidedatasource.criteria.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.criteria property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
criteria: string;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [datasource](./grid-tabulator.gridtabulatorclientsidedatasource.datasource.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.datasource property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
datasource: Datasource;
|
|
14
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [deferredGridOptions](./grid-tabulator.gridtabulatorclientsidedatasource.deferredgridoptions.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.deferredGridOptions property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
deferredGridOptions: Options;
|
|
14
|
-
```
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [destroy](./grid-tabulator.gridtabulatorclientsidedatasource.destroy.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.destroy() method
|
|
6
|
-
|
|
7
|
-
Destroys the datasource, resetting it to its initial state.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
destroy(): void;
|
|
13
|
-
```
|
|
14
|
-
**Returns:**
|
|
15
|
-
|
|
16
|
-
void
|
|
17
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [fields](./grid-tabulator.gridtabulatorclientsidedatasource.fields.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.fields property
|
|
6
|
-
|
|
7
|
-
> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
fields: string;
|
|
14
|
-
```
|