@genesislcap/grid-tabulator 14.408.0 → 14.409.0

package/docs/api/grid-tabulator.gridtabulator.downloaddataas.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; [downloadDataAs](./grid-tabulator.gridtabulator.downloaddataas.md)
-
-## GridTabulator.downloadDataAs() method
-
-Download the Grid data as a file of the specified type.
-
-**Signature:**
-
-```typescript
-downloadDataAs(type: 'csv' | 'json' | 'html', fileName: string, params?: DownloadOptions, filter?: RowRangeLookup): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-type
-
-
-</td><td>
-
-'csv' \| 'json' \| 'html'
-
-
-</td><td>
-
-csv \| json \| html
-
-
-</td></tr>
-<tr><td>
-
-fileName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-name of the file to download
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-DownloadOptions
-
-
-</td><td>
-
-_(Optional)_ optional download params
-
-
-</td></tr>
-<tr><td>
-
-filter
-
-
-</td><td>
-
-RowRangeLookup
-
-
-</td><td>
-
-_(Optional)_ optional row range lookup filter
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,21 +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; [enableCellFlashing](./grid-tabulator.gridtabulator.enablecellflashing.md)
-
-## GridTabulator.enableCellFlashing 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.
-> 
-
-If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
-
-**Signature:**
-
-```typescript
-enableCellFlashing: boolean;
-```
-
-## Remarks
-
-Defaults to true
-

package/docs/api/grid-tabulator.gridtabulator.enablerowflashing.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; [enableRowFlashing](./grid-tabulator.gridtabulator.enablerowflashing.md)
-
-## GridTabulator.enableRowFlashing 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.
-> 
-
-If true, will enable row flashing for all rows
-
-**Signature:**
-
-```typescript
-enableRowFlashing: boolean;
-```

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

package/docs/api/grid-tabulator.gridtabulator.gridautosizingenabled.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; [gridAutosizingEnabled](./grid-tabulator.gridtabulator.gridautosizingenabled.md)
-
-## GridTabulator.gridAutosizingEnabled 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.
-> 
-
-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`<!-- -->.
-
-**Signature:**
-
-```typescript
-gridAutosizingEnabled: boolean;
-```

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

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

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

@@ -1,30 +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; [gridOptions](./grid-tabulator.gridtabulator.gridoptions.md)
-
-## GridTabulator.gridOptions property
-
-The current grid options.
-
-**Signature:**
-
-```typescript
-get gridOptions(): Options;
-
-set gridOptions(options: Options);
-```
-
-## Remarks
-
-See https://tabulator.info/docs/6.3/options for more details.
-
-## Example
-
-
-```ts
- ...
- const options = this.grid.getOptions();
- logger.debug(options); // { data: [...], columns: [...], filterMode: "local", groupBy: false, ... }
- ...
-```
-

package/docs/api/grid-tabulator.gridtabulator.headercasetype.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; [GridTabulator](./grid-tabulator.gridtabulator.md) &gt; [headerCaseType](./grid-tabulator.gridtabulator.headercasetype.md)
-
-## GridTabulator.headerCaseType property
-
-The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used.
-
-**Signature:**
-
-```typescript
-headerCaseType: GridTabulatorCaseType;
-```
-
-## Remarks
-
-Can be one of the following: camelCase, capitalCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase.
-