npm - @genesislcap/grid-tabulator - Versions diffs - 14.408.0 → 14.409.0-FUI-2495.2 - Mend

@genesislcap/grid-tabulator 14.408.0 → 14.409.0-FUI-2495.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.

Files changed (168) hide show

package/docs/api/grid-tabulator.mergeanddedupcoldefwithcolumnstate.md DELETED Viewed

@@ -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; [mergeAndDedupColDefWithColumnState](./grid-tabulator.mergeanddedupcoldefwithcolumnstate.md)
-## mergeAndDedupColDefWithColumnState() 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.
->
-Merges and dedupes column definitions with column state
-**Signature:**
-```typescript
-export declare function mergeAndDedupColDefWithColumnState(colDefs: any[], columnState: any[]): any[];
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-colDefs
-</td><td>
-any\[\]
-</td><td>
-The column definitions
-</td></tr>
-<tr><td>
-columnState
-</td><td>
-any\[\]
-</td><td>
-The column state
-</td></tr>
-</tbody></table>
-**Returns:**
-any\[\]
-The merged column definitions

package/docs/api/grid-tabulator.options.md DELETED Viewed

@@ -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; [Options](./grid-tabulator.options.md)
-## Options 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 Tabulator Options with custom formatters
-**Signature:**
-```typescript
-export type Options = {
-    formatters?: Record<string, Formatter>;
-    columns?: ColumnDefinition[];
-} & Omit<TabulatorOptions, 'formatters'>;
-```
-**References:** [ColumnDefinition](./grid-tabulator.columndefinition.md)

package/docs/api/grid-tabulator.rowdatatransaction.add.md DELETED Viewed

@@ -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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [add](./grid-tabulator.rowdatatransaction.add.md)
-## RowDataTransaction.add property
-Rows to add
-**Signature:**
-```typescript
-add?: TData[] | null;
-```

package/docs/api/grid-tabulator.rowdatatransaction.addindex.md DELETED Viewed

@@ -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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [addIndex](./grid-tabulator.rowdatatransaction.addindex.md)
-## RowDataTransaction.addIndex property
-Index to add rows
-**Signature:**
-```typescript
-addIndex?: number | null;
-```

package/docs/api/grid-tabulator.rowdatatransaction.md DELETED Viewed

@@ -1,115 +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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md)
-## RowDataTransaction interface
-Transaction object to handle row data updates.
-**Signature:**
-```typescript
-export interface RowDataTransaction<TData = any>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[add?](./grid-tabulator.rowdatatransaction.add.md)
-</td><td>
-</td><td>
-TData\[\] \| null
-</td><td>
-_(Optional)_ Rows to add
-</td></tr>
-<tr><td>
-[addIndex?](./grid-tabulator.rowdatatransaction.addindex.md)
-</td><td>
-</td><td>
-number \| null
-</td><td>
-_(Optional)_ Index to add rows
-</td></tr>
-<tr><td>
-[remove?](./grid-tabulator.rowdatatransaction.remove.md)
-</td><td>
-</td><td>
-TData\[\] \| null
-</td><td>
-_(Optional)_ Rows to remove
-</td></tr>
-<tr><td>
-[update?](./grid-tabulator.rowdatatransaction.update.md)
-</td><td>
-</td><td>
-TData\[\] \| null
-</td><td>
-_(Optional)_ Rows to update
-</td></tr>
-</tbody></table>

package/docs/api/grid-tabulator.rowdatatransaction.remove.md DELETED Viewed

@@ -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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [remove](./grid-tabulator.rowdatatransaction.remove.md)
-## RowDataTransaction.remove property
-Rows to remove
-**Signature:**
-```typescript
-remove?: TData[] | null;
-```

package/docs/api/grid-tabulator.rowdatatransaction.update.md DELETED Viewed

@@ -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; [RowDataTransaction](./grid-tabulator.rowdatatransaction.md) &gt; [update](./grid-tabulator.rowdatatransaction.update.md)
-## RowDataTransaction.update property
-Rows to update
-**Signature:**
-```typescript
-update?: TData[] | null;
-```

package/docs/api/grid-tabulator.selectformatter.md DELETED Viewed

@@ -1,72 +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; [selectFormatter](./grid-tabulator.selectformatter.md)
-## selectFormatter() function
-Formatter that displays a select component with options. Returns a wrapped div containing the select, similar to boolean.formatter.
-**Signature:**
-```typescript
-export declare function selectFormatter<T = any>(cell: any, formatterParams: SelectFormatterParams<T>): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-cell
-</td><td>
-any
-</td><td>
-The cell component provided by Tabulator
-</td></tr>
-<tr><td>
-formatterParams
-</td><td>
-[SelectFormatterParams](./grid-tabulator.selectformatterparams.md)<!-- -->&lt;T&gt;
-</td><td>
-Select formatter parameters
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-An empty string, as the component is added directly to the cell element

package/docs/api/grid-tabulator.selectformatterparams.datatestid.md DELETED Viewed

@@ -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; [SelectFormatterParams](./grid-tabulator.selectformatterparams.md) &gt; [dataTestId](./grid-tabulator.selectformatterparams.datatestid.md)
-## SelectFormatterParams.dataTestId 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
-dataTestId?: ((rowData: T) => string) | string;
-```

package/docs/api/grid-tabulator.selectformatterparams.md DELETED Viewed

@@ -1,147 +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; [SelectFormatterParams](./grid-tabulator.selectformatterparams.md)
-## SelectFormatterParams interface
-> 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.
->
-Parameters for the select formatter
-`options`<!-- -->: Array of options for the select
-`nullText`<!-- -->: Text to display for null/undefined values
-`dataTestId`<!-- -->: Data test ID for testing
-`prefix`<!-- -->: The prefix to use for element classes, e.g., 'foundation', 'zero', 'rapid'. Defaults to 'foundation' if not specified.
-`onChange`<!-- -->: Optional callback when the selection changes
-**Signature:**
-```typescript
-export interface SelectFormatterParams<T = any>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[dataTestId?](./grid-tabulator.selectformatterparams.datatestid.md)
-</td><td>
-</td><td>
-((rowData: T) =&gt; string) \| string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[nullText?](./grid-tabulator.selectformatterparams.nulltext.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[onChange?](./grid-tabulator.selectformatterparams.onchange.md)
-</td><td>
-</td><td>
-(value: string, rowData: T) =&gt; void
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-<tr><td>
-[options](./grid-tabulator.selectformatterparams.options.md)
-</td><td>
-</td><td>
-SelectOption&lt;T&gt;\[\]
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-<tr><td>
-[prefix?](./grid-tabulator.selectformatterparams.prefix.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_** _(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/grid-tabulator.selectformatterparams.nulltext.md DELETED Viewed

@@ -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; [SelectFormatterParams](./grid-tabulator.selectformatterparams.md) &gt; [nullText](./grid-tabulator.selectformatterparams.nulltext.md)
-## SelectFormatterParams.nullText 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
-nullText?: string;
-```

package/docs/api/grid-tabulator.selectformatterparams.onchange.md DELETED Viewed

@@ -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; [SelectFormatterParams](./grid-tabulator.selectformatterparams.md) &gt; [onChange](./grid-tabulator.selectformatterparams.onchange.md)
-## SelectFormatterParams.onChange 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
-onChange?: (value: string, rowData: T) => void;
-```

package/docs/api/grid-tabulator.selectformatterparams.options.md DELETED Viewed

@@ -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; [SelectFormatterParams](./grid-tabulator.selectformatterparams.md) &gt; [options](./grid-tabulator.selectformatterparams.options.md)
-## SelectFormatterParams.options 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
-options: SelectOption<T>[];
-```

package/docs/api/grid-tabulator.selectformatterparams.prefix.md DELETED Viewed

@@ -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; [SelectFormatterParams](./grid-tabulator.selectformatterparams.md) &gt; [prefix](./grid-tabulator.selectformatterparams.prefix.md)
-## SelectFormatterParams.prefix 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
-prefix?: string;
-```

package/docs/api/grid-tabulator.tabulatorexternalstockstyles.md DELETED Viewed

@@ -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; [tabulatorExternalStockStyles](./grid-tabulator.tabulatorexternalstockstyles.md)
-## tabulatorExternalStockStyles variable
-External styles for the Tabulator grid.
-**Signature:**
-```typescript
-tabulatorExternalStockStyles: import("@microsoft/fast-element").ElementStyles
-```

package/docs/api/grid-tabulator.tabulatorthemesimplecss.md DELETED Viewed

@@ -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; [tabulatorThemeSimpleCSS](./grid-tabulator.tabulatorthemesimplecss.md)
-## tabulatorThemeSimpleCSS variable
-External styles for the Tabulator grid.
-**Signature:**
-```typescript
-tabulatorThemeSimpleCSS: import("@microsoft/fast-element").ElementStyles
-```

package/docs/api/grid-tabulator.textformatter.md DELETED Viewed

@@ -1,72 +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; [textFormatter](./grid-tabulator.textformatter.md)
-## textFormatter() function
-Text formatter for customized display of values. Styled to match grid-pro text renderer.
-**Signature:**
-```typescript
-export declare function textFormatter<T = any>(cell: any, formatterParams?: TextFormatterParams<T>): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-cell
-</td><td>
-any
-</td><td>
-The cell component provided by Tabulator
-</td></tr>
-<tr><td>
-formatterParams
-</td><td>
-[TextFormatterParams](./grid-tabulator.textformatterparams.md)<!-- -->&lt;T&gt;
-</td><td>
-_(Optional)_ Text formatter parameters
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-Text content for the cell

package/docs/api/grid-tabulator.textformatterparams.datatestid.md DELETED Viewed

@@ -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; [TextFormatterParams](./grid-tabulator.textformatterparams.md) &gt; [dataTestId](./grid-tabulator.textformatterparams.datatestid.md)
-## TextFormatterParams.dataTestId 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
-dataTestId?: ((rowData: T) => string) | string;
-```