@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.
Files changed (55) hide show
  1. package/dist/dts/datasource/client-side.datasource.d.ts +110 -72
  2. package/dist/dts/datasource/client-side.datasource.d.ts.map +1 -1
  3. package/dist/dts/grid-tabulator.d.ts +50 -34
  4. package/dist/dts/grid-tabulator.d.ts.map +1 -1
  5. package/dist/dts/grid-tabulator.types.d.ts +1 -1
  6. package/dist/dts/grid-tabulator.types.d.ts.map +1 -1
  7. package/dist/dts/tsdoc-metadata.json +1 -1
  8. package/dist/esm/datasource/client-side.datasource.js +2 -2
  9. package/dist/grid-tabulator.api.json +1585 -119
  10. package/dist/grid-tabulator.d.ts +161 -107
  11. package/docs/api/grid-tabulator.foundationgridtabulator.md +41 -0
  12. package/docs/api/grid-tabulator.foundationgridtabulatoractionrenderer.md +11 -1
  13. package/docs/api/grid-tabulator.gridtabulator.autocellrendererbytype.md +14 -0
  14. package/docs/api/grid-tabulator.gridtabulator.classnames.md +14 -0
  15. package/docs/api/grid-tabulator.gridtabulator.downloaddataas.md +27 -0
  16. package/docs/api/grid-tabulator.gridtabulator.grid.md +14 -0
  17. package/docs/api/grid-tabulator.gridtabulator.griddiv.md +14 -0
  18. package/docs/api/grid-tabulator.gridtabulator.gridfontface.md +14 -0
  19. package/docs/api/grid-tabulator.gridtabulator.gridoptions.md +30 -0
  20. package/docs/api/grid-tabulator.gridtabulator.md +40 -0
  21. package/docs/api/grid-tabulator.gridtabulator.onlytemplatecoldefs.md +14 -0
  22. package/docs/api/grid-tabulator.gridtabulator.persistcolumnstatekey.md +14 -0
  23. package/docs/api/grid-tabulator.gridtabulator.rowdata.md +14 -0
  24. package/docs/api/grid-tabulator.gridtabulator.rowheight.md +14 -0
  25. package/docs/api/grid-tabulator.gridtabulator.setfilter.md +27 -0
  26. package/docs/api/grid-tabulator.gridtabulator.statepersistanceenabled.md +14 -0
  27. package/docs/api/grid-tabulator.gridtabulator.theme.md +14 -0
  28. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.auth.md +14 -0
  29. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.connect.md +14 -0
  30. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.criteria.md +14 -0
  31. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.datasource.md +14 -0
  32. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.deferredgridoptions.md +14 -0
  33. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.destroy.md +17 -0
  34. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.fields.md +14 -0
  35. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.init.md +21 -0
  36. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.issnapshot.md +14 -0
  37. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.maxrows.md +14 -0
  38. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.maxview.md +14 -0
  39. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.md +49 -0
  40. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.movingview.md +14 -0
  41. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.orderby.md +14 -0
  42. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.pollinginterval.md +14 -0
  43. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.request.md +14 -0
  44. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.resourcename.md +14 -0
  45. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.restart.md +17 -0
  46. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.restartonreconnection.md +14 -0
  47. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.reverse.md +14 -0
  48. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.rowdatamapper.md +16 -0
  49. package/docs/api/grid-tabulator.gridtabulatorclientsidedatasource.rowidattr.md +18 -0
  50. package/docs/api/grid-tabulator.md +7 -4
  51. package/docs/api/grid-tabulator.themefontsid.md +14 -1
  52. package/docs/api/grid-tabulator.themetokenmapclassname.md +14 -1
  53. package/docs/api/grid-tabulator.themetokenmapcss.md +15 -1
  54. package/docs/{api-report.md → api-report.md.api.md} +3 -1
  55. package/package.json +14 -14
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) &gt; [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
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) &gt; [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
+ ```
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) &gt; [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
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) &gt; [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
+ ```
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulatorClientSideDatasource](./grid-tabulator.gridtabulatorclientsidedatasource.md) &gt; [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
+ ```
@@ -9,6 +9,8 @@
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. |
12
14
 
13
15
  ## Enumerations
14
16
 
@@ -25,9 +27,14 @@
25
27
  | [dateTimeValueFormatter({ value })](./grid-tabulator.datetimevalueformatter.md) | Format a date time value to a readable string. |
26
28
  | [dateValueFormatter({ value })](./grid-tabulator.datevalueformatter.md) | Format a date value. |
27
29
  | [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. |
28
32
  | [getColumnType(metadataType)](./grid-tabulator.getcolumntype.md) | Get the column type based on the metadata type. |
29
33
  | [getFilterByFieldType(type)](./grid-tabulator.getfilterbyfieldtype.md) | Get the filter type based on the field type. |
30
34
  | [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 |
31
38
 
32
39
  ## Interfaces
33
40
 
@@ -41,7 +48,6 @@
41
48
  | --- | --- |
42
49
  | [actionHeightMultiplier](./grid-tabulator.actionheightmultiplier.md) | The base height multiplier for the action renderer. |
43
50
  | [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. |
45
51
  | [foundationGridTabulatorComponents](./grid-tabulator.foundationgridtabulatorcomponents.md) | All <code>grid-tabulator</code> components. |
46
52
  | [gridTabulatorShadowOptions](./grid-tabulator.gridtabulatorshadowoptions.md) | The grid-tabulator component registration. |
47
53
  | [gridTabulatorStyles](./grid-tabulator.gridtabulatorstyles.md) | The styles for the grid-tabulator component |
@@ -50,9 +56,6 @@
50
56
  | [tabulatorActionRendererStyles](./grid-tabulator.tabulatoractionrendererstyles.md) | The Tabulator Action Renderer Styles. |
51
57
  | [tabulatorExternalStockStyles](./grid-tabulator.tabulatorexternalstockstyles.md) | External styles for the Tabulator grid. |
52
58
  | [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 |
56
59
 
57
60
  ## Type Aliases
58
61
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [themeFontsId](./grid-tabulator.themefontsid.md)
4
4
 
5
- ## themeFontsId variable
5
+ ## themeFontsId() function
6
6
 
7
7
  Get the Fonts ID for the theme's name
8
8
 
@@ -11,3 +11,16 @@ 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) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [themeTokenMapClassname](./grid-tabulator.themetokenmapclassname.md)
4
4
 
5
- ## themeTokenMapClassname variable
5
+ ## themeTokenMapClassname() function
6
6
 
7
7
  Get the token map class name for the `grid-tabulator` themes
8
8
 
@@ -11,3 +11,16 @@ 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) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [themeTokenMapCSS](./grid-tabulator.themetokenmapcss.md)
4
4
 
5
- ## themeTokenMapCSS variable
5
+ ## themeTokenMapCSS() function
6
6
 
7
7
  Get the CSS for the theme's token map
8
8
 
@@ -11,3 +11,17 @@ 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&lt;any&gt; | 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,6 +4,8 @@
4
4
 
5
5
  ```ts
6
6
 
7
+ /// <reference types="node" />
8
+
7
9
  import { Auth } from '@genesislcap/foundation-comms';
8
10
  import { Connect } from '@genesislcap/foundation-comms';
9
11
  import type { Container } from '@microsoft/fast-foundation';
@@ -188,7 +190,7 @@ export enum GridTabulatorCellRendererTypes {
188
190
  // (undocumented)
189
191
  boolean = "boolean",
190
192
  // (undocumented)
191
- select = "select",
193
+ select = "select",// TODO: textField :(
192
194
  // (undocumented)
193
195
  text = "text"
194
196
  }
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.225.3",
4
+ "version": "14.225.4-alpha-5f6eefd.0",
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.225.3",
43
- "@genesislcap/genx": "14.225.3",
44
- "@genesislcap/rollup-builder": "14.225.3",
45
- "@genesislcap/ts-builder": "14.225.3",
46
- "@genesislcap/uvu-playwright-builder": "14.225.3",
47
- "@genesislcap/vite-builder": "14.225.3",
48
- "@genesislcap/webpack-builder": "14.225.3",
42
+ "@genesislcap/foundation-testing": "14.225.4-alpha-5f6eefd.0",
43
+ "@genesislcap/genx": "14.225.4-alpha-5f6eefd.0",
44
+ "@genesislcap/rollup-builder": "14.225.4-alpha-5f6eefd.0",
45
+ "@genesislcap/ts-builder": "14.225.4-alpha-5f6eefd.0",
46
+ "@genesislcap/uvu-playwright-builder": "14.225.4-alpha-5f6eefd.0",
47
+ "@genesislcap/vite-builder": "14.225.4-alpha-5f6eefd.0",
48
+ "@genesislcap/webpack-builder": "14.225.4-alpha-5f6eefd.0",
49
49
  "@types/tabulator-tables": "6.2.3",
50
50
  "rimraf": "^5.0.0"
51
51
  },
52
52
  "dependencies": {
53
- "@genesislcap/foundation-comms": "14.225.3",
54
- "@genesislcap/foundation-logger": "14.225.3",
55
- "@genesislcap/foundation-ui": "14.225.3",
56
- "@genesislcap/foundation-utils": "14.225.3",
53
+ "@genesislcap/foundation-comms": "14.225.4-alpha-5f6eefd.0",
54
+ "@genesislcap/foundation-logger": "14.225.4-alpha-5f6eefd.0",
55
+ "@genesislcap/foundation-ui": "14.225.4-alpha-5f6eefd.0",
56
+ "@genesislcap/foundation-utils": "14.225.4-alpha-5f6eefd.0",
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.3.1"
63
+ "tslib": "2.8.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": "8c9e4ede68df7e397194a05207ea7cd7b7a9f239"
77
+ "gitHead": "232162ffe08f1239c9af3c85819c422c4a68db00"
78
78
  }