@genesislcap/foundation-workspace 14.406.0-workspaces.7 → 14.411.0

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

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

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

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

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

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

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

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

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

@@ -1,72 +0,0 @@
-<!-- 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; [applyGridSettings](./foundation-workspace.gridregistry.applygridsettings.md)
-
-## GridRegistry.applyGridSettings() 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
-applyGridSettings(gridSetting: SavedGridSettings, options?: {
-        applyColumns?: boolean;
-        applyFilters?: boolean;
-    }): Promise<boolean>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-gridSetting
-
-
-</td><td>
-
-[SavedGridSettings](./foundation-workspace.savedgridsettings.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-options
-
-
-</td><td>
-
-{ applyColumns?: boolean; applyFilters?: boolean; }
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [getAllGridsSettings](./foundation-workspace.gridregistry.getallgridssettings.md)
-
-## GridRegistry.getAllGridsSettings() 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
-getAllGridsSettings(): SavedGridSettings[];
-```
-**Returns:**
-
-[SavedGridSettings](./foundation-workspace.savedgridsettings.md)<!-- -->\[\]
-

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

@@ -1,53 +0,0 @@
-<!-- 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; [getGrid](./foundation-workspace.gridregistry.getgrid.md)
-
-## GridRegistry.getGrid() 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
-getGrid(gridKey: string): unknown;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-gridKey
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-unknown
-

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

@@ -1,16 +0,0 @@
-<!-- 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)
-
-## GridRegistry 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 grid registry.
-
-**Signature:**
-
-```typescript
-GridRegistry: import("@microsoft/fast-foundation").InterfaceSymbol<GridRegistry>
-```

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

@@ -1,81 +0,0 @@
-<!-- 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; [registerGrid](./foundation-workspace.gridregistry.registergrid.md)
-
-## GridRegistry.registerGrid() 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
-registerGrid(gridKey: string, gridApi: unknown, columnApi: unknown): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-gridKey
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-gridApi
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-columnApi
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,53 +0,0 @@
-<!-- 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; [unregisterGrid](./foundation-workspace.gridregistry.unregistergrid.md)
-
-## GridRegistry.unregisterGrid() 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
-unregisterGrid(gridKey: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-gridKey
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-workspace.layoutregistry.applysavedlayouts.md

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

package/docs/api/foundation-workspace.layoutregistry.getlayoutsconfigs.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [LayoutRegistry](./foundation-workspace.layoutregistry.md) &gt; [getLayoutsConfigs](./foundation-workspace.layoutregistry.getlayoutsconfigs.md)
-
-## LayoutRegistry.getLayoutsConfigs() 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
-getLayoutsConfigs(): SavedLayout[];
-```
-**Returns:**
-
-[SavedLayout](./foundation-workspace.savedlayout.md)<!-- -->\[\]
-

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

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