@genesislcap/foundation-workspace 14.406.0-workspaces.7

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

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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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>
+```

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

@@ -0,0 +1,67 @@
+<!-- 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; [registerLayout](./foundation-workspace.layoutregistry.registerlayout.md)
+
+## LayoutRegistry.registerLayout() 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
+registerLayout(layoutKey: string, layout: unknown): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+layoutKey
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+layout
+
+
+</td><td>
+
+unknown
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-workspace.layoutregistry.unregisterlayout.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; [LayoutRegistry](./foundation-workspace.layoutregistry.md) &gt; [unregisterLayout](./foundation-workspace.layoutregistry.unregisterlayout.md)
+
+## LayoutRegistry.unregisterLayout() 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
+unregisterLayout(layoutKey: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+layoutKey
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-workspace.layoutwrapper.layoutkey.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; [LayoutWrapper](./foundation-workspace.layoutwrapper.md) &gt; [layoutKey](./foundation-workspace.layoutwrapper.layoutkey.md)
+
+## LayoutWrapper.layoutKey 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
+layoutKey: string;
+```

package/docs/api/foundation-workspace.layoutwrapper.layoutregistry.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; [LayoutWrapper](./foundation-workspace.layoutwrapper.md) &gt; [layoutRegistry](./foundation-workspace.layoutwrapper.layoutregistry.md)
+
+## LayoutWrapper.layoutRegistry 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
+layoutRegistry: LayoutRegistry;
+```

package/docs/api/foundation-workspace.layoutwrapper.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; [LayoutWrapper](./foundation-workspace.layoutwrapper.md)
+
+## LayoutWrapper 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 a layout instance so workspace state can apply/load it.
+
+**Signature:**
+
+```typescript
+export declare class LayoutWrapper 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>
+
+[layoutKey](./foundation-workspace.layoutwrapper.layoutkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[layoutRegistry](./foundation-workspace.layoutwrapper.layoutregistry.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[LayoutRegistry](./foundation-workspace.layoutregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.loadmode.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; [LoadMode](./foundation-workspace.loadmode.md)
+
+## LoadMode 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.
+> 
+
+Workspace load mode.
+
+**Signature:**
+
+```typescript
+export type LoadMode = 'MY' | 'SHARED';
+```