@genesislcap/grid-tabulator 14.262.1 → 14.262.2
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/custom-elements.json +2613 -117
- package/dist/dts/cell/cell.d.ts +50 -0
- package/dist/dts/cell/cell.d.ts.map +1 -0
- package/dist/dts/cell/index.d.ts +1 -1
- package/dist/dts/cell/index.d.ts.map +1 -1
- package/dist/dts/cell-editors/date.editor.d.ts +75 -0
- package/dist/dts/cell-editors/date.editor.d.ts.map +1 -0
- package/dist/dts/cell-editors/index.d.ts +6 -0
- package/dist/dts/cell-editors/index.d.ts.map +1 -0
- package/dist/dts/cell-editors/multiselect.editor.d.ts +79 -0
- package/dist/dts/cell-editors/multiselect.editor.d.ts.map +1 -0
- package/dist/dts/cell-editors/number.editor.d.ts +76 -0
- package/dist/dts/cell-editors/number.editor.d.ts.map +1 -0
- package/dist/dts/cell-editors/select.editor.d.ts +83 -0
- package/dist/dts/cell-editors/select.editor.d.ts.map +1 -0
- package/dist/dts/cell-editors/string.editor.d.ts +67 -0
- package/dist/dts/cell-editors/string.editor.d.ts.map +1 -0
- package/dist/dts/cell-formatters/action.formatter.d.ts +45 -0
- package/dist/dts/cell-formatters/action.formatter.d.ts.map +1 -0
- package/dist/dts/cell-formatters/actions-menu.formatter.d.ts +57 -0
- package/dist/dts/cell-formatters/actions-menu.formatter.d.ts.map +1 -0
- package/dist/dts/cell-formatters/boolean.formatter.d.ts +27 -0
- package/dist/dts/cell-formatters/boolean.formatter.d.ts.map +1 -0
- package/dist/dts/cell-formatters/constants.d.ts +31 -0
- package/dist/dts/cell-formatters/constants.d.ts.map +1 -0
- package/dist/dts/cell-formatters/editable.formatter.d.ts +40 -0
- package/dist/dts/cell-formatters/editable.formatter.d.ts.map +1 -0
- package/dist/dts/cell-formatters/index.d.ts +27 -0
- package/dist/dts/cell-formatters/index.d.ts.map +1 -0
- package/dist/dts/cell-formatters/select.formatter.d.ts +43 -0
- package/dist/dts/cell-formatters/select.formatter.d.ts.map +1 -0
- package/dist/dts/cell-formatters/text.formatter.d.ts +36 -0
- package/dist/dts/cell-formatters/text.formatter.d.ts.map +1 -0
- package/dist/dts/column/column.d.ts +340 -0
- package/dist/dts/column/column.d.ts.map +1 -0
- package/dist/dts/column/index.d.ts +1 -1
- package/dist/dts/column/index.d.ts.map +1 -1
- package/dist/dts/datasource/client-side.datasource.d.ts +42 -16
- package/dist/dts/datasource/client-side.datasource.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.components.d.ts +52 -4
- package/dist/dts/grid-tabulator.components.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.d.ts +119 -11
- package/dist/dts/grid-tabulator.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.definitions.d.ts +35 -0
- package/dist/dts/grid-tabulator.definitions.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.styles.d.ts.map +1 -1
- package/dist/dts/grid-tabulator.types.d.ts +13 -1
- package/dist/dts/grid-tabulator.types.d.ts.map +1 -1
- package/dist/dts/index.d.ts +3 -1
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/types.d.ts +27 -0
- package/dist/dts/types.d.ts.map +1 -0
- package/dist/dts/utils/index.d.ts +1 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/dts/utils/string-utils.d.ts +17 -0
- package/dist/dts/utils/string-utils.d.ts.map +1 -0
- package/dist/esm/cell/cell.js +66 -0
- package/dist/esm/cell/index.js +1 -1
- package/dist/esm/cell-editors/date.editor.js +92 -0
- package/dist/esm/cell-editors/index.js +5 -0
- package/dist/esm/cell-editors/multiselect.editor.js +105 -0
- package/dist/esm/cell-editors/number.editor.js +84 -0
- package/dist/esm/cell-editors/select.editor.js +91 -0
- package/dist/esm/cell-editors/string.editor.js +82 -0
- package/dist/esm/cell-formatters/action.formatter.js +73 -0
- package/dist/esm/cell-formatters/actions-menu.formatter.js +68 -0
- package/dist/esm/cell-formatters/boolean.formatter.js +25 -0
- package/dist/esm/cell-formatters/constants.js +31 -0
- package/dist/esm/cell-formatters/editable.formatter.js +21 -0
- package/dist/esm/cell-formatters/index.js +26 -0
- package/dist/esm/cell-formatters/select.formatter.js +32 -0
- package/dist/esm/cell-formatters/text.formatter.js +30 -0
- package/dist/esm/column/column.js +51 -0
- package/dist/esm/column/index.js +1 -1
- package/dist/esm/datasource/client-side.datasource.js +219 -91
- package/dist/esm/grid-tabulator.components.js +24 -11
- package/dist/esm/grid-tabulator.definitions.js +30 -0
- package/dist/esm/grid-tabulator.js +392 -27
- package/dist/esm/grid-tabulator.styles.js +15 -0
- package/dist/esm/grid-tabulator.types.js +13 -0
- package/dist/esm/index.js +1 -1
- package/dist/esm/types.js +1 -0
- package/dist/esm/utils/index.js +1 -0
- package/dist/esm/utils/string-utils.js +32 -0
- package/dist/grid-tabulator.api.json +1703 -466
- package/dist/grid-tabulator.d.ts +1237 -124
- package/docs/api/grid-tabulator.actionformatter.md +27 -0
- package/docs/api/grid-tabulator.actionsmenuformatter.md +27 -0
- package/docs/api/grid-tabulator.booleanformatter.md +27 -0
- package/docs/api/grid-tabulator.cellrendererfunc.md +15 -0
- package/docs/api/grid-tabulator.cellrendererparams.cell.md +13 -0
- package/docs/api/grid-tabulator.cellrendererparams.data.md +13 -0
- package/docs/api/grid-tabulator.cellrendererparams.formatterparams.md +13 -0
- package/docs/api/grid-tabulator.cellrendererparams.md +23 -0
- package/docs/api/grid-tabulator.cellrendererparams.value.md +13 -0
- package/docs/api/grid-tabulator.editableformatter.md +27 -0
- package/docs/api/grid-tabulator.foundationgridtabulatorcomponents.md +50 -4
- package/docs/api/grid-tabulator.gridtabulatorcell.connectedcallback.md +15 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.destroy.md +15 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.getelement.md +15 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.init.md +22 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.md +38 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.refresh.md +22 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.renderer.md +11 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.rendererparams.md +11 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.slottedrenderer.md +11 -0
- package/docs/api/grid-tabulator.gridtabulatorcell.slottedrendererchanged.md +15 -0
- package/docs/api/grid-tabulator.gridtabulatorcelleditortypes.md +24 -0
- package/docs/api/grid-tabulator.gridtabulatorcellrenderertypes.md +1 -0
- package/docs/api/grid-tabulator.gridtabulatorcolumn.deepclone.md +15 -0
- package/docs/api/grid-tabulator.gridtabulatorcolumn.definition.md +11 -0
- package/docs/api/grid-tabulator.gridtabulatorcolumn.md +33 -0
- package/docs/api/grid-tabulator.gridtabulatorcolumn.slottedcell.md +11 -0
- package/docs/api/grid-tabulator.gridtabulatorcolumn.slottedcellchanged.md +15 -0
- package/docs/api/grid-tabulator.md +11 -5
- package/docs/api/grid-tabulator.selectformatter.md +27 -0
- package/docs/api/grid-tabulator.textformatter.md +27 -0
- package/docs/api-report.md +328 -36
- package/package.json +16 -15
- package/dist/dts/cell-renderers/action.renderer.d.ts +0 -80
- package/dist/dts/cell-renderers/action.renderer.d.ts.map +0 -1
- package/dist/dts/cell-renderers/index.d.ts +0 -2
- package/dist/dts/cell-renderers/index.d.ts.map +0 -1
- package/dist/esm/cell-renderers/action.renderer.js +0 -107
- package/dist/esm/cell-renderers/index.js +0 -1
- package/docs/api/grid-tabulator.actionheightmultiplier.md +0 -18
- package/docs/api/grid-tabulator.actionrenderer.clickhandler.md +0 -15
- package/docs/api/grid-tabulator.actionrenderer.datatestid.md +0 -11
- package/docs/api/grid-tabulator.actionrenderer.init.md +0 -22
- package/docs/api/grid-tabulator.actionrenderer.md +0 -30
- package/docs/api/grid-tabulator.actionrenderer.params.md +0 -11
- package/docs/api/grid-tabulator.actionrenderer.pendingaction.md +0 -11
- package/docs/api/grid-tabulator.actionrendererparams.md +0 -26
- package/docs/api/grid-tabulator.foundationgridtabulatoractionrenderer.md +0 -26
- package/docs/api/grid-tabulator.tabulatoractionrendererstyles.md +0 -13
|
@@ -8,13 +8,15 @@
|
|
|
8
8
|
|
|
9
9
|
| Class | Description |
|
|
10
10
|
| --- | --- |
|
|
11
|
-
| [
|
|
11
|
+
| [GridTabulatorCell](./grid-tabulator.gridtabulatorcell.md) | The GridTabulator Cell element. |
|
|
12
|
+
| [GridTabulatorColumn](./grid-tabulator.gridtabulatorcolumn.md) | The GridTabulator Column element. |
|
|
12
13
|
|
|
13
14
|
## Enumerations
|
|
14
15
|
|
|
15
16
|
| Enumeration | Description |
|
|
16
17
|
| --- | --- |
|
|
17
18
|
| [GridCSSVars](./grid-tabulator.gridcssvars.md) | All official Tabulator CSS variables |
|
|
19
|
+
| [GridTabulatorCellEditorTypes](./grid-tabulator.gridtabulatorcelleditortypes.md) | The available <code>grid-tabulator</code> Editor Types |
|
|
18
20
|
| [GridTabulatorCellRendererTypes](./grid-tabulator.gridtabulatorcellrenderertypes.md) | The available <code>grid-tabulator</code> Renderer Types |
|
|
19
21
|
| [GridTabulatorTheme](./grid-tabulator.gridtabulatortheme.md) | The available <code>grid-tabulator</code> themes |
|
|
20
22
|
|
|
@@ -22,32 +24,36 @@
|
|
|
22
24
|
|
|
23
25
|
| Function | Description |
|
|
24
26
|
| --- | --- |
|
|
27
|
+
| [actionFormatter(cell, formatterParams)](./grid-tabulator.actionformatter.md) | Formatter that displays an action button in the cell. Styled to match grid-pro action renderer. |
|
|
28
|
+
| [actionsMenuFormatter(cell, formatterParams)](./grid-tabulator.actionsmenuformatter.md) | Formatter that displays a dropdown menu of actions in the cell. Styled to match grid-pro actions-menu renderer. |
|
|
29
|
+
| [booleanFormatter(cell, formatterParams)](./grid-tabulator.booleanformatter.md) | Formatter that displays boolean values using a checkbox component. Styled to match grid-pro boolean renderer. |
|
|
25
30
|
| [dateTimeValueFormatter({ value })](./grid-tabulator.datetimevalueformatter.md) | Format a date time value to a readable string. |
|
|
26
31
|
| [dateValueFormatter({ value })](./grid-tabulator.datevalueformatter.md) | Format a date value. |
|
|
32
|
+
| [editableFormatter(cell, formatterParams)](./grid-tabulator.editableformatter.md) | Formatter that displays an editable cell with validation state |
|
|
27
33
|
| [formatDateExtra(epoch)](./grid-tabulator.formatdateextra.md) | Format am epoch value to a readable ISO date string. |
|
|
28
34
|
| [getColumnType(metadataType)](./grid-tabulator.getcolumntype.md) | Get the column type based on the metadata type. |
|
|
29
35
|
| [getFilterByFieldType(type)](./grid-tabulator.getfilterbyfieldtype.md) | Get the filter type based on the field type. |
|
|
30
36
|
| [getFilterParamsByFieldType(type)](./grid-tabulator.getfilterparamsbyfieldtype.md) | Get the filter params based on the field type. |
|
|
37
|
+
| [selectFormatter(cell, formatterParams)](./grid-tabulator.selectformatter.md) | Formatter that displays a value from a select list of options Styled to match grid-pro select renderer. |
|
|
38
|
+
| [textFormatter(cell, formatterParams)](./grid-tabulator.textformatter.md) | Text formatter for customized display of values. Styled to match grid-pro text renderer. |
|
|
31
39
|
|
|
32
40
|
## Interfaces
|
|
33
41
|
|
|
34
42
|
| Interface | Description |
|
|
35
43
|
| --- | --- |
|
|
44
|
+
| [CellRendererParams](./grid-tabulator.cellrendererparams.md) | Parameters for custom cell renderers |
|
|
36
45
|
| [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) | Transaction object to handle row data updates. |
|
|
37
46
|
|
|
38
47
|
## Variables
|
|
39
48
|
|
|
40
49
|
| Variable | Description |
|
|
41
50
|
| --- | --- |
|
|
42
|
-
| [actionHeightMultiplier](./grid-tabulator.actionheightmultiplier.md) | The base height multiplier for the action renderer. |
|
|
43
51
|
| [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
52
|
| [foundationGridTabulatorComponents](./grid-tabulator.foundationgridtabulatorcomponents.md) | All <code>grid-tabulator</code> components. |
|
|
46
53
|
| [gridTabulatorShadowOptions](./grid-tabulator.gridtabulatorshadowoptions.md) | The grid-tabulator component registration. |
|
|
47
54
|
| [gridTabulatorStyles](./grid-tabulator.gridtabulatorstyles.md) | The styles for the grid-tabulator component |
|
|
48
55
|
| [gridTabulatorTemplate](./grid-tabulator.gridtabulatortemplate.md) | The template for the <code>grid-tabulator</code> component. |
|
|
49
56
|
| [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
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
59
|
| [themeFontsId](./grid-tabulator.themefontsid.md) | Get the Fonts ID for the theme's name |
|
|
@@ -58,5 +64,5 @@
|
|
|
58
64
|
|
|
59
65
|
| Type Alias | Description |
|
|
60
66
|
| --- | --- |
|
|
61
|
-
| [
|
|
67
|
+
| [CellRendererFunc](./grid-tabulator.cellrendererfunc.md) | Function type for cell renderer |
|
|
62
68
|
|
|
@@ -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) > [selectFormatter](./grid-tabulator.selectformatter.md)
|
|
4
|
+
|
|
5
|
+
## selectFormatter() function
|
|
6
|
+
|
|
7
|
+
Formatter that displays a value from a select list of options Styled to match grid-pro select renderer.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function selectFormatter(cell: any, formatterParams: SelectFormatterParams): string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| cell | any | The cell component provided by Tabulator |
|
|
20
|
+
| formatterParams | SelectFormatterParams | Select formatter parameters |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
string
|
|
25
|
+
|
|
26
|
+
Text content for the selected option
|
|
27
|
+
|
|
@@ -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) > [textFormatter](./grid-tabulator.textformatter.md)
|
|
4
|
+
|
|
5
|
+
## textFormatter() function
|
|
6
|
+
|
|
7
|
+
Text formatter for customized display of values. Styled to match grid-pro text renderer.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function textFormatter(cell: any, formatterParams?: TextFormatterParams): string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| cell | any | The cell component provided by Tabulator |
|
|
20
|
+
| formatterParams | TextFormatterParams | _(Optional)_ Text formatter parameters |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
string
|
|
25
|
+
|
|
26
|
+
Text content for the cell
|
|
27
|
+
|
package/docs/api-report.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
import { Auth } from '@genesislcap/foundation-comms';
|
|
8
8
|
import { CellComponent } from 'tabulator-tables';
|
|
9
|
+
import { ColumnDefinition as ColumnDefinition_2 } from 'tabulator-tables';
|
|
9
10
|
import { Connect } from '@genesislcap/foundation-comms';
|
|
10
11
|
import type { Container } from '@microsoft/fast-foundation';
|
|
11
12
|
import { Controller } from '@microsoft/fast-element';
|
|
12
|
-
import { CSSDesignToken } from '@microsoft/fast-foundation';
|
|
13
13
|
import { CSSVarTokenMap } from '@genesislcap/foundation-ui';
|
|
14
14
|
import { Datasource } from '@genesislcap/foundation-comms';
|
|
15
15
|
import { DatasourceStatus } from '@genesislcap/foundation-comms';
|
|
@@ -18,63 +18,183 @@ import { DOMContainer } from '@genesislcap/foundation-utils';
|
|
|
18
18
|
import { DownloadOptions } from 'tabulator-tables';
|
|
19
19
|
import { ElementStyles } from '@microsoft/fast-element';
|
|
20
20
|
import { FilterParams } from 'tabulator-tables';
|
|
21
|
+
import type { Formatter } from 'tabulator-tables';
|
|
21
22
|
import { FormatterParams } from 'tabulator-tables';
|
|
22
23
|
import { FoundationElement } from '@microsoft/fast-foundation';
|
|
23
24
|
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
|
|
24
25
|
import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
|
|
25
26
|
import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
|
|
26
27
|
import { Logger } from '@genesislcap/foundation-logger';
|
|
27
|
-
import { Options } from 'tabulator-tables';
|
|
28
|
+
import { Options as Options_2 } from 'tabulator-tables';
|
|
28
29
|
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
|
29
30
|
import { RowRangeLookup } from 'tabulator-tables';
|
|
30
31
|
import { TabulatorFull } from 'tabulator-tables';
|
|
31
32
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
32
33
|
|
|
34
|
+
// Warning: (ae-incompatible-release-tags) The symbol "actionFormatter" is marked as @public, but its signature references "ActionFormatterParams" which is marked as @alpha
|
|
35
|
+
//
|
|
33
36
|
// @public
|
|
34
|
-
export
|
|
37
|
+
export function actionFormatter(cell: any, formatterParams?: ActionFormatterParams): string;
|
|
38
|
+
|
|
39
|
+
// @alpha
|
|
40
|
+
export interface ActionFormatterParams {
|
|
41
|
+
// (undocumented)
|
|
42
|
+
actionButtonStyle?: string;
|
|
43
|
+
// (undocumented)
|
|
44
|
+
actionClick?: (rowData: any) => void;
|
|
45
|
+
// (undocumented)
|
|
46
|
+
actionName?: string;
|
|
47
|
+
// (undocumented)
|
|
48
|
+
appearance?: string;
|
|
49
|
+
// (undocumented)
|
|
50
|
+
contentTemplate?: string;
|
|
51
|
+
// (undocumented)
|
|
52
|
+
dataTestId?: string;
|
|
53
|
+
// (undocumented)
|
|
54
|
+
isDisabled?: (rowData: any) => boolean;
|
|
55
|
+
// (undocumented)
|
|
56
|
+
prefix?: string;
|
|
57
|
+
// (undocumented)
|
|
58
|
+
uniqueFieldName?: string;
|
|
59
|
+
}
|
|
35
60
|
|
|
61
|
+
// Warning: (ae-incompatible-release-tags) The symbol "actionsMenuFormatter" is marked as @public, but its signature references "ActionsMenuFormatterParams" which is marked as @alpha
|
|
62
|
+
//
|
|
36
63
|
// @public
|
|
37
|
-
export
|
|
64
|
+
export function actionsMenuFormatter(cell: any, formatterParams?: ActionsMenuFormatterParams): string;
|
|
65
|
+
|
|
66
|
+
// @alpha
|
|
67
|
+
export interface ActionsMenuFormatterParams {
|
|
38
68
|
// (undocumented)
|
|
39
|
-
|
|
69
|
+
actions?: Array<{
|
|
70
|
+
name: string;
|
|
71
|
+
callback: (rowData: any) => void;
|
|
72
|
+
isDisabled?: (rowData: any) => boolean;
|
|
73
|
+
}>;
|
|
40
74
|
// (undocumented)
|
|
41
|
-
|
|
75
|
+
buttonAppearance?: string;
|
|
42
76
|
// (undocumented)
|
|
43
|
-
|
|
77
|
+
isVertical?: boolean;
|
|
44
78
|
// (undocumented)
|
|
45
|
-
|
|
79
|
+
menuName?: string;
|
|
46
80
|
// (undocumented)
|
|
47
|
-
|
|
81
|
+
prefix?: string;
|
|
48
82
|
}
|
|
49
83
|
|
|
84
|
+
// Warning: (ae-incompatible-release-tags) The symbol "booleanFormatter" is marked as @public, but its signature references "BooleanFormatterParams" which is marked as @alpha
|
|
85
|
+
//
|
|
50
86
|
// @public
|
|
51
|
-
export
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
87
|
+
export function booleanFormatter(cell: any, formatterParams?: BooleanFormatterParams): string;
|
|
88
|
+
|
|
89
|
+
// @alpha
|
|
90
|
+
export interface BooleanFormatterParams {
|
|
91
|
+
// (undocumented)
|
|
55
92
|
dataTestId?: string;
|
|
93
|
+
// (undocumented)
|
|
56
94
|
isDisabled?: (rowData: any) => boolean;
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
}
|
|
95
|
+
// (undocumented)
|
|
96
|
+
prefix?: string;
|
|
97
|
+
}
|
|
60
98
|
|
|
61
99
|
export { CellComponent }
|
|
62
100
|
|
|
101
|
+
// @public
|
|
102
|
+
export type CellRendererFunc = (params: CellRendererParams) => HTMLElement | string;
|
|
103
|
+
|
|
104
|
+
// @public
|
|
105
|
+
export interface CellRendererParams {
|
|
106
|
+
[key: string]: any;
|
|
107
|
+
cell?: CellComponent;
|
|
108
|
+
data?: any;
|
|
109
|
+
formatterParams?: FormatterParams;
|
|
110
|
+
value?: any;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
// @alpha
|
|
114
|
+
export type ColumnDefinition = {
|
|
115
|
+
formatter?: Formatter | FormatterTypes;
|
|
116
|
+
formatterParams?: CustomFormatterParams;
|
|
117
|
+
} & Omit<ColumnDefinition_2, 'formatter' | 'formatterParams'>;
|
|
118
|
+
|
|
119
|
+
// @alpha
|
|
120
|
+
export function convertToKebabCase(str: string): string;
|
|
121
|
+
|
|
122
|
+
// @alpha
|
|
123
|
+
export const criteriaDelimiter = ";";
|
|
124
|
+
|
|
125
|
+
// @alpha
|
|
126
|
+
export const criteriaJoin = " && ";
|
|
127
|
+
|
|
128
|
+
// @alpha
|
|
129
|
+
export type CustomFormatterParams = FormatterParams | ActionFormatterParams | ActionsMenuFormatterParams | BooleanFormatterParams | EditableFormatterParams | SelectFormatterParams | TextFormatterParams;
|
|
130
|
+
|
|
63
131
|
// @public
|
|
64
132
|
export function dateTimeValueFormatter({ value }: any): string;
|
|
65
133
|
|
|
66
134
|
// @public
|
|
67
135
|
export function dateValueFormatter({ value }: any): string;
|
|
68
136
|
|
|
137
|
+
// @alpha
|
|
138
|
+
export const DEBOUNCED_RESIZE_TIME = 400;
|
|
139
|
+
|
|
69
140
|
// @public
|
|
70
141
|
export const defaultGridTabulatorConfig: {
|
|
71
142
|
shadowOptions: any;
|
|
72
143
|
};
|
|
73
144
|
|
|
145
|
+
// Warning: (ae-incompatible-release-tags) The symbol "editableFormatter" is marked as @public, but its signature references "EditableFormatterParams" which is marked as @alpha
|
|
146
|
+
//
|
|
147
|
+
// @public
|
|
148
|
+
export function editableFormatter(cell: any, formatterParams?: EditableFormatterParams): string;
|
|
149
|
+
|
|
150
|
+
// @alpha
|
|
151
|
+
export interface EditableFormatterParams {
|
|
152
|
+
// (undocumented)
|
|
153
|
+
cssClass?: string;
|
|
154
|
+
// (undocumented)
|
|
155
|
+
data?: any;
|
|
156
|
+
// (undocumented)
|
|
157
|
+
dataTestId?: string;
|
|
158
|
+
// (undocumented)
|
|
159
|
+
field?: string;
|
|
160
|
+
// (undocumented)
|
|
161
|
+
icon?: string;
|
|
162
|
+
// (undocumented)
|
|
163
|
+
nullText?: string;
|
|
164
|
+
// (undocumented)
|
|
165
|
+
prefix?: string;
|
|
166
|
+
// (undocumented)
|
|
167
|
+
value?: any;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
// @alpha
|
|
171
|
+
export const EDITED_COLUMN_FIELD = "__EDITED_FIELD__";
|
|
172
|
+
|
|
173
|
+
// @alpha
|
|
174
|
+
export const ERROR_COLUMN_FIELD = "__ERROR_FIELD__";
|
|
175
|
+
|
|
74
176
|
// @public
|
|
75
177
|
export function formatDateExtra(epoch: number): string;
|
|
76
178
|
|
|
77
|
-
|
|
179
|
+
// @alpha
|
|
180
|
+
export const formatters: {
|
|
181
|
+
action: typeof actionFormatter;
|
|
182
|
+
actionsMenu: typeof actionsMenuFormatter;
|
|
183
|
+
boolean: typeof booleanFormatter;
|
|
184
|
+
editable: typeof editableFormatter;
|
|
185
|
+
select: typeof selectFormatter;
|
|
186
|
+
text: typeof textFormatter;
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
// @alpha
|
|
190
|
+
export enum FormatterTypes {
|
|
191
|
+
action = "action",
|
|
192
|
+
actionsMenu = "actionsMenu",
|
|
193
|
+
boolean = "boolean",
|
|
194
|
+
editable = "editable",
|
|
195
|
+
select = "select",
|
|
196
|
+
text = "text"
|
|
197
|
+
}
|
|
78
198
|
|
|
79
199
|
// @alpha
|
|
80
200
|
export const foundationGridTabulator: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
@@ -89,28 +209,63 @@ styles: ElementStyles;
|
|
|
89
209
|
template: ViewTemplate<any, any>;
|
|
90
210
|
}, typeof GridTabulator>;
|
|
91
211
|
|
|
92
|
-
// @public
|
|
93
|
-
export const foundationGridTabulatorActionRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
94
|
-
baseName: string;
|
|
95
|
-
styles: ElementStyles;
|
|
96
|
-
template: ViewTemplate<ActionRenderer, any>;
|
|
97
|
-
}>) => FoundationElementRegistry< {
|
|
98
|
-
baseName: string;
|
|
99
|
-
styles: ElementStyles;
|
|
100
|
-
template: ViewTemplate<ActionRenderer, any>;
|
|
101
|
-
}, typeof ActionRenderer>;
|
|
102
|
-
|
|
103
212
|
// @public
|
|
104
213
|
export const foundationGridTabulatorComponents: {
|
|
105
|
-
|
|
214
|
+
foundationDateEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
215
|
+
baseName: string;
|
|
216
|
+
styles: ElementStyles;
|
|
217
|
+
template: ViewTemplate<DateEditor, any>;
|
|
218
|
+
}>) => FoundationElementRegistry< {
|
|
219
|
+
baseName: string;
|
|
220
|
+
styles: ElementStyles;
|
|
221
|
+
template: ViewTemplate<DateEditor, any>;
|
|
222
|
+
}, DateEditor>;
|
|
223
|
+
foundationNumberEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
224
|
+
baseName: string;
|
|
225
|
+
styles: ElementStyles;
|
|
226
|
+
template: ViewTemplate<NumberEditor, any>;
|
|
227
|
+
}>) => FoundationElementRegistry< {
|
|
228
|
+
baseName: string;
|
|
229
|
+
styles: ElementStyles;
|
|
230
|
+
template: ViewTemplate<NumberEditor, any>;
|
|
231
|
+
}, NumberEditor>;
|
|
232
|
+
foundationSelectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
233
|
+
baseName: string;
|
|
234
|
+
styles: ElementStyles;
|
|
235
|
+
template: ViewTemplate<SelectEditor, any>;
|
|
236
|
+
}>) => FoundationElementRegistry< {
|
|
237
|
+
baseName: string;
|
|
238
|
+
styles: ElementStyles;
|
|
239
|
+
template: ViewTemplate<SelectEditor, any>;
|
|
240
|
+
}, SelectEditor>;
|
|
241
|
+
foundationStringEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
242
|
+
baseName: string;
|
|
243
|
+
styles: ElementStyles;
|
|
244
|
+
template: ViewTemplate<StringEditor, any>;
|
|
245
|
+
}>) => FoundationElementRegistry< {
|
|
246
|
+
baseName: string;
|
|
247
|
+
styles: ElementStyles;
|
|
248
|
+
template: ViewTemplate<StringEditor, any>;
|
|
249
|
+
}, StringEditor>;
|
|
250
|
+
foundationMultiselectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
106
251
|
baseName: string;
|
|
107
252
|
styles: ElementStyles;
|
|
108
|
-
template: ViewTemplate<
|
|
253
|
+
template: ViewTemplate<MultiselectEditor, any>;
|
|
109
254
|
}>) => FoundationElementRegistry< {
|
|
110
255
|
baseName: string;
|
|
111
256
|
styles: ElementStyles;
|
|
112
|
-
template: ViewTemplate<
|
|
113
|
-
},
|
|
257
|
+
template: ViewTemplate<MultiselectEditor, any>;
|
|
258
|
+
}, MultiselectEditor>;
|
|
259
|
+
foundationGridTabulatorColumn: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
260
|
+
baseName: string;
|
|
261
|
+
}>) => FoundationElementRegistry< {
|
|
262
|
+
baseName: string;
|
|
263
|
+
}, typeof GridTabulatorColumn>;
|
|
264
|
+
foundationGridTabulatorCell: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
265
|
+
baseName: string;
|
|
266
|
+
}>) => FoundationElementRegistry< {
|
|
267
|
+
baseName: string;
|
|
268
|
+
}, typeof GridTabulatorCell>;
|
|
114
269
|
foundationGridTabulator: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
115
270
|
shadowOptions: any;
|
|
116
271
|
baseName: string;
|
|
@@ -146,25 +301,44 @@ export class GridTabulator extends GridTabulator_base {
|
|
|
146
301
|
autoCellRendererByType: boolean;
|
|
147
302
|
// (undocumented)
|
|
148
303
|
classNames: string;
|
|
304
|
+
// @public
|
|
305
|
+
clearFilters(): void;
|
|
306
|
+
// @public
|
|
307
|
+
columnComponentName: string;
|
|
149
308
|
// (undocumented)
|
|
150
309
|
connectedCallback(): void;
|
|
151
310
|
// (undocumented)
|
|
152
311
|
disconnectedCallback(): void;
|
|
153
312
|
// @public
|
|
154
313
|
downloadDataAs(type: 'csv' | 'json' | 'html', fileName: string, params?: DownloadOptions, filter?: RowRangeLookup): void;
|
|
314
|
+
enableCellFlashing: boolean;
|
|
315
|
+
enableRowFlashing: boolean;
|
|
155
316
|
// (undocumented)
|
|
156
317
|
grid: TabulatorFull | undefined;
|
|
318
|
+
gridAutosizingEnabled: boolean;
|
|
157
319
|
// (undocumented)
|
|
158
320
|
gridDiv: HTMLDivElement;
|
|
159
321
|
// (undocumented)
|
|
160
322
|
gridFontFace: string;
|
|
323
|
+
// Warning: (ae-incompatible-release-tags) The symbol "gridOptions" is marked as @public, but its signature references "Options" which is marked as @alpha
|
|
324
|
+
//
|
|
161
325
|
// @public
|
|
162
326
|
get gridOptions(): Options;
|
|
327
|
+
// Warning: (ae-incompatible-release-tags) The symbol "gridOptions" is marked as @public, but its signature references "Options" which is marked as @alpha
|
|
163
328
|
set gridOptions(options: Options);
|
|
329
|
+
// Warning: (ae-incompatible-release-tags) The symbol "headerCaseType" is marked as @public, but its signature references "GridTabulatorCaseType" which is marked as @alpha
|
|
330
|
+
//
|
|
331
|
+
// @public
|
|
332
|
+
headerCaseType: GridTabulatorCaseType;
|
|
164
333
|
// (undocumented)
|
|
165
334
|
onlyTemplateColDefs: boolean;
|
|
166
335
|
// (undocumented)
|
|
167
336
|
persistColumnStateKey: string;
|
|
337
|
+
persistFilterModelKey: string;
|
|
338
|
+
// @public
|
|
339
|
+
redraw(): void;
|
|
340
|
+
// @public
|
|
341
|
+
refreshCells(): void;
|
|
168
342
|
// (undocumented)
|
|
169
343
|
restoreGridState(): void;
|
|
170
344
|
// (undocumented)
|
|
@@ -177,6 +351,7 @@ export class GridTabulator extends GridTabulator_base {
|
|
|
177
351
|
saveGridState(): void;
|
|
178
352
|
// @public
|
|
179
353
|
setFilter(column: string, operator: string, value: string, filterParams?: FilterParams): void;
|
|
354
|
+
showHeaderFilters: boolean;
|
|
180
355
|
// (undocumented)
|
|
181
356
|
get statePersistanceEnabled(): boolean;
|
|
182
357
|
// (undocumented)
|
|
@@ -185,6 +360,45 @@ export class GridTabulator extends GridTabulator_base {
|
|
|
185
360
|
themeChanged(oldValue: string, newValue: string): void;
|
|
186
361
|
}
|
|
187
362
|
|
|
363
|
+
// @alpha
|
|
364
|
+
export type GridTabulatorCaseType = 'camelCase' | 'capitalCase' | 'constantCase' | 'dotCase' | 'headerCase' | 'noCase' | 'paramCase' | 'pascalCase' | 'pathCase' | 'sentenceCase' | 'snakeCase';
|
|
365
|
+
|
|
366
|
+
// @public
|
|
367
|
+
export class GridTabulatorCell extends FoundationElement {
|
|
368
|
+
// (undocumented)
|
|
369
|
+
connectedCallback(): void;
|
|
370
|
+
// (undocumented)
|
|
371
|
+
destroy(): void;
|
|
372
|
+
// (undocumented)
|
|
373
|
+
getElement(): HTMLElement;
|
|
374
|
+
// (undocumented)
|
|
375
|
+
init(params: CellRendererParams): void;
|
|
376
|
+
// (undocumented)
|
|
377
|
+
refresh(params: CellRendererParams): boolean;
|
|
378
|
+
// (undocumented)
|
|
379
|
+
renderer: CellRendererFunc;
|
|
380
|
+
// (undocumented)
|
|
381
|
+
rendererParams: CellRendererParams;
|
|
382
|
+
// (undocumented)
|
|
383
|
+
slottedRenderer: HTMLElement[];
|
|
384
|
+
// (undocumented)
|
|
385
|
+
slottedRendererChanged(): void;
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
// @public
|
|
389
|
+
export enum GridTabulatorCellEditorTypes {
|
|
390
|
+
// (undocumented)
|
|
391
|
+
date = "date",
|
|
392
|
+
// (undocumented)
|
|
393
|
+
multiselect = "multiselect",
|
|
394
|
+
// (undocumented)
|
|
395
|
+
number = "number",
|
|
396
|
+
// (undocumented)
|
|
397
|
+
select = "select",
|
|
398
|
+
// (undocumented)
|
|
399
|
+
string = "string"
|
|
400
|
+
}
|
|
401
|
+
|
|
188
402
|
// @public
|
|
189
403
|
export enum GridTabulatorCellRendererTypes {
|
|
190
404
|
// (undocumented)
|
|
@@ -194,6 +408,8 @@ export enum GridTabulatorCellRendererTypes {
|
|
|
194
408
|
// (undocumented)
|
|
195
409
|
boolean = "boolean",
|
|
196
410
|
// (undocumented)
|
|
411
|
+
editable = "editable",
|
|
412
|
+
// (undocumented)
|
|
197
413
|
select = "select",
|
|
198
414
|
// (undocumented)
|
|
199
415
|
text = "text"
|
|
@@ -219,18 +435,21 @@ export class GridTabulatorClientSideDatasource extends GridTabulatorClientSideDa
|
|
|
219
435
|
datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
|
|
220
436
|
// (undocumented)
|
|
221
437
|
deepClone(): Node;
|
|
438
|
+
deferredColumnStates: any[];
|
|
222
439
|
// (undocumented)
|
|
223
|
-
deferredGridOptions:
|
|
440
|
+
deferredGridOptions: Options_2;
|
|
224
441
|
// @public
|
|
225
442
|
destroy(): void;
|
|
226
443
|
// (undocumented)
|
|
227
444
|
disconnectedCallback(): void;
|
|
228
445
|
// (undocumented)
|
|
229
446
|
fields: string;
|
|
447
|
+
handleErrors(errors: string | any[]): void;
|
|
230
448
|
// @public
|
|
231
449
|
init(): Promise<void>;
|
|
232
450
|
// (undocumented)
|
|
233
451
|
isSnapshot: boolean;
|
|
452
|
+
keepColDefsOnClearRowData: boolean;
|
|
234
453
|
// @internal
|
|
235
454
|
loadResourceData(withFullInit?: boolean): Promise<void>;
|
|
236
455
|
// (undocumented)
|
|
@@ -264,6 +483,31 @@ export class GridTabulatorClientSideDatasource extends GridTabulatorClientSideDa
|
|
|
264
483
|
setFilter(fieldName: string, newFilter: string): void;
|
|
265
484
|
}
|
|
266
485
|
|
|
486
|
+
// Warning: (ae-forgotten-export) The symbol "GridTabulatorColumn_base" needs to be exported by the entry point index.d.ts
|
|
487
|
+
//
|
|
488
|
+
// @public
|
|
489
|
+
export class GridTabulatorColumn extends GridTabulatorColumn_base {
|
|
490
|
+
// (undocumented)
|
|
491
|
+
deepClone(): Node;
|
|
492
|
+
// (undocumented)
|
|
493
|
+
definition: Partial<ColumnDefinition_2>;
|
|
494
|
+
// (undocumented)
|
|
495
|
+
slottedCell: HTMLElement[];
|
|
496
|
+
// (undocumented)
|
|
497
|
+
slottedCellChanged(): void;
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
// @alpha
|
|
501
|
+
export const gridTabulatorErrorNames: {
|
|
502
|
+
datasource: string;
|
|
503
|
+
};
|
|
504
|
+
|
|
505
|
+
// @alpha
|
|
506
|
+
export const gridTabulatorEventNames: {
|
|
507
|
+
error: string;
|
|
508
|
+
datasourceErrorClose: string;
|
|
509
|
+
};
|
|
510
|
+
|
|
267
511
|
// @public
|
|
268
512
|
export const gridTabulatorShadowOptions: ShadowRootInit;
|
|
269
513
|
|
|
@@ -284,7 +528,13 @@ export enum GridTabulatorTheme {
|
|
|
284
528
|
// @public
|
|
285
529
|
export const logger: Logger;
|
|
286
530
|
|
|
287
|
-
|
|
531
|
+
// @alpha
|
|
532
|
+
export function mergeAndDedupColDefWithColumnState(colDefs: any[], columnState: any[]): any[];
|
|
533
|
+
|
|
534
|
+
// @alpha
|
|
535
|
+
export type Options = {
|
|
536
|
+
formatters?: Record<string, Formatter>;
|
|
537
|
+
} & Omit<Options_2, 'formatters'>;
|
|
288
538
|
|
|
289
539
|
// @public
|
|
290
540
|
export interface RowDataTransaction<TData = any> {
|
|
@@ -294,8 +544,24 @@ export interface RowDataTransaction<TData = any> {
|
|
|
294
544
|
update?: TData[] | null;
|
|
295
545
|
}
|
|
296
546
|
|
|
547
|
+
// Warning: (ae-incompatible-release-tags) The symbol "selectFormatter" is marked as @public, but its signature references "SelectFormatterParams" which is marked as @alpha
|
|
548
|
+
//
|
|
297
549
|
// @public
|
|
298
|
-
export
|
|
550
|
+
export function selectFormatter(cell: any, formatterParams: SelectFormatterParams): string;
|
|
551
|
+
|
|
552
|
+
// @alpha
|
|
553
|
+
export interface SelectFormatterParams {
|
|
554
|
+
// (undocumented)
|
|
555
|
+
dataTestId?: string;
|
|
556
|
+
// (undocumented)
|
|
557
|
+
nullText?: string;
|
|
558
|
+
// Warning: (ae-forgotten-export) The symbol "SelectOption" needs to be exported by the entry point index.d.ts
|
|
559
|
+
//
|
|
560
|
+
// (undocumented)
|
|
561
|
+
options: SelectOption[];
|
|
562
|
+
// (undocumented)
|
|
563
|
+
prefix?: string;
|
|
564
|
+
}
|
|
299
565
|
|
|
300
566
|
// @public
|
|
301
567
|
export const tabulatorExternalStockStyles: ElementStyles;
|
|
@@ -303,6 +569,27 @@ export const tabulatorExternalStockStyles: ElementStyles;
|
|
|
303
569
|
// @public
|
|
304
570
|
export const tabulatorThemeSimpleCSS: ElementStyles;
|
|
305
571
|
|
|
572
|
+
// Warning: (ae-incompatible-release-tags) The symbol "textFormatter" is marked as @public, but its signature references "TextFormatterParams" which is marked as @alpha
|
|
573
|
+
//
|
|
574
|
+
// @public
|
|
575
|
+
export function textFormatter(cell: any, formatterParams?: TextFormatterParams): string;
|
|
576
|
+
|
|
577
|
+
// @alpha
|
|
578
|
+
export interface TextFormatterParams {
|
|
579
|
+
// (undocumented)
|
|
580
|
+
dataTestId?: string;
|
|
581
|
+
// (undocumented)
|
|
582
|
+
nullText?: string;
|
|
583
|
+
// (undocumented)
|
|
584
|
+
prefix?: string;
|
|
585
|
+
// (undocumented)
|
|
586
|
+
specialColor?: string;
|
|
587
|
+
// (undocumented)
|
|
588
|
+
specialFontWeight?: string;
|
|
589
|
+
// (undocumented)
|
|
590
|
+
specialValue?: any;
|
|
591
|
+
}
|
|
592
|
+
|
|
306
593
|
// @public
|
|
307
594
|
export const themeFontsId: (themeName: string) => string;
|
|
308
595
|
|
|
@@ -314,7 +601,12 @@ export const themeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>
|
|
|
314
601
|
|
|
315
602
|
// Warnings were encountered during analysis:
|
|
316
603
|
//
|
|
317
|
-
// src/grid-tabulator.components.ts:
|
|
604
|
+
// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "DateEditor" needs to be exported by the entry point index.d.ts
|
|
605
|
+
// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "NumberEditor" needs to be exported by the entry point index.d.ts
|
|
606
|
+
// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "SelectEditor" needs to be exported by the entry point index.d.ts
|
|
607
|
+
// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "StringEditor" needs to be exported by the entry point index.d.ts
|
|
608
|
+
// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "MultiselectEditor" needs to be exported by the entry point index.d.ts
|
|
609
|
+
// src/grid-tabulator.components.ts:24:47 - (ae-incompatible-release-tags) The symbol "foundationGridTabulator" is marked as @public, but its signature references "GridTabulator" which is marked as @alpha
|
|
318
610
|
|
|
319
611
|
// (No @packageDocumentation comment for this package)
|
|
320
612
|
|