@genesislcap/grid-tabulator 14.214.2 → 14.214.4

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 (75) hide show
  1. package/dist/custom-elements.json +109 -39
  2. package/dist/dts/cell-renderers/action.renderer.d.ts +1 -1
  3. package/dist/dts/datasource/client-side.datasource.d.ts +17 -8
  4. package/dist/dts/datasource/client-side.datasource.d.ts.map +1 -1
  5. package/dist/dts/external/index.d.ts +4 -0
  6. package/dist/dts/external/index.d.ts.map +1 -1
  7. package/dist/dts/external/tabulator-theme-simple-css.d.ts +4 -0
  8. package/dist/dts/external/tabulator-theme-simple-css.d.ts.map +1 -1
  9. package/dist/dts/grid-tabulator.components.d.ts +4 -0
  10. package/dist/dts/grid-tabulator.components.d.ts.map +1 -1
  11. package/dist/dts/grid-tabulator.d.ts +29 -1
  12. package/dist/dts/grid-tabulator.d.ts.map +1 -1
  13. package/dist/dts/grid-tabulator.definitions.d.ts +44 -5
  14. package/dist/dts/grid-tabulator.definitions.d.ts.map +1 -1
  15. package/dist/dts/grid-tabulator.styles.d.ts +4 -0
  16. package/dist/dts/grid-tabulator.styles.d.ts.map +1 -1
  17. package/dist/dts/grid-tabulator.template.d.ts +4 -0
  18. package/dist/dts/grid-tabulator.template.d.ts.map +1 -1
  19. package/dist/dts/grid-tabulator.types.d.ts +24 -1
  20. package/dist/dts/grid-tabulator.types.d.ts.map +1 -1
  21. package/dist/dts/tsdoc-metadata.json +11 -0
  22. package/dist/dts/utils/logger.d.ts +4 -0
  23. package/dist/dts/utils/logger.d.ts.map +1 -1
  24. package/dist/esm/external/index.js +4 -0
  25. package/dist/esm/external/tabulator-theme-simple-css.js +4 -0
  26. package/dist/esm/grid-tabulator.components.js +4 -0
  27. package/dist/esm/grid-tabulator.definitions.js +38 -0
  28. package/dist/esm/grid-tabulator.js +26 -2
  29. package/dist/esm/grid-tabulator.styles.js +4 -0
  30. package/dist/esm/grid-tabulator.template.js +4 -0
  31. package/dist/esm/grid-tabulator.types.js +24 -1
  32. package/dist/esm/utils/logger.js +4 -0
  33. package/dist/grid-tabulator.api.json +1641 -0
  34. package/dist/grid-tabulator.d.ts +1492 -0
  35. package/docs/.gitattributes +2 -0
  36. package/docs/api/grid-tabulator.actionheightmultiplier.md +18 -0
  37. package/docs/api/grid-tabulator.actionrenderer.clickhandler.md +15 -0
  38. package/docs/api/grid-tabulator.actionrenderer.datatestid.md +11 -0
  39. package/docs/api/grid-tabulator.actionrenderer.init.md +22 -0
  40. package/docs/api/grid-tabulator.actionrenderer.md +30 -0
  41. package/docs/api/grid-tabulator.actionrenderer.params.md +11 -0
  42. package/docs/api/grid-tabulator.actionrenderer.pendingaction.md +11 -0
  43. package/docs/api/grid-tabulator.actionrendererparams.md +26 -0
  44. package/docs/api/grid-tabulator.datetimevalueformatter.md +30 -0
  45. package/docs/api/grid-tabulator.datevalueformatter.md +30 -0
  46. package/docs/api/grid-tabulator.defaultgridtabulatorconfig.md +15 -0
  47. package/docs/api/grid-tabulator.formatdateextra.md +26 -0
  48. package/docs/api/grid-tabulator.foundationgridtabulatoractionrenderer.md +26 -0
  49. package/docs/api/grid-tabulator.foundationgridtabulatorcomponents.md +35 -0
  50. package/docs/api/grid-tabulator.getcolumntype.md +26 -0
  51. package/docs/api/grid-tabulator.getfilterbyfieldtype.md +26 -0
  52. package/docs/api/grid-tabulator.getfilterparamsbyfieldtype.md +26 -0
  53. package/docs/api/grid-tabulator.gridcssvars.md +13 -0
  54. package/docs/api/grid-tabulator.gridtabulatorcellrenderertypes.md +24 -0
  55. package/docs/api/grid-tabulator.gridtabulatorshadowoptions.md +13 -0
  56. package/docs/api/grid-tabulator.gridtabulatorstyles.md +13 -0
  57. package/docs/api/grid-tabulator.gridtabulatortemplate.md +13 -0
  58. package/docs/api/grid-tabulator.gridtabulatortheme.md +21 -0
  59. package/docs/api/grid-tabulator.logger.md +13 -0
  60. package/docs/api/grid-tabulator.md +62 -0
  61. package/docs/api/grid-tabulator.rowdatatransaction.add.md +13 -0
  62. package/docs/api/grid-tabulator.rowdatatransaction.addindex.md +13 -0
  63. package/docs/api/grid-tabulator.rowdatatransaction.md +23 -0
  64. package/docs/api/grid-tabulator.rowdatatransaction.remove.md +13 -0
  65. package/docs/api/grid-tabulator.rowdatatransaction.update.md +13 -0
  66. package/docs/api/grid-tabulator.tabulatoractionrendererstyles.md +13 -0
  67. package/docs/api/grid-tabulator.tabulatorexternalstockstyles.md +13 -0
  68. package/docs/api/grid-tabulator.tabulatorthemesimplecss.md +13 -0
  69. package/docs/api/grid-tabulator.themefontsid.md +13 -0
  70. package/docs/api/grid-tabulator.themetokenmapclassname.md +13 -0
  71. package/docs/api/grid-tabulator.themetokenmapcss.md +13 -0
  72. package/docs/api/index.md +12 -0
  73. package/docs/api-report.md +313 -0
  74. package/package.json +15 -15
  75. package/tsdoc.json +4 -0
@@ -0,0 +1,2 @@
1
+ *.md -diff
2
+ *.md linguist-generated
@@ -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; [actionHeightMultiplier](./grid-tabulator.actionheightmultiplier.md)
4
+
5
+ ## actionHeightMultiplier variable
6
+
7
+ The base height multiplier for the action renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ actionHeightMultiplier: import("@microsoft/fast-foundation").CSSDesignToken<string>
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Results in `--action-height-multiplier`<!-- -->. This is a DesignToken [https://www.fast.design/docs/design-systems/design-tokens/\#what-is-a-design-token](https://www.fast.design/docs/design-systems/design-tokens/#what-is-a-design-token) value. Defaults to `0.6px`<!-- -->. May have other values depending on the design system or can be set to a different value.
18
+
@@ -0,0 +1,15 @@
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; [ActionRenderer](./grid-tabulator.actionrenderer.md) &gt; [clickHandler](./grid-tabulator.actionrenderer.clickhandler.md)
4
+
5
+ ## ActionRenderer.clickHandler() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ clickHandler(): Promise<void>;
11
+ ```
12
+ **Returns:**
13
+
14
+ Promise&lt;void&gt;
15
+
@@ -0,0 +1,11 @@
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; [ActionRenderer](./grid-tabulator.actionrenderer.md) &gt; [dataTestId](./grid-tabulator.actionrenderer.datatestid.md)
4
+
5
+ ## ActionRenderer.dataTestId property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ get dataTestId(): any;
11
+ ```
@@ -0,0 +1,22 @@
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; [ActionRenderer](./grid-tabulator.actionrenderer.md) &gt; [init](./grid-tabulator.actionrenderer.init.md)
4
+
5
+ ## ActionRenderer.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: ActionRendererParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [ActionRendererParams](./grid-tabulator.actionrendererparams.md) | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,30 @@
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; [ActionRenderer](./grid-tabulator.actionrenderer.md)
4
+
5
+ ## ActionRenderer class
6
+
7
+ The Tabulator Action Renderer element.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class ActionRenderer extends FoundationElement
13
+ ```
14
+ **Extends:** FoundationElement
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [dataTestId](./grid-tabulator.actionrenderer.datatestid.md) | <code>readonly</code> | any | |
21
+ | [params](./grid-tabulator.actionrenderer.params.md) | | [ActionRendererParams](./grid-tabulator.actionrendererparams.md) | |
22
+ | [pendingAction](./grid-tabulator.actionrenderer.pendingaction.md) | | boolean | |
23
+
24
+ ## Methods
25
+
26
+ | Method | Modifiers | Description |
27
+ | --- | --- | --- |
28
+ | [clickHandler()](./grid-tabulator.actionrenderer.clickhandler.md) | | |
29
+ | [init(params)](./grid-tabulator.actionrenderer.init.md) | | |
30
+
@@ -0,0 +1,11 @@
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; [ActionRenderer](./grid-tabulator.actionrenderer.md) &gt; [params](./grid-tabulator.actionrenderer.params.md)
4
+
5
+ ## ActionRenderer.params property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ params: ActionRendererParams;
11
+ ```
@@ -0,0 +1,11 @@
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; [ActionRenderer](./grid-tabulator.actionrenderer.md) &gt; [pendingAction](./grid-tabulator.actionrenderer.pendingaction.md)
4
+
5
+ ## ActionRenderer.pendingAction property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ pendingAction: boolean;
11
+ ```
@@ -0,0 +1,26 @@
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; [ActionRendererParams](./grid-tabulator.actionrendererparams.md)
4
+
5
+ ## ActionRendererParams type
6
+
7
+ Parameters for the `grid-tabulator` action renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ActionRendererParams = {
13
+ actionClick?: (rowData: any) => void;
14
+ actionName?: string;
15
+ appearance?: string;
16
+ dataTestId?: string;
17
+ isDisabled?: (rowData: any) => boolean;
18
+ uniqueFieldName?: string;
19
+ contentTemplate?: string;
20
+ };
21
+ ```
22
+
23
+ ## Remarks
24
+
25
+ For single action button scenarios.
26
+
@@ -0,0 +1,30 @@
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; [dateTimeValueFormatter](./grid-tabulator.datetimevalueformatter.md)
4
+
5
+ ## dateTimeValueFormatter() function
6
+
7
+ Format a date time value to a readable string.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function dateTimeValueFormatter({ value }: any): string;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | { value } | any | |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ The filter params.
26
+
27
+ ## Remarks
28
+
29
+ Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings
30
+
@@ -0,0 +1,30 @@
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; [dateValueFormatter](./grid-tabulator.datevalueformatter.md)
4
+
5
+ ## dateValueFormatter() function
6
+
7
+ Format a date value.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function dateValueFormatter({ value }: any): string;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | { value } | any | |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ The filter params.
26
+
27
+ ## Remarks
28
+
29
+ Formats \[DATE\] UNIX Timestamps (with time) to readable strings
30
+
@@ -0,0 +1,15 @@
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; [defaultGridTabulatorConfig](./grid-tabulator.defaultgridtabulatorconfig.md)
4
+
5
+ ## defaultGridTabulatorConfig variable
6
+
7
+ The default grid-tabulator configuration.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ defaultGridTabulatorConfig: {
13
+ shadowOptions: any;
14
+ }
15
+ ```
@@ -0,0 +1,26 @@
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; [formatDateExtra](./grid-tabulator.formatdateextra.md)
4
+
5
+ ## formatDateExtra() function
6
+
7
+ Format am epoch value to a readable ISO date string.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function formatDateExtra(epoch: number): string;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | epoch | number | The epoch number. |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ The formatted date value.
26
+
@@ -0,0 +1,26 @@
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; [foundationGridTabulatorActionRenderer](./grid-tabulator.foundationgridtabulatoractionrenderer.md)
4
+
5
+ ## foundationGridTabulatorActionRenderer variable
6
+
7
+ A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ foundationGridTabulatorActionRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
13
+ baseName: string;
14
+ styles: import("@microsoft/fast-element").ElementStyles;
15
+ template: import("@microsoft/fast-element").ViewTemplate<ActionRenderer, any>;
16
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
17
+ baseName: string;
18
+ styles: import("@microsoft/fast-element").ElementStyles;
19
+ template: import("@microsoft/fast-element").ViewTemplate<ActionRenderer, any>;
20
+ }, typeof ActionRenderer>
21
+ ```
22
+
23
+ ## Remarks
24
+
25
+ HTML Element: &lt;<!-- -->foundation-grid-tabulator-action-renderer<!-- -->&gt;
26
+
@@ -0,0 +1,35 @@
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; [foundationGridTabulatorComponents](./grid-tabulator.foundationgridtabulatorcomponents.md)
4
+
5
+ ## foundationGridTabulatorComponents variable
6
+
7
+ All `grid-tabulator` components.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ foundationGridTabulatorComponents: {
13
+ foundationGridTabulatorActionRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
14
+ baseName: string;
15
+ styles: import("@microsoft/fast-element").ElementStyles;
16
+ template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").ActionRenderer, any>;
17
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
18
+ baseName: string;
19
+ styles: import("@microsoft/fast-element").ElementStyles;
20
+ template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").ActionRenderer, any>;
21
+ }, typeof import("./cell-renderers").ActionRenderer>;
22
+ foundationGridTabulator: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
23
+ shadowOptions: any;
24
+ baseName: string;
25
+ styles: import("@microsoft/fast-element").ElementStyles;
26
+ template: import("@microsoft/fast-element").ViewTemplate<any, any>;
27
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
28
+ shadowOptions: any;
29
+ baseName: string;
30
+ styles: import("@microsoft/fast-element").ElementStyles;
31
+ template: import("@microsoft/fast-element").ViewTemplate<any, any>;
32
+ }, typeof import("./grid-tabulator").GridTabulator>;
33
+ register(container?: Container, ...rest: any[]): void;
34
+ }
35
+ ```
@@ -0,0 +1,26 @@
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; [getColumnType](./grid-tabulator.getcolumntype.md)
4
+
5
+ ## getColumnType() function
6
+
7
+ Get the column type based on the metadata type.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function getColumnType(metadataType: string): string;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | metadataType | string | The metadata type. |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ The column type.
26
+
@@ -0,0 +1,26 @@
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; [getFilterByFieldType](./grid-tabulator.getfilterbyfieldtype.md)
4
+
5
+ ## getFilterByFieldType() function
6
+
7
+ Get the filter type based on the field type.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function getFilterByFieldType(type: string): string;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | type | string | The field type. |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ The filter type.
26
+
@@ -0,0 +1,26 @@
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; [getFilterParamsByFieldType](./grid-tabulator.getfilterparamsbyfieldtype.md)
4
+
5
+ ## getFilterParamsByFieldType() function
6
+
7
+ Get the filter params based on the field type.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function getFilterParamsByFieldType(type: string): FilterParams;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | type | string | The field type. |
20
+
21
+ **Returns:**
22
+
23
+ FilterParams
24
+
25
+ The filter params.
26
+
@@ -0,0 +1,13 @@
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; [GridCSSVars](./grid-tabulator.gridcssvars.md)
4
+
5
+ ## GridCSSVars enum
6
+
7
+ All official Tabulator CSS variables
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare enum GridCSSVars
13
+ ```
@@ -0,0 +1,24 @@
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; [GridTabulatorCellRendererTypes](./grid-tabulator.gridtabulatorcellrenderertypes.md)
4
+
5
+ ## GridTabulatorCellRendererTypes enum
6
+
7
+ The available `grid-tabulator` Renderer Types
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare enum GridTabulatorCellRendererTypes
13
+ ```
14
+
15
+ ## Enumeration Members
16
+
17
+ | Member | Value | Description |
18
+ | --- | --- | --- |
19
+ | action | <code>&quot;action&quot;</code> | |
20
+ | actionsMenu | <code>&quot;actionsMenu&quot;</code> | |
21
+ | boolean | <code>&quot;boolean&quot;</code> | |
22
+ | select | <code>&quot;select&quot;</code> | |
23
+ | text | <code>&quot;text&quot;</code> | |
24
+
@@ -0,0 +1,13 @@
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; [gridTabulatorShadowOptions](./grid-tabulator.gridtabulatorshadowoptions.md)
4
+
5
+ ## gridTabulatorShadowOptions variable
6
+
7
+ The grid-tabulator component registration.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ gridTabulatorShadowOptions: ShadowRootInit
13
+ ```
@@ -0,0 +1,13 @@
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; [gridTabulatorStyles](./grid-tabulator.gridtabulatorstyles.md)
4
+
5
+ ## gridTabulatorStyles variable
6
+
7
+ The styles for the grid-tabulator component
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ gridTabulatorStyles: ElementStyles
13
+ ```
@@ -0,0 +1,13 @@
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; [gridTabulatorTemplate](./grid-tabulator.gridtabulatortemplate.md)
4
+
5
+ ## gridTabulatorTemplate variable
6
+
7
+ The template for the `grid-tabulator` component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ gridTabulatorTemplate: ViewTemplate
13
+ ```
@@ -0,0 +1,21 @@
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; [GridTabulatorTheme](./grid-tabulator.gridtabulatortheme.md)
4
+
5
+ ## GridTabulatorTheme enum
6
+
7
+ The available `grid-tabulator` themes
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare enum GridTabulatorTheme
13
+ ```
14
+
15
+ ## Enumeration Members
16
+
17
+ | Member | Value | Description |
18
+ | --- | --- | --- |
19
+ | default | <code>&quot;default-theme&quot;</code> | |
20
+ | rapid | <code>&quot;rapid-theme&quot;</code> | |
21
+
@@ -0,0 +1,13 @@
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; [logger](./grid-tabulator.logger.md)
4
+
5
+ ## logger variable
6
+
7
+ Logger for the `grid-tabulator` package
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ logger: import("@genesislcap/foundation-logger").Logger
13
+ ```
@@ -0,0 +1,62 @@
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)
4
+
5
+ ## grid-tabulator package
6
+
7
+ ## Classes
8
+
9
+ | Class | Description |
10
+ | --- | --- |
11
+ | [ActionRenderer](./grid-tabulator.actionrenderer.md) | The Tabulator Action Renderer element. |
12
+
13
+ ## Enumerations
14
+
15
+ | Enumeration | Description |
16
+ | --- | --- |
17
+ | [GridCSSVars](./grid-tabulator.gridcssvars.md) | All official Tabulator CSS variables |
18
+ | [GridTabulatorCellRendererTypes](./grid-tabulator.gridtabulatorcellrenderertypes.md) | The available <code>grid-tabulator</code> Renderer Types |
19
+ | [GridTabulatorTheme](./grid-tabulator.gridtabulatortheme.md) | The available <code>grid-tabulator</code> themes |
20
+
21
+ ## Functions
22
+
23
+ | Function | Description |
24
+ | --- | --- |
25
+ | [dateTimeValueFormatter({ value })](./grid-tabulator.datetimevalueformatter.md) | Format a date time value to a readable string. |
26
+ | [dateValueFormatter({ value })](./grid-tabulator.datevalueformatter.md) | Format a date value. |
27
+ | [formatDateExtra(epoch)](./grid-tabulator.formatdateextra.md) | Format am epoch value to a readable ISO date string. |
28
+ | [getColumnType(metadataType)](./grid-tabulator.getcolumntype.md) | Get the column type based on the metadata type. |
29
+ | [getFilterByFieldType(type)](./grid-tabulator.getfilterbyfieldtype.md) | Get the filter type based on the field type. |
30
+ | [getFilterParamsByFieldType(type)](./grid-tabulator.getfilterparamsbyfieldtype.md) | Get the filter params based on the field type. |
31
+
32
+ ## Interfaces
33
+
34
+ | Interface | Description |
35
+ | --- | --- |
36
+ | [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) | Transaction object to handle row data updates. |
37
+
38
+ ## Variables
39
+
40
+ | Variable | Description |
41
+ | --- | --- |
42
+ | [actionHeightMultiplier](./grid-tabulator.actionheightmultiplier.md) | The base height multiplier for the action renderer. |
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. |
45
+ | [foundationGridTabulatorComponents](./grid-tabulator.foundationgridtabulatorcomponents.md) | All <code>grid-tabulator</code> components. |
46
+ | [gridTabulatorShadowOptions](./grid-tabulator.gridtabulatorshadowoptions.md) | The grid-tabulator component registration. |
47
+ | [gridTabulatorStyles](./grid-tabulator.gridtabulatorstyles.md) | The styles for the grid-tabulator component |
48
+ | [gridTabulatorTemplate](./grid-tabulator.gridtabulatortemplate.md) | The template for the <code>grid-tabulator</code> component. |
49
+ | [logger](./grid-tabulator.logger.md) | Logger for the <code>grid-tabulator</code> package |
50
+ | [tabulatorActionRendererStyles](./grid-tabulator.tabulatoractionrendererstyles.md) | The Tabulator Action Renderer Styles. |
51
+ | [tabulatorExternalStockStyles](./grid-tabulator.tabulatorexternalstockstyles.md) | External styles for the Tabulator grid. |
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 |
56
+
57
+ ## Type Aliases
58
+
59
+ | Type Alias | Description |
60
+ | --- | --- |
61
+ | [ActionRendererParams](./grid-tabulator.actionrendererparams.md) | Parameters for the <code>grid-tabulator</code> action renderer. |
62
+
@@ -0,0 +1,13 @@
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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [add](./grid-tabulator.rowdatatransaction.add.md)
4
+
5
+ ## RowDataTransaction.add property
6
+
7
+ Rows to add
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ add?: TData[] | null;
13
+ ```
@@ -0,0 +1,13 @@
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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [addIndex](./grid-tabulator.rowdatatransaction.addindex.md)
4
+
5
+ ## RowDataTransaction.addIndex property
6
+
7
+ Index to add rows
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ addIndex?: number | null;
13
+ ```
@@ -0,0 +1,23 @@
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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md)
4
+
5
+ ## RowDataTransaction interface
6
+
7
+ Transaction object to handle row data updates.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface RowDataTransaction<TData = any>
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [add?](./grid-tabulator.rowdatatransaction.add.md) | | TData\[\] \| null | _(Optional)_ Rows to add |
20
+ | [addIndex?](./grid-tabulator.rowdatatransaction.addindex.md) | | number \| null | _(Optional)_ Index to add rows |
21
+ | [remove?](./grid-tabulator.rowdatatransaction.remove.md) | | TData\[\] \| null | _(Optional)_ Rows to remove |
22
+ | [update?](./grid-tabulator.rowdatatransaction.update.md) | | TData\[\] \| null | _(Optional)_ Rows to update |
23
+
@@ -0,0 +1,13 @@
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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [remove](./grid-tabulator.rowdatatransaction.remove.md)
4
+
5
+ ## RowDataTransaction.remove property
6
+
7
+ Rows to remove
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ remove?: TData[] | null;
13
+ ```