@genesislcap/foundation-workspace 14.406.0-workspaces.7

package/docs/api/foundation-workspace.filterregistration.md

@@ -0,0 +1,98 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md)
+
+## FilterRegistration 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.
+> 
+
+
+**Signature:**
+
+```typescript
+export interface FilterRegistration 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[filterKey](./foundation-workspace.filterregistration.filterkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[getFilterValue](./foundation-workspace.filterregistration.getfiltervalue.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; [SavedFilterValue](./foundation-workspace.savedfiltervalue.md) \| null
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[setFilterValue](./foundation-workspace.filterregistration.setfiltervalue.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(value: string) =&gt; void
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.filterregistration.setfiltervalue.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md) &gt; [setFilterValue](./foundation-workspace.filterregistration.setfiltervalue.md)
+
+## FilterRegistration.setFilterValue 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
+setFilterValue: (value: string) => void;
+```

package/docs/api/foundation-workspace.filterregistry.applyfiltersvalues.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [applyFiltersValues](./foundation-workspace.filterregistry.applyfiltersvalues.md)
+
+## FilterRegistry.applyFiltersValues() method
+
+> 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
+applyFiltersValues(savedFilters: SavedFilterValue[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+savedFilters
+
+
+</td><td>
+
+[SavedFilterValue](./foundation-workspace.savedfiltervalue.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-workspace.filterregistry.getallfiltersvalues.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [getAllFiltersValues](./foundation-workspace.filterregistry.getallfiltersvalues.md)
+
+## FilterRegistry.getAllFiltersValues() method
+
+> 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
+getAllFiltersValues(): SavedFilterValue[];
+```
+**Returns:**
+
+[SavedFilterValue](./foundation-workspace.savedfiltervalue.md)<!-- -->\[\]
+

package/docs/api/foundation-workspace.filterregistry.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md)
+
+## FilterRegistry variable
+
+> 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.
+> 
+
+DI token for filter registry.
+
+**Signature:**
+
+```typescript
+FilterRegistry: import("@microsoft/fast-foundation").InterfaceSymbol<FilterRegistry>
+```

package/docs/api/foundation-workspace.filterregistry.registerfilter.md

@@ -0,0 +1,81 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [registerFilter](./foundation-workspace.filterregistry.registerfilter.md)
+
+## FilterRegistry.registerFilter() method
+
+> 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
+registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filterKey
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+getFilterValue
+
+
+</td><td>
+
+() =&gt; [SavedFilterValue](./foundation-workspace.savedfiltervalue.md) \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+setFilterValue
+
+
+</td><td>
+
+(value: string) =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-workspace.filterregistry.unregisterfilter.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [unregisterFilter](./foundation-workspace.filterregistry.unregisterfilter.md)
+
+## FilterRegistry.unregisterFilter() method
+
+> 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
+unregisterFilter(filterKey: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filterKey
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-workspace.gridregister.gridkey.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegister](./foundation-workspace.gridregister.md) &gt; [gridKey](./foundation-workspace.gridregister.gridkey.md)
+
+## GridRegister.gridKey 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
+gridKey: string;
+```

package/docs/api/foundation-workspace.gridregister.gridregistry.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegister](./foundation-workspace.gridregister.md) &gt; [gridRegistry](./foundation-workspace.gridregister.gridregistry.md)
+
+## GridRegister.gridRegistry 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
+gridRegistry: GridRegistry;
+```

package/docs/api/foundation-workspace.gridregister.md

@@ -0,0 +1,100 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegister](./foundation-workspace.gridregister.md)
+
+## GridRegister 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.
+> 
+
+Registers an AG Grid instance so workspace state can apply/load it.
+
+**Signature:**
+
+```typescript
+export declare class GridRegister extends HTMLElement 
+```
+**Extends:** HTMLElement
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[gridKey](./foundation-workspace.gridregister.gridkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridRegistry](./foundation-workspace.gridregister.gridregistry.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GridRegistry](./foundation-workspace.gridregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[workspaceState](./foundation-workspace.gridregister.workspacestate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorkspaceState](./foundation-workspace.workspacestate.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.gridregister.workspacestate.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegister](./foundation-workspace.gridregister.md) &gt; [workspaceState](./foundation-workspace.gridregister.workspacestate.md)
+
+## GridRegister.workspaceState 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
+workspaceState: WorkspaceState;
+```

package/docs/api/foundation-workspace.gridregistration.columnapi.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegistration](./foundation-workspace.gridregistration.md) &gt; [columnApi](./foundation-workspace.gridregistration.columnapi.md)
+
+## GridRegistration.columnApi 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
+columnApi: ColumnApi;
+```

package/docs/api/foundation-workspace.gridregistration.gridapi.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegistration](./foundation-workspace.gridregistration.md) &gt; [gridApi](./foundation-workspace.gridregistration.gridapi.md)
+
+## GridRegistration.gridApi 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
+gridApi: GridApi;
+```

package/docs/api/foundation-workspace.gridregistration.gridkey.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegistration](./foundation-workspace.gridregistration.md) &gt; [gridKey](./foundation-workspace.gridregistration.gridkey.md)
+
+## GridRegistration.gridKey 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
+gridKey: string;
+```

package/docs/api/foundation-workspace.gridregistration.md

@@ -0,0 +1,98 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegistration](./foundation-workspace.gridregistration.md)
+
+## GridRegistration 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.
+> 
+
+
+**Signature:**
+
+```typescript
+export interface GridRegistration 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[columnApi](./foundation-workspace.gridregistration.columnapi.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ColumnApi
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridApi](./foundation-workspace.gridregistration.gridapi.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridApi
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridKey](./foundation-workspace.gridregistration.gridkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.gridregistry.applyallgridssettings.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegistry](./foundation-workspace.gridregistry.md) &gt; [applyAllGridsSettings](./foundation-workspace.gridregistry.applyallgridssettings.md)
+
+## GridRegistry.applyAllGridsSettings() method
+
+> 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
+applyAllGridsSettings(gridsSettings: SavedGridSettings[]): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+gridsSettings
+
+
+</td><td>
+
+[SavedGridSettings](./foundation-workspace.savedgridsettings.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;
+