@genesislcap/grid-tabulator 14.408.0 → 14.409.0-FUI-2495.2

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

@@ -1,494 +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)
-
-## GridTabulator class
-
-> 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
-export declare class GridTabulator extends GridTabulator_base 
-```
-**Extends:** GridTabulator\_base
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[autoCellRendererByType](./grid-tabulator.gridtabulator.autocellrendererbytype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[classNames](./grid-tabulator.gridtabulator.classnames.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[columnComponentName](./grid-tabulator.gridtabulator.columncomponentname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The column component name used for querying child column elements
-
-
-</td></tr>
-<tr><td>
-
-[enableCellFlashing](./grid-tabulator.gridtabulator.enablecellflashing.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_** If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
-
-
-</td></tr>
-<tr><td>
-
-[enableRowFlashing](./grid-tabulator.gridtabulator.enablerowflashing.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_** If true, will enable row flashing for all rows
-
-
-</td></tr>
-<tr><td>
-
-[grid](./grid-tabulator.gridtabulator.grid.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Tabulator \| undefined
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[gridAutosizingEnabled](./grid-tabulator.gridtabulator.gridautosizingenabled.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_** Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using `persist-column-state-key`<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[gridDiv](./grid-tabulator.gridtabulator.griddiv.md)
-
-
-</td><td>
-
-
-</td><td>
-
-HTMLDivElement
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[gridFontFace](./grid-tabulator.gridtabulator.gridfontface.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[gridOptions](./grid-tabulator.gridtabulator.gridoptions.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Options](./grid-tabulator.options.md)
-
-
-</td><td>
-
-The current grid options.
-
-
-</td></tr>
-<tr><td>
-
-[headerCaseType](./grid-tabulator.gridtabulator.headercasetype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[GridTabulatorCaseType](./grid-tabulator.gridtabulatorcasetype.md)
-
-
-</td><td>
-
-The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used.
-
-
-</td></tr>
-<tr><td>
-
-[onlyTemplateColDefs](./grid-tabulator.gridtabulator.onlytemplatecoldefs.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[persistColumnStateKey](./grid-tabulator.gridtabulator.persistcolumnstatekey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[persistFilterModelKey](./grid-tabulator.gridtabulator.persistfiltermodelkey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_** The key to use for persisting the filter model in local browser or KV storage.
-
-
-</td></tr>
-<tr><td>
-
-[rowData](./grid-tabulator.gridtabulator.rowdata.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any\[\]
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[rowHeight](./grid-tabulator.gridtabulator.rowheight.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[showHeaderFilters](./grid-tabulator.gridtabulator.showheaderfilters.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_** If true, will show header filters on columns by default
-
-
-</td></tr>
-<tr><td>
-
-[statePersistanceEnabled](./grid-tabulator.gridtabulator.statepersistanceenabled.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[theme](./grid-tabulator.gridtabulator.theme.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[clearFilters()](./grid-tabulator.gridtabulator.clearfilters.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Clear all filters
-
-
-</td></tr>
-<tr><td>
-
-[downloadDataAs(type, fileName, params, filter)](./grid-tabulator.gridtabulator.downloaddataas.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Download the Grid data as a file of the specified type.
-
-
-</td></tr>
-<tr><td>
-
-[redraw()](./grid-tabulator.gridtabulator.redraw.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Redraw the table
-
-
-</td></tr>
-<tr><td>
-
-[refreshCells()](./grid-tabulator.gridtabulator.refreshcells.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Refresh the grid cells
-
-
-</td></tr>
-<tr><td>
-
-[setFilter(column, operator, value, filterParams)](./grid-tabulator.gridtabulator.setfilter.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Set the Grid client-side filters.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/grid-tabulator.gridtabulator.onlytemplatecoldefs.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; [onlyTemplateColDefs](./grid-tabulator.gridtabulator.onlytemplatecoldefs.md)
-
-## GridTabulator.onlyTemplateColDefs 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
-onlyTemplateColDefs: boolean;
-```

package/docs/api/grid-tabulator.gridtabulator.persistcolumnstatekey.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; [persistColumnStateKey](./grid-tabulator.gridtabulator.persistcolumnstatekey.md)
-
-## GridTabulator.persistColumnStateKey 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
-persistColumnStateKey: string;
-```

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

@@ -1,16 +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; [persistFilterModelKey](./grid-tabulator.gridtabulator.persistfiltermodelkey.md)
-
-## GridTabulator.persistFilterModelKey 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.
-> 
-
-The key to use for persisting the filter model in local browser or KV storage.
-
-**Signature:**
-
-```typescript
-persistFilterModelKey: string;
-```

package/docs/api/grid-tabulator.gridtabulator.redraw.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; [redraw](./grid-tabulator.gridtabulator.redraw.md)
-
-## GridTabulator.redraw() method
-
-Redraw the table
-
-**Signature:**
-
-```typescript
-redraw(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/grid-tabulator.gridtabulator.refreshcells.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; [refreshCells](./grid-tabulator.gridtabulator.refreshcells.md)
-
-## GridTabulator.refreshCells() method
-
-Refresh the grid cells
-
-**Signature:**
-
-```typescript
-refreshCells(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/grid-tabulator.gridtabulator.rowdata.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; [rowData](./grid-tabulator.gridtabulator.rowdata.md)
-
-## GridTabulator.rowData 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
-rowData: any[];
-```

package/docs/api/grid-tabulator.gridtabulator.rowheight.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; [rowHeight](./grid-tabulator.gridtabulator.rowheight.md)
-
-## GridTabulator.rowHeight 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
-rowHeight: number;
-```

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

@@ -1,102 +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; [setFilter](./grid-tabulator.gridtabulator.setfilter.md)
-
-## GridTabulator.setFilter() method
-
-Set the Grid client-side filters.
-
-**Signature:**
-
-```typescript
-setFilter(column: string, operator: string, value: string, filterParams?: FilterParams): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-column
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-column name
-
-
-</td></tr>
-<tr><td>
-
-operator
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-filter operator
-
-
-</td></tr>
-<tr><td>
-
-value
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-filter value
-
-
-</td></tr>
-<tr><td>
-
-filterParams
-
-
-</td><td>
-
-FilterParams
-
-
-</td><td>
-
-_(Optional)_ optional filter params
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-