@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
|
@@ -1,21 +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) > [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
|
-
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [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
|
-
```
|
|
@@ -1,49 +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)
|
|
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
|
-
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [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
|
-
```
|
|
@@ -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) > [restart](./grid-tabulator.gridtabulatorclientsidedatasource.restart.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.restart() method
|
|
6
|
-
|
|
7
|
-
Restarts the datasource, uses `deinit` and `init` in sequence.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
restart(): 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) > [restartOnReconnection](./grid-tabulator.gridtabulatorclientsidedatasource.restartonreconnection.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.restartOnReconnection 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
|
-
restartOnReconnection: 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) > [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) > [reverse](./grid-tabulator.gridtabulatorclientsidedatasource.reverse.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.reverse 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
|
-
reverse: boolean;
|
|
14
|
-
```
|
|
@@ -1,16 +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) > [rowDataMapper](./grid-tabulator.gridtabulatorclientsidedatasource.rowdatamapper.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.rowDataMapper 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
|
-
Allows grid data updates to be processed via and external function before applying in grid
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
rowDataMapper: Function;
|
|
16
|
-
```
|
|
@@ -1,18 +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) > [rowIdAttr](./grid-tabulator.gridtabulatorclientsidedatasource.rowidattr.md)
|
|
4
|
-
|
|
5
|
-
## GridTabulatorClientSideDatasource.rowIdAttr 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
|
-
Attribute to set an unique identifier for the row.
|
|
11
|
-
|
|
12
|
-
Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
rowIdAttr: any;
|
|
18
|
-
```
|