@genesislcap/grid-tabulator 14.408.0 → 14.409.0

package/docs/api/grid-tabulator.formatterparams.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [FormatterParams](./grid-tabulator.formatterparams.md)
-
-## FormatterParams type
-
-> 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.
-> 
-
-Extended FormatterParams type that includes all of our custom formatter parameter interfaces
-
-**Signature:**
-
-```typescript
-export type FormatterParams = TabulatorFormatterParams | ActionFormatterParams | ActionsMenuFormatterParams | BooleanFormatterParams | EditableFormatterParams | SelectFormatterParams | TextFormatterParams;
-```
-**References:** [ActionFormatterParams](./grid-tabulator.actionformatterparams.md)<!-- -->, [ActionsMenuFormatterParams](./grid-tabulator.actionsmenuformatterparams.md)<!-- -->, [BooleanFormatterParams](./grid-tabulator.booleanformatterparams.md)<!-- -->, [EditableFormatterParams](./grid-tabulator.editableformatterparams.md)<!-- -->, [SelectFormatterParams](./grid-tabulator.selectformatterparams.md)<!-- -->, [TextFormatterParams](./grid-tabulator.textformatterparams.md)
-

package/docs/api/grid-tabulator.formatters.md

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [formatters](./grid-tabulator.formatters.md)
-
-## formatters variable
-
-> 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.
-> 
-
-Zero formatters for Tabulator grid
-
-**Signature:**
-
-```typescript
-formatters: {
-    action: typeof actionFormatter;
-    actionsMenu: typeof actionsMenuFormatter;
-    boolean: typeof booleanFormatter;
-    editable: typeof editableFormatter;
-    select: typeof selectFormatter;
-    text: typeof textFormatter;
-}
-```

package/docs/api/grid-tabulator.formattertypes.md

@@ -1,133 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [FormatterTypes](./grid-tabulator.formattertypes.md)
-
-## FormatterTypes enum
-
-> 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.
-> 
-
-Enumeration of formatter types for grid-tabulator.
-
-**Signature:**
-
-```typescript
-export declare enum FormatterTypes 
-```
-
-## Enumeration Members
-
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-action
-
-
-</td><td>
-
-`"action"`
-
-
-</td><td>
-
-**_(ALPHA)_** Action button formatter
-
-
-</td></tr>
-<tr><td>
-
-actionsMenu
-
-
-</td><td>
-
-`"actionsMenu"`
-
-
-</td><td>
-
-**_(ALPHA)_** Actions menu formatter with dropdown options
-
-
-</td></tr>
-<tr><td>
-
-boolean
-
-
-</td><td>
-
-`"boolean"`
-
-
-</td><td>
-
-**_(ALPHA)_** Boolean formatter for true/false values
-
-
-</td></tr>
-<tr><td>
-
-editable
-
-
-</td><td>
-
-`"editable"`
-
-
-</td><td>
-
-**_(ALPHA)_** Editable formatter for cells that can be edited
-
-
-</td></tr>
-<tr><td>
-
-select
-
-
-</td><td>
-
-`"select"`
-
-
-</td><td>
-
-**_(ALPHA)_** Select formatter for displaying option values
-
-
-</td></tr>
-<tr><td>
-
-text
-
-
-</td><td>
-
-`"text"`
-
-
-</td><td>
-
-**_(ALPHA)_** Text formatter for basic text display with optional formatting
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/grid-tabulator.foundationgridtabulator.md

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [foundationGridTabulator](./grid-tabulator.foundationgridtabulator.md)
-
-## foundationGridTabulator() function
-
-> 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.
-> 
-
-The Foundation grid-tabulator
-
-**Signature:**
-
-```typescript
-foundationGridTabulator: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-    shadowOptions: any;
-    baseName: string;
-    styles: import("@microsoft/fast-element").ElementStyles;
-    template: import("@microsoft/fast-element").ViewTemplate<any, any>;
-}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-    shadowOptions: any;
-    baseName: string;
-    styles: import("@microsoft/fast-element").ElementStyles;
-    template: import("@microsoft/fast-element").ViewTemplate<any, any>;
-}, typeof GridTabulator>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-overrideDefinition
-
-
-</td><td>
-
-import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ shadowOptions: any; baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }&gt;
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ shadowOptions: any; baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }, typeof [GridTabulator](./grid-tabulator.gridtabulator.md)<!-- -->&gt;
-
-## Remarks
-
-HTML Element: &lt;<!-- -->grid-tabulator<!-- -->&gt;
-

package/docs/api/grid-tabulator.foundationgridtabulatorcomponents.md

@@ -1,81 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [foundationGridTabulatorComponents](./grid-tabulator.foundationgridtabulatorcomponents.md)
-
-## foundationGridTabulatorComponents variable
-
-All `grid-tabulator` components.
-
-**Signature:**
-
-```typescript
-foundationGridTabulatorComponents: {
-    foundationDateEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/date.editor").DateEditor, any>;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/date.editor").DateEditor, any>;
-    }, typeof import("./cell-editors/date.editor").DateEditor>;
-    foundationNumberEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/number.editor").NumberEditor, any>;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/number.editor").NumberEditor, any>;
-    }, typeof import("./cell-editors/number.editor").NumberEditor>;
-    foundationSelectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/select.editor").SelectEditor, any>;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/select.editor").SelectEditor, any>;
-    }, typeof import("./cell-editors/select.editor").SelectEditor>;
-    foundationStringEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/string.editor").StringEditor, any>;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/string.editor").StringEditor, any>;
-    }, typeof import("./cell-editors/string.editor").StringEditor>;
-    foundationMultiselectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/multiselect.editor").MultiselectEditor, any>;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors/multiselect.editor").MultiselectEditor, any>;
-    }, typeof import("./cell-editors/multiselect.editor").MultiselectEditor>;
-    foundationGridTabulatorColumn: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-    }, typeof GridTabulatorColumn>;
-    foundationGridTabulatorCell: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-    }, typeof GridTabulatorCell>;
-    foundationGridTabulator: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        shadowOptions: any;
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        shadowOptions: any;
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
-    }, typeof import("./grid-tabulator").GridTabulator>;
-    register(container?: Container, ...rest: any[]): void;
-}
-```

package/docs/api/grid-tabulator.getcolumntype.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [getColumnType](./grid-tabulator.getcolumntype.md)
-
-## getColumnType() function
-
-Get the column type based on the metadata type.
-
-**Signature:**
-
-```typescript
-export declare function getColumnType(metadataType: string): string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-metadataType
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The metadata type.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-The column type.
-

package/docs/api/grid-tabulator.getdatatestid.md

@@ -1,75 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [getDataTestId](./grid-tabulator.getdatatestid.md)
-
-## getDataTestId() function
-
-> 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.
-> 
-
-Resolves a dataTestId value that can be either a string or a function
-
-**Signature:**
-
-```typescript
-export declare function getDataTestId<T = any>(dataTestId: ((rowData: T) => string) | string | undefined, rowData: T): string | undefined;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dataTestId
-
-
-</td><td>
-
-((rowData: T) =&gt; string) \| string \| undefined
-
-
-</td><td>
-
-The dataTestId value (string or function)
-
-
-</td></tr>
-<tr><td>
-
-rowData
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The row data to pass to the function if dataTestId is a function
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string \| undefined
-
-The resolved test ID string or undefined if not provided
-

package/docs/api/grid-tabulator.getfilterbyfieldtype.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [getFilterByFieldType](./grid-tabulator.getfilterbyfieldtype.md)
-
-## getFilterByFieldType() function
-
-Get the filter type based on the field type.
-
-**Signature:**
-
-```typescript
-export declare function getFilterByFieldType(type: string): string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-type
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The field type.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-The filter type.
-

package/docs/api/grid-tabulator.getfilterparamsbyfieldtype.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [getFilterParamsByFieldType](./grid-tabulator.getfilterparamsbyfieldtype.md)
-
-## getFilterParamsByFieldType() function
-
-Get the filter params based on the field type.
-
-**Signature:**
-
-```typescript
-export declare function getFilterParamsByFieldType(type: string): FilterParams;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-type
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The field type.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-FilterParams
-
-The filter params.
-

package/docs/api/grid-tabulator.gridcssvars.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridCSSVars](./grid-tabulator.gridcssvars.md)
-
-## GridCSSVars enum
-
-All official Tabulator CSS variables
-
-**Signature:**
-
-```typescript
-export declare enum GridCSSVars 
-```

package/docs/api/grid-tabulator.gridtabulator.autocellrendererbytype.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulator](./grid-tabulator.gridtabulator.md) &gt; [autoCellRendererByType](./grid-tabulator.gridtabulator.autocellrendererbytype.md)
-
-## GridTabulator.autoCellRendererByType property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-autoCellRendererByType: boolean;
-```

package/docs/api/grid-tabulator.gridtabulator.classnames.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulator](./grid-tabulator.gridtabulator.md) &gt; [classNames](./grid-tabulator.gridtabulator.classnames.md)
-
-## GridTabulator.classNames property
-
-> 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.
-> 
-
-**Signature:**
-
-```typescript
-classNames: string;
-```

package/docs/api/grid-tabulator.gridtabulator.clearfilters.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulator](./grid-tabulator.gridtabulator.md) &gt; [clearFilters](./grid-tabulator.gridtabulator.clearfilters.md)
-
-## GridTabulator.clearFilters() method
-
-Clear all filters
-
-**Signature:**
-
-```typescript
-clearFilters(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/grid-tabulator.gridtabulator.columncomponentname.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-tabulator](./grid-tabulator.md) &gt; [GridTabulator](./grid-tabulator.gridtabulator.md) &gt; [columnComponentName](./grid-tabulator.gridtabulator.columncomponentname.md)
-
-## GridTabulator.columnComponentName property
-
-The column component name used for querying child column elements
-
-**Signature:**
-
-```typescript
-columnComponentName: string;
-```