@genesislcap/grid-pro 14.157.1-alpha-e60ad86.0 → 14.158.1-forms-deepclone.2

package/dist/grid-pro.d.ts

@@ -15,6 +15,7 @@ import { Datasource } from '@genesislcap/foundation-comms';
 import { DatasourceOptions } from '@genesislcap/foundation-comms';
 import { DOMContainer } from '@genesislcap/foundation-utils';
 import { ElementStyles } from '@microsoft/fast-element';
+import { FieldMetadata } from '@genesislcap/foundation-comms';
 import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { FoundationElementRegistry } from '@microsoft/fast-foundation';
@@ -1069,15 +1070,6 @@ export declare const getDateEditorTemplate: (prefix?: string) => ViewTemplate<Da
  */
 export declare function getFilterByFieldType(type: string): string;
 
-/**
- * Returns the filter params based on the Grid Pro field/column type.
- * @param type - The type of the field/column
- * @returns the filter params for the specified field type
- * @remarks Currently only returns a default filter params object, for all field types
- * @alpha
- */
-export declare function getFilterParamsByFieldType(type: string): any;
-
 /**
  * Get a Design System prefixed Select template.
  * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
@@ -1215,9 +1207,13 @@ export declare class GridPro extends GridPro_base {
      */
     enableRowFlashing: boolean;
     /**
-     * The key to use for persisting the column state in local storage.
+     * The key to use for persisting the column state in local broswer or KV storage.
      */
     persistColumnStateKey: string;
+    /**
+     * The key to use for persisting the filter model in local browser or KV storage.
+     */
+    persistFilterModelKey: string;
     /**
      * The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.
      * @remarks Can be one of the following: camelCase, capitalCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase.
@@ -1244,7 +1240,13 @@ export declare class GridPro extends GridPro_base {
     protected initialised: boolean;
     private rehydrationAttempted;
     private gridEventsQueue;
-    private filterConfig;
+    private _filterConfig;
+    getfilterModel(): Promise<{
+        [key: string]: any;
+    }>;
+    setFilterModel(value: {
+        [key: string]: any;
+    }): Promise<void>;
     /**
      * Injectable config that allows to change grid options on an app level basis
      * To modify options, register instance of the config in DOM container that is
@@ -1288,7 +1290,7 @@ export declare class GridPro extends GridPro_base {
     getSavedColumnState(): Promise<ColumnState[]>;
     private restoreColumnState;
     private cacheFilterConfig;
-    private restoreCachedFilterConfig;
+    restoreCachedFilterConfig(): Promise<void>;
     /**
      * @public
      */
@@ -1364,20 +1366,6 @@ declare const GridPro_base: (new (...args: any[]) => {
     removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
     removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     readonly attributes: NamedNodeMap;
-    /**
-     * Injectable config that allows to change grid options on an app level basis
-     * To modify options, register instance of the config in DOM container that is
-     * above the grid or on the top level of the application, so it applies to all grids.
-     *
-     * @example
-     * ```
-     * DI.getOrCreateDOMContainer().register([
-     *       Registration.instance<GridOptionsConfig>(GridOptionsConfig, {
-     *         headerHeight: 50,
-     *       }),
-     *     ]);
-     * ```
-     */
     readonly classList: DOMTokenList;
     className: string;
     readonly clientHeight: number;
@@ -1396,7 +1384,20 @@ declare const GridPro_base: (new (...args: any[]) => {
     readonly scrollHeight: number;
     scrollLeft: number;
     scrollTop: number;
-    readonly scrollWidth: number;
+    readonly scrollWidth: number; /**
+    * Injectable config that allows to change grid options on an app level basis
+    * To modify options, register instance of the config in DOM container that is
+    * above the grid or on the top level of the application, so it applies to all grids.
+    *
+    * @example
+    * ```
+    * DI.getOrCreateDOMContainer().register([
+    *       Registration.instance<GridOptionsConfig>(GridOptionsConfig, {
+    *         headerHeight: 50,
+    *       }),
+    *     ]);
+    * ```
+    */
     readonly shadowRoot: ShadowRoot;
     slot: string;
     readonly tagName: string;
@@ -1668,6 +1669,7 @@ declare class GridProBaseDatasource extends GenesisGridDatasourceElement {
     protected agTransaction: RowDataTransaction | ServerSideTransaction;
     protected applyFuncName: string;
     protected applyAsyncFuncName: string;
+    protected generateColumnDefsFromMetadata(fieldsMetadata: FieldMetadata[], getFilterParamsByFieldType: Function): ColDef[];
     protected handleStreamInserts(insertedRows: any[]): void;
     protected handleStreamDeletes(deletedRows: any[]): void;
     protected handleStreamUpdates(updatedRows: any[]): void;
@@ -1892,15 +1894,15 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     readonly classList: DOMTokenList;
     className: string;
     readonly clientHeight: number;
-    readonly clientLeft: number;
+    readonly clientLeft: number; /**
+    * Restarts the datasource, uses `deinit` and `init` in sequence.
+    * @public
+    */
     readonly clientTop: number;
     readonly clientWidth: number;
     id: string;
     readonly localName: string;
-    readonly namespaceURI: string; /**
-    * Restarts the datasource, uses `deinit` and `init` in sequence.
-    * @public
-    */
+    readonly namespaceURI: string;
     onfullscreenchange: (this: Element, ev: Event) => any;
     onfullscreenerror: (this: Element, ev: Event) => any;
     outerHTML: string;
@@ -1914,7 +1916,12 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     readonly shadowRoot: ShadowRoot;
     slot: string;
     readonly tagName: string;
-    attachShadow(init: ShadowRootInit): ShadowRoot;
+    attachShadow(init: ShadowRootInit): ShadowRoot; /**
+    * Clears the rowData and columnDefs for the grid.
+    * @remarks This is called when `reloadResourceData` happens, on criteria and filters change or full `reset`.
+    * @param withColumnDefs - Whether to clear the columnDefs as well. Defaults to true.
+    * @internal
+    */
     closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
     closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
     closest<E extends Element = Element>(selectors: string): E;
@@ -1940,6 +1947,12 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     insertAdjacentHTML(position: InsertPosition, text: string): void;
     insertAdjacentText(where: InsertPosition, data: string): void;
     matches(selectors: string): boolean;
+    /**
+     * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
+     * Proxies to {@link @genesislcap/grid-pro#GridProGenesisDatasource.loadResourceData} but without the full init (no metadata fetch).
+     * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
+     * @internal
+     */
     releasePointerCapture(pointerId: number): void;
     removeAttribute(qualifiedName: string): void;
     removeAttributeNS(namespace: string, localName: string): void;
@@ -1953,7 +1966,13 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
     scrollTo(options?: ScrollToOptions): void;
     scrollTo(x: number, y: number): void;
-    setAttribute(qualifiedName: string, value: string): void;
+    setAttribute(qualifiedName: string, value: string): void; /**
+    * Initializes the datasource and loads the data for the grid.
+    * Handles both snapshot and stream data (for both REQUEST_SERVER and DATASERVER resource types).
+    *
+    * @param withFullInit - if true, will call datasource.init() with requiresMetadataFetch = true, fetching fresh metadata
+    * @internal
+    */
     setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
     setAttributeNode(attr: Attr): Attr;
     setAttributeNodeNS(attr: Attr): Attr;
@@ -2415,6 +2434,11 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
     ariaReadOnly: string;
     ariaRequired: string;
     ariaRoleDescription: string;
+    /**
+     * A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
+     * @remarks Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
+     * @alpha
+     */
     ariaRowCount: string;
     ariaRowIndex: string;
     ariaRowIndexText: string;
@@ -2440,11 +2464,7 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
     readonly children: HTMLCollection;
     readonly firstElementChild: Element;
     readonly lastElementChild: Element;
-    append(...nodes: (string | Node)[]): void; /**
-    * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
-    * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
-    * @internal
-    */
+    append(...nodes: (string | Node)[]): void;
     prepend(...nodes: (string | Node)[]): void;
     querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
     querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
@@ -2577,6 +2597,12 @@ export declare class KVStorageStatePersistence implements StatePersistence {
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
     private migrateLocalStorageToKVStorage;
+    getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+    saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
 }
 
 /**
@@ -2587,6 +2613,12 @@ export declare class LocalStorageStatePersistence implements StatePersistence {
     session: Session;
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+    saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
 }
 
 /**
@@ -2742,6 +2774,20 @@ export declare interface StatePersistence {
      * @public
      */
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    /**
+     * Returns the filter model for the given key.
+     * @public
+     */
+    getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Saves the filter model for the given key.
+     * @public
+     */
+    saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
 }
 
 /**

package/docs/api/grid-pro.gridpro.getfiltermodel.md

@@ -0,0 +1,17 @@
+<!-- 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; [getfilterModel](./grid-pro.gridpro.getfiltermodel.md)
+
+## GridPro.getfilterModel() method
+
+**Signature:**
+
+```typescript
+getfilterModel(): Promise<{
+        [key: string]: any;
+    }>;
+```
+**Returns:**
+
+Promise&lt;{ \[key: string\]: any; }&gt;
+

package/docs/api/grid-pro.gridpro.md

@@ -56,7 +56,8 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
 |  [initialised](./grid-pro.gridpro.initialised.md) | <code>protected</code> | boolean |  |
 |  [observedAttributes](./grid-pro.gridpro.observedattributes.md) | <code>readonly</code> | string\[\] |  |
 |  [onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md) |  | boolean |  |
-|  [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) |  | string | The key to use for persisting the column state in local storage. |
+|  [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) |  | string | The key to use for persisting the column state in local broswer or KV storage. |
+|  [persistFilterModelKey](./grid-pro.gridpro.persistfiltermodelkey.md) |  | string | The key to use for persisting the filter model in local browser or KV storage. |
 |  [rowHeight](./grid-pro.gridpro.rowheight.md) |  | number |  |
 |  [statePersistence](./grid-pro.gridpro.statepersistence.md) |  | [StatePersistence](./grid-pro.statepersistence.md) |  |
 |  [theme](./grid-pro.gridpro.theme.md) |  | string |  |
@@ -71,9 +72,12 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
 |  [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) |  |  |
 |  [connectedCallback()](./grid-pro.gridpro.connectedcallback.md) |  |  |
 |  [disconnectedCallback()](./grid-pro.gridpro.disconnectedcallback.md) |  |  |
+|  [getfilterModel()](./grid-pro.gridpro.getfiltermodel.md) |  |  |
 |  [getSavedColumnState()](./grid-pro.gridpro.getsavedcolumnstate.md) |  | Gets the saved grid ColumnState\[\] from storage |
 |  [globalEventListener(eventType, event)](./grid-pro.gridpro.globaleventlistener.md) |  |  |
 |  [mergeAllColumnDefsAndStates(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.mergeallcolumndefsandstates.md) |  | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
+|  [restoreCachedFilterConfig()](./grid-pro.gridpro.restorecachedfilterconfig.md) |  |  |
+|  [setFilterModel(value)](./grid-pro.gridpro.setfiltermodel.md) |  |  |
 |  [statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md) |  |  |
 |  [themeChanged(oldValue, newValue)](./grid-pro.gridpro.themechanged.md) |  |  |
 

package/docs/api/grid-pro.gridpro.persistcolumnstatekey.md

@@ -4,7 +4,7 @@
 
 ## GridPro.persistColumnStateKey property
 
-The key to use for persisting the column state in local storage.
+The key to use for persisting the column state in local broswer or KV storage.
 
 **Signature:**
 

package/docs/api/grid-pro.gridpro.persistfiltermodelkey.md

@@ -0,0 +1,13 @@
+<!-- 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

@@ -0,0 +1,15 @@
+<!-- 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.setfiltermodel.md

@@ -0,0 +1,24 @@
+<!-- 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
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | { \[key: string\]: any; } |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/grid-pro.kvstoragestatepersistence.getfiltermodel.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) &gt; [getFilterModel](./grid-pro.kvstoragestatepersistence.getfiltermodel.md)
+
+## KVStorageStatePersistence.getFilterModel() method
+
+**Signature:**
+
+```typescript
+getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistFilterModelKey | string |  |
+
+**Returns:**
+
+Promise&lt;{ \[key: string\]: any; }&gt;
+

package/docs/api/grid-pro.kvstoragestatepersistence.md

@@ -25,5 +25,7 @@ export declare class KVStorageStatePersistence implements StatePersistence
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getColumnState(persistColumnStateKey)](./grid-pro.kvstoragestatepersistence.getcolumnstate.md) |  |  |
+|  [getFilterModel(persistFilterModelKey)](./grid-pro.kvstoragestatepersistence.getfiltermodel.md) |  |  |
 |  [saveColumnState(persistColumnStateKey, columnState)](./grid-pro.kvstoragestatepersistence.savecolumnstate.md) |  |  |
+|  [saveFilterModel(persistFilterModelKey, filterModel)](./grid-pro.kvstoragestatepersistence.savefiltermodel.md) |  |  |
 

package/docs/api/grid-pro.kvstoragestatepersistence.savefiltermodel.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) &gt; [saveFilterModel](./grid-pro.kvstoragestatepersistence.savefiltermodel.md)
+
+## KVStorageStatePersistence.saveFilterModel() method
+
+**Signature:**
+
+```typescript
+saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistFilterModelKey | string |  |
+|  filterModel | { \[key: string\]: any; } |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/grid-pro.localstoragestatepersistence.getfiltermodel.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) &gt; [getFilterModel](./grid-pro.localstoragestatepersistence.getfiltermodel.md)
+
+## LocalStorageStatePersistence.getFilterModel() method
+
+**Signature:**
+
+```typescript
+getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistFilterModelKey | string |  |
+
+**Returns:**
+
+Promise&lt;{ \[key: string\]: any; }&gt;
+

package/docs/api/grid-pro.localstoragestatepersistence.md

@@ -24,5 +24,7 @@ export declare class LocalStorageStatePersistence implements StatePersistence
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getColumnState(persistColumnStateKey)](./grid-pro.localstoragestatepersistence.getcolumnstate.md) |  |  |
+|  [getFilterModel(persistFilterModelKey)](./grid-pro.localstoragestatepersistence.getfiltermodel.md) |  |  |
 |  [saveColumnState(persistColumnStateKey, columnState)](./grid-pro.localstoragestatepersistence.savecolumnstate.md) |  |  |
+|  [saveFilterModel(persistFilterModelKey, filterModel)](./grid-pro.localstoragestatepersistence.savefiltermodel.md) |  |  |
 

package/docs/api/grid-pro.localstoragestatepersistence.savefiltermodel.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) &gt; [saveFilterModel](./grid-pro.localstoragestatepersistence.savefiltermodel.md)
+
+## LocalStorageStatePersistence.saveFilterModel() method
+
+**Signature:**
+
+```typescript
+saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistFilterModelKey | string |  |
+|  filterModel | { \[key: string\]: any; } |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/grid-pro.statepersistence.getfiltermodel.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatePersistence](./grid-pro.statepersistence.md) &gt; [getFilterModel](./grid-pro.statepersistence.getfiltermodel.md)
+
+## StatePersistence.getFilterModel() method
+
+Returns the filter model for the given key.
+
+**Signature:**
+
+```typescript
+getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistFilterModelKey | string |  |
+
+**Returns:**
+
+Promise&lt;{ \[key: string\]: any; }&gt;
+

package/docs/api/grid-pro.statepersistence.md

@@ -17,5 +17,7 @@ export interface StatePersistence
 |  Method | Description |
 |  --- | --- |
 |  [getColumnState(persistColumnStateKey)](./grid-pro.statepersistence.getcolumnstate.md) | Returns the column state for the given key. |
+|  [getFilterModel(persistFilterModelKey)](./grid-pro.statepersistence.getfiltermodel.md) | Returns the filter model for the given key. |
 |  [saveColumnState(persistColumnStateKey, columnState)](./grid-pro.statepersistence.savecolumnstate.md) | Saves the column state for the given key. |
+|  [saveFilterModel(persistFilterModelKey, filterModel)](./grid-pro.statepersistence.savefiltermodel.md) | Saves the filter model for the given key. |
 

package/docs/api/grid-pro.statepersistence.savefiltermodel.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatePersistence](./grid-pro.statepersistence.md) &gt; [saveFilterModel](./grid-pro.statepersistence.savefiltermodel.md)
+
+## StatePersistence.saveFilterModel() method
+
+Saves the filter model for the given key.
+
+**Signature:**
+
+```typescript
+saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistFilterModelKey | string |  |
+|  filterModel | { \[key: string\]: any; } |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api-report.md

@@ -21,6 +21,7 @@ import { Datasource } from '@genesislcap/foundation-comms';
 import { DatasourceOptions } from '@genesislcap/foundation-comms';
 import { DOMContainer } from '@genesislcap/foundation-utils';
 import { ElementStyles } from '@microsoft/fast-element';
+import { FieldMetadata } from '@genesislcap/foundation-comms';
 import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { FoundationElementRegistry } from '@microsoft/fast-foundation';
@@ -740,9 +741,6 @@ export const getDateEditorTemplate: (prefix?: string) => ViewTemplate<DateEditor
 // @alpha
 export function getFilterByFieldType(type: string): string;
 
-// @alpha
-export function getFilterParamsByFieldType(type: string): any;
-
 // @public
 export const getMultiselectEditorTemplate: (designSystem?: string) => ViewTemplate<MultiselectEditor, any>;
 
@@ -824,6 +822,10 @@ export class GridPro extends GridPro_base {
     enableRowFlashing: boolean;
     // (undocumented)
     eventsAndCallbacks: any;
+    // (undocumented)
+    getfilterModel(): Promise<{
+        [key: string]: any;
+    }>;
     getSavedColumnState(): Promise<ColumnState[]>;
     // (undocumented)
     globalEventListener(eventType: any, event: any): void;
@@ -857,9 +859,16 @@ export class GridPro extends GridPro_base {
     // (undocumented)
     onlyTemplateColDefs: boolean;
     persistColumnStateKey: string;
+    persistFilterModelKey: string;
+    // (undocumented)
+    restoreCachedFilterConfig(): Promise<void>;
     // (undocumented)
     rowHeight: number;
     // (undocumented)
+    setFilterModel(value: {
+        [key: string]: any;
+    }): Promise<void>;
+    // (undocumented)
     statePersistanceEnabled(): boolean;
     // (undocumented)
     statePersistence: StatePersistence;
@@ -1050,10 +1059,18 @@ export class KVStorageStatePersistence implements StatePersistence {
     // (undocumented)
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
     // (undocumented)
+    getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+    // (undocumented)
     kvStorage: KVStorage;
     // (undocumented)
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
     // (undocumented)
+    saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
+    // (undocumented)
     session: Session;
 }
 
@@ -1062,8 +1079,16 @@ export class LocalStorageStatePersistence implements StatePersistence {
     // (undocumented)
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
     // (undocumented)
+    getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
+    // (undocumented)
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
     // (undocumented)
+    saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
+    // (undocumented)
     session: Session;
 }
 
@@ -1224,7 +1249,13 @@ export class SelectRenderer extends FoundationElement implements ICellRendererCo
 // @public
 export interface StatePersistence {
     getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    getFilterModel(persistFilterModelKey: string): Promise<{
+        [key: string]: any;
+    }>;
     saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    saveFilterModel(persistFilterModelKey: string, filterModel: {
+        [key: string]: any;
+    }): Promise<void>;
 }
 
 // @internal