npm - @genesislcap/grid-pro - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/grid-pro 14.408.0 → 14.409.0

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 (677) hide show

package/docs/api/grid-pro.gridpro.mergeallcolumndefsandstates.md DELETED Viewed

@@ -1,76 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [mergeAllColumnDefsAndStates](./grid-pro.gridpro.mergeallcolumndefsandstates.md)
-## GridPro.mergeAllColumnDefsAndStates() method
-Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`<!-- -->.
-**Signature:**
-```typescript
-mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-columnDefs
-</td><td>
-ColDef\[\]
-</td><td>
-The column definitions to apply to the grid.
-</td></tr>
-<tr><td>
-deferredColumnDefsOrState
-</td><td>
-boolean
-</td><td>
-_(Optional)_ If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;ColDef&lt;any&gt;\[\]&gt;
-The merged column definitions.
-## Remarks
-This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.

package/docs/api/grid-pro.gridpro.observedattributes.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [observedAttributes](./grid-pro.gridpro.observedattributes.md)
-## GridPro.observedAttributes property
-**Signature:**
-```typescript
-get observedAttributes(): string[];
-```

package/docs/api/grid-pro.gridpro.onlytemplatecoldefs.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md)
-## GridPro.onlyTemplateColDefs property
-**Signature:**
-```typescript
-onlyTemplateColDefs: boolean;
-```

package/docs/api/grid-pro.gridpro.pagination.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [pagination](./grid-pro.gridpro.pagination.md)
-## GridPro.pagination property
-Enable pagination for the grid.
-**Signature:**
-```typescript
-pagination: boolean;
-```
-## Remarks
-When enabled, the grid will automatically configure pagination settings. Note that AG Grid's full pagination functionality requires the Enterprise module. While basic pagination will work in Community edition, advanced features like custom pagination components require Enterprise.

package/docs/api/grid-pro.gridpro.paginationpagesize.md DELETED Viewed

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [paginationPageSize](./grid-pro.gridpro.paginationpagesize.md)
-## GridPro.paginationPageSize property
-Number of rows per page when pagination is enabled.
-**Signature:**
-```typescript
-paginationPageSize: number;
-```
-## Remarks
-\*\*Default Value:\*\* `DatasourceDefaults.DEFAULT_PAGINATION_PAGE_SIZE (25)` (default MAX\_ROWS divided by 10)
-\*\*Only used when pagination is enabled on client-side, server-side pagination page size is fixed to MAX\_ROWS.\*\*
-Note that AG Grid's full pagination functionality requires the Enterprise module.

package/docs/api/grid-pro.gridpro.persistcolumnstatekey.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-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md)
-## GridPro.persistColumnStateKey property
-The key to use for persisting the column state in local browser or KV storage.
-**Signature:**
-```typescript
-persistColumnStateKey: string;
-```

package/docs/api/grid-pro.gridpro.persistfiltermodelkey.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-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [persistFilterModelKey](./grid-pro.gridpro.persistfiltermodelkey.md)
-## GridPro.persistFilterModelKey property
-The key to use for persisting the filter model in local browser or KV storage.
-**Signature:**
-```typescript
-persistFilterModelKey: string;
-```

package/docs/api/grid-pro.gridpro.restorecachedfilterconfig.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [restoreCachedFilterConfig](./grid-pro.gridpro.restorecachedfilterconfig.md)
-## GridPro.restoreCachedFilterConfig() method
-**Signature:**
-```typescript
-restoreCachedFilterConfig(): Promise<void>;
-```
-**Returns:**
-Promise&lt;void&gt;

package/docs/api/grid-pro.gridpro.rowdata.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [rowData](./grid-pro.gridpro.rowdata.md)
-## GridPro.rowData property
-The row data to display in the grid.
-**Signature:**
-```typescript
-rowData: any[];
-```
-## Remarks
-For scenarios where you want to set data manually, without relying on `<grid-pro-client-side-datasource>`<!-- -->.

package/docs/api/grid-pro.gridpro.rowdatachanged.md DELETED Viewed

@@ -1,64 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [rowDataChanged](./grid-pro.gridpro.rowdatachanged.md)
-## GridPro.rowDataChanged() method
-**Signature:**
-```typescript
-rowDataChanged(_: any, rowData: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-\_
-</td><td>
-any
-</td><td>
-</td></tr>
-<tr><td>
-rowData
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/grid-pro.gridpro.rowheight.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [rowHeight](./grid-pro.gridpro.rowheight.md)
-## GridPro.rowHeight property
-**Signature:**
-```typescript
-rowHeight: number;
-```

package/docs/api/grid-pro.gridpro.setfiltermodel.md DELETED Viewed

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [setFilterModel](./grid-pro.gridpro.setfiltermodel.md)
-## GridPro.setFilterModel() method
-**Signature:**
-```typescript
-setFilterModel(value: {
-        [key: string]: any;
-    }): Promise<void>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-{ \[key: string\]: any; }
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;void&gt;

package/docs/api/grid-pro.gridpro.setuppaginationandstatusbar.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [setupPaginationAndStatusBar](./grid-pro.gridpro.setuppaginationandstatusbar.md)
-## GridPro.setupPaginationAndStatusBar() method
-**Signature:**
-```typescript
-protected setupPaginationAndStatusBar(gridOptions: GridOptions): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-gridOptions
-</td><td>
-GridOptions
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/grid-pro.gridpro.sizecolumnstocontent.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-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [sizeColumnsToContent](./grid-pro.gridpro.sizecolumnstocontent.md)
-## GridPro.sizeColumnsToContent property
-Boolean attribute to control whether the grid automatically sizes columns to fit their content. This will call AG Grid's autoSizeColumns() method to automatically adjust column widths based on content.
-**Signature:**
-```typescript
-sizeColumnsToContent: boolean;
-```

package/docs/api/grid-pro.gridpro.sizecolumnstofit.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-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [sizeColumnsToFit](./grid-pro.gridpro.sizecolumnstofit.md)
-## GridPro.sizeColumnsToFit property
-Boolean attribute to adjust the size of columns to fit the available horizontal space. This will call AG Grid's sizeColumnsToFit() method.
-**Signature:**
-```typescript
-sizeColumnsToFit: boolean;
-```

package/docs/api/grid-pro.gridpro.statepersistanceenabled.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [statePersistanceEnabled](./grid-pro.gridpro.statepersistanceenabled.md)
-## GridPro.statePersistanceEnabled() method
-**Signature:**
-```typescript
-statePersistanceEnabled(): boolean;
-```
-**Returns:**
-boolean

package/docs/api/grid-pro.gridpro.statepersistence.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [statePersistence](./grid-pro.gridpro.statepersistence.md)
-## GridPro.statePersistence property
-**Signature:**
-```typescript
-statePersistence: StatePersistence;
-```

package/docs/api/grid-pro.gridpro.statusbarconfig.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [statusBarConfig](./grid-pro.gridpro.statusbarconfig.md)
-## GridPro.statusBarConfig property
-Configuration for the grid status bar components.
-**Signature:**
-```typescript
-statusBarConfig: GridProStatusBarConfig;
-```
-## Remarks
-This requires AG Grid Enterprise module to be enabled. The status bar will only be displayed if the Enterprise module is available.

package/docs/api/grid-pro.gridpro.theme.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [theme](./grid-pro.gridpro.theme.md)
-## GridPro.theme property
-**Signature:**
-```typescript
-theme: string;
-```

package/docs/api/grid-pro.gridpro.themechanged.md DELETED Viewed

@@ -1,64 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [themeChanged](./grid-pro.gridpro.themechanged.md)
-## GridPro.themeChanged() method
-**Signature:**
-```typescript
-themeChanged(oldValue: string, newValue: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-oldValue
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-newValue
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/grid-pro.gridpro.thememode.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [themeMode](./grid-pro.gridpro.thememode.md)
-## GridPro.themeMode property
-**Signature:**
-```typescript
-themeMode: 'light' | 'dark';
-```

package/docs/api/grid-pro.gridpro.updatelabelvaluestatusbar.md DELETED Viewed

@@ -1,65 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [updateLabelValueStatusBar](./grid-pro.gridpro.updatelabelvaluestatusbar.md)
-## GridPro.updateLabelValueStatusBar() method
-Updates the label-value status bar component with new label and value
-**Signature:**
-```typescript
-updateLabelValueStatusBar(params: GridProStatusBarLabelConfig): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-params
-</td><td>
-[GridProStatusBarLabelConfig](./grid-pro.gridprostatusbarlabelconfig.md)
-</td><td>
-Object containing label, value, and optionally hide flag
-</td></tr>
-</tbody></table>
-**Returns:**
-void
-## Example
-```ts
-gridPro.updateLabelValueStatusBar({
-  label: 'Total Records',
-  value: '1,234',
-  hide: false
-});
-```

package/docs/api/grid-pro.gridpro.withstatusbar.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [withStatusBar](./grid-pro.gridpro.withstatusbar.md)
-## GridPro.withStatusBar property
-Enables or disables the grid status bar.
-**Signature:**
-```typescript
-withStatusBar: boolean;
-```
-## Remarks
-Default is false. When disabled, no status bar will be displayed regardless of statusBarConfig. This requires AG Grid Enterprise module to be available for the status bar to be displayed when enabled.

package/docs/api/grid-pro.gridprobasedatasource.applyalltransactions.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [applyAllTransactions](./grid-pro.gridprobasedatasource.applyalltransactions.md)
-## GridProBaseDatasource.applyAllTransactions() method
-**Signature:**
-```typescript
-protected applyAllTransactions(): void;
-```
-**Returns:**
-void