@genesislcap/grid-tabulator 14.225.3 → 14.225.4-alpha-5f6eefd.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.
- package/dist/dts/datasource/client-side.datasource.d.ts +110 -72
- package/dist/dts/datasource/client-side.datasource.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.d.ts +50 -34
- 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 +1585 -119
- package/dist/grid-tabulator.d.ts +161 -107
- package/docs/api/grid-tabulator.foundationgridtabulator.md +41 -0
- package/docs/api/grid-tabulator.foundationgridtabulatoractionrenderer.md +11 -1
- package/docs/api/grid-tabulator.gridtabulator.autocellrendererbytype.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.classnames.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.downloaddataas.md +27 -0
- package/docs/api/grid-tabulator.gridtabulator.grid.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.griddiv.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.gridfontface.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.gridoptions.md +30 -0
- package/docs/api/grid-tabulator.gridtabulator.md +40 -0
- package/docs/api/grid-tabulator.gridtabulator.onlytemplatecoldefs.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.persistcolumnstatekey.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.rowdata.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.rowheight.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.setfilter.md +27 -0
- package/docs/api/grid-tabulator.gridtabulator.statepersistanceenabled.md +14 -0
- package/docs/api/grid-tabulator.gridtabulator.theme.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.auth.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.connect.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.criteria.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.datasource.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.deferredgridoptions.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.destroy.md +17 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.fields.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.init.md +21 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.issnapshot.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.maxrows.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.maxview.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.md +49 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.movingview.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.orderby.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.pollinginterval.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.request.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.resourcename.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.restart.md +17 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.restartonreconnection.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.reverse.md +14 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.rowdatamapper.md +16 -0
- package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.rowidattr.md +18 -0
- package/docs/api/grid-tabulator.md +7 -4
- package/docs/api/grid-tabulator.themefontsid.md +14 -1
- package/docs/api/grid-tabulator.themetokenmapclassname.md +14 -1
- package/docs/api/grid-tabulator.themetokenmapcss.md +15 -1
- package/docs/{api-report.md → api-report.md.api.md} +3 -1
- package/package.json +14 -14
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/grid-tabulator](./grid-tabulator.md) > [foundationGridTabulatorActionRenderer](./grid-tabulator.foundationgridtabulatoractionrenderer.md)
|
|
4
4
|
|
|
5
|
-
## foundationGridTabulatorActionRenderer
|
|
5
|
+
## foundationGridTabulatorActionRenderer() function
|
|
6
6
|
|
|
7
7
|
A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
|
|
8
8
|
|
|
@@ -20,6 +20,16 @@ foundationGridTabulatorActionRenderer: (overrideDefinition?: import("@microsoft/
|
|
|
20
20
|
}, typeof ActionRenderer>
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
## Parameters
|
|
24
|
+
|
|
25
|
+
| Parameter | Type | Description |
|
|
26
|
+
| --- | --- | --- |
|
|
27
|
+
| overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate<[ActionRenderer](./grid-tabulator.actionrenderer.md)<!-- -->, any>; }> | _(Optional)_ |
|
|
28
|
+
|
|
29
|
+
**Returns:**
|
|
30
|
+
|
|
31
|
+
import("@microsoft/fast-foundation").FoundationElementRegistry<{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate<[ActionRenderer](./grid-tabulator.actionrenderer.md)<!-- -->, any>; }, typeof [ActionRenderer](./grid-tabulator.actionrenderer.md)<!-- -->>
|
|
32
|
+
|
|
23
33
|
## Remarks
|
|
24
34
|
|
|
25
35
|
HTML Element: <<!-- -->foundation-grid-tabulator-action-renderer<!-- -->>
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,30 @@
|
|
|
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
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
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
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
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) > [init](./grid-tabulator.gridtabulatorclientsidedatasource.init.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.init() method
|
|
6
|
+
|
|
7
|
+
Initializes the datasource.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
init(): Promise<void>;
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
Promise<void>
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
This method is called automatically when the element is connected to the DOM.
|
|
21
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [isSnapshot](./grid-tabulator.gridtabulatorclientsidedatasource.issnapshot.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.isSnapshot 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
|
+
isSnapshot: boolean;
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [maxRows](./grid-tabulator.gridtabulatorclientsidedatasource.maxrows.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.maxRows 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
|
+
maxRows: number;
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [maxView](./grid-tabulator.gridtabulatorclientsidedatasource.maxview.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.maxView 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
|
+
maxView: number;
|
|
14
|
+
```
|
|
@@ -0,0 +1,49 @@
|
|
|
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)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource 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
|
+
The Genesis Datasource element, for client-side data fetching and used exclusively by the GridTabulator element.
|
|
11
|
+
|
|
12
|
+
**Signature:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
export declare class GridTabulatorClientSideDatasource extends GridTabulatorClientSideDatasource_base
|
|
16
|
+
```
|
|
17
|
+
**Extends:** GridTabulatorClientSideDatasource\_base
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
| Property | Modifiers | Type | Description |
|
|
22
|
+
| --- | --- | --- | --- |
|
|
23
|
+
| [auth](./grid-tabulator.gridtabulatorclientsidedatasource.auth.md) | | Auth | **_(ALPHA)_** |
|
|
24
|
+
| [connect](./grid-tabulator.gridtabulatorclientsidedatasource.connect.md) | | Connect | **_(ALPHA)_** |
|
|
25
|
+
| [criteria](./grid-tabulator.gridtabulatorclientsidedatasource.criteria.md) | | string | **_(ALPHA)_** |
|
|
26
|
+
| [datasource](./grid-tabulator.gridtabulatorclientsidedatasource.datasource.md) | | Datasource | **_(ALPHA)_** |
|
|
27
|
+
| [deferredGridOptions](./grid-tabulator.gridtabulatorclientsidedatasource.deferredgridoptions.md) | | Options | **_(ALPHA)_** |
|
|
28
|
+
| [fields](./grid-tabulator.gridtabulatorclientsidedatasource.fields.md) | | string | **_(ALPHA)_** |
|
|
29
|
+
| [isSnapshot](./grid-tabulator.gridtabulatorclientsidedatasource.issnapshot.md) | | boolean | **_(ALPHA)_** |
|
|
30
|
+
| [maxRows](./grid-tabulator.gridtabulatorclientsidedatasource.maxrows.md) | | number | **_(ALPHA)_** |
|
|
31
|
+
| [maxView](./grid-tabulator.gridtabulatorclientsidedatasource.maxview.md) | | number | **_(ALPHA)_** |
|
|
32
|
+
| [movingView](./grid-tabulator.gridtabulatorclientsidedatasource.movingview.md) | | boolean | **_(ALPHA)_** |
|
|
33
|
+
| [orderBy](./grid-tabulator.gridtabulatorclientsidedatasource.orderby.md) | | string | **_(ALPHA)_** |
|
|
34
|
+
| [pollingInterval](./grid-tabulator.gridtabulatorclientsidedatasource.pollinginterval.md) | | number | **_(ALPHA)_** |
|
|
35
|
+
| [request](./grid-tabulator.gridtabulatorclientsidedatasource.request.md) | | any | **_(ALPHA)_** |
|
|
36
|
+
| [resourceName](./grid-tabulator.gridtabulatorclientsidedatasource.resourcename.md) | | string | **_(ALPHA)_** |
|
|
37
|
+
| [restartOnReconnection](./grid-tabulator.gridtabulatorclientsidedatasource.restartonreconnection.md) | | boolean | **_(ALPHA)_** |
|
|
38
|
+
| [reverse](./grid-tabulator.gridtabulatorclientsidedatasource.reverse.md) | | boolean | **_(ALPHA)_** |
|
|
39
|
+
| [rowDataMapper](./grid-tabulator.gridtabulatorclientsidedatasource.rowdatamapper.md) | | Function | **_(ALPHA)_** Allows grid data updates to be processed via and external function before applying in grid |
|
|
40
|
+
| [rowIdAttr](./grid-tabulator.gridtabulatorclientsidedatasource.rowidattr.md) | | any | <p>**_(ALPHA)_** Attribute to set an unique identifier for the row.</p><p>Defaults to <code>ROW_REF</code> or <code>RECORD_ID</code> depending on the resource type.</p> |
|
|
41
|
+
|
|
42
|
+
## Methods
|
|
43
|
+
|
|
44
|
+
| Method | Modifiers | Description |
|
|
45
|
+
| --- | --- | --- |
|
|
46
|
+
| [destroy()](./grid-tabulator.gridtabulatorclientsidedatasource.destroy.md) | | Destroys the datasource, resetting it to its initial state. |
|
|
47
|
+
| [init()](./grid-tabulator.gridtabulatorclientsidedatasource.init.md) | | Initializes the datasource. |
|
|
48
|
+
| [restart()](./grid-tabulator.gridtabulatorclientsidedatasource.restart.md) | | Restarts the datasource, uses <code>deinit</code> and <code>init</code> in sequence. |
|
|
49
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [movingView](./grid-tabulator.gridtabulatorclientsidedatasource.movingview.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.movingView 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
|
+
movingView: boolean;
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [orderBy](./grid-tabulator.gridtabulatorclientsidedatasource.orderby.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.orderBy 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
|
+
orderBy: string;
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [pollingInterval](./grid-tabulator.gridtabulatorclientsidedatasource.pollinginterval.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.pollingInterval 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
|
+
pollingInterval: number;
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [request](./grid-tabulator.gridtabulatorclientsidedatasource.request.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.request 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
|
+
request: any;
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
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) > [resourceName](./grid-tabulator.gridtabulatorclientsidedatasource.resourcename.md)
|
|
4
|
+
|
|
5
|
+
## GridTabulatorClientSideDatasource.resourceName 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
|
+
resourceName: string;
|
|
14
|
+
```
|