@genesislcap/foundation-workspace 14.406.0-workspaces.7

package/docs/api/foundation-workspace.workspacestate.deleteworkspace.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; [WorkspaceState](./foundation-workspace.workspacestate.md) &gt; [deleteWorkspace](./foundation-workspace.workspacestate.deleteworkspace.md)
+
+## WorkspaceState.deleteWorkspace() 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
+deleteWorkspace(workspaceName: string): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+workspaceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-workspace.workspacestate.getcurrentworkspace.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; [WorkspaceState](./foundation-workspace.workspacestate.md) &gt; [getCurrentWorkspace](./foundation-workspace.workspacestate.getcurrentworkspace.md)
+
+## WorkspaceState.getCurrentWorkspace() 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
+getCurrentWorkspace(): SavedWorkspace | null;
+```
+**Returns:**
+
+[SavedWorkspace](./foundation-workspace.savedworkspace.md) \| null
+

package/docs/api/foundation-workspace.workspacestate.getsavedworkspaces.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; [WorkspaceState](./foundation-workspace.workspacestate.md) &gt; [getSavedWorkspaces](./foundation-workspace.workspacestate.getsavedworkspaces.md)
+
+## WorkspaceState.getSavedWorkspaces() 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
+getSavedWorkspaces(): Promise<SavedWorkspace[]>;
+```
+**Returns:**
+
+Promise&lt;[SavedWorkspace](./foundation-workspace.savedworkspace.md)<!-- -->\[\]&gt;
+

package/docs/api/foundation-workspace.workspacestate.loadworkspace.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; [WorkspaceState](./foundation-workspace.workspacestate.md) &gt; [loadWorkspace](./foundation-workspace.workspacestate.loadworkspace.md)
+
+## WorkspaceState.loadWorkspace() 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
+loadWorkspace(workspaceName: string): Promise<SavedWorkspace | null>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+workspaceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[SavedWorkspace](./foundation-workspace.savedworkspace.md) \| null&gt;
+

package/docs/api/foundation-workspace.workspacestate.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; [WorkspaceState](./foundation-workspace.workspacestate.md)
+
+## WorkspaceState 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 workspace state.
+
+**Signature:**
+
+```typescript
+WorkspaceState: import("@microsoft/fast-foundation").InterfaceSymbol<WorkspaceState>
+```

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

@@ -0,0 +1,111 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [WorkspaceState](./foundation-workspace.workspacestate.md) &gt; [saveWorkspace](./foundation-workspace.workspacestate.saveworkspace.md)
+
+## WorkspaceState.saveWorkspace() 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
+saveWorkspace(workspaceName: string, layouts: SavedLayout[], grids: SavedGridSettings[], filters: SavedFilterValue[], description?: string): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+workspaceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+layouts
+
+
+</td><td>
+
+[SavedLayout](./foundation-workspace.savedlayout.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+grids
+
+
+</td><td>
+
+[SavedGridSettings](./foundation-workspace.savedgridsettings.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+filters
+
+
+</td><td>
+
+[SavedFilterValue](./foundation-workspace.savedfiltervalue.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+description
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-workspace.workspacestate.setcurrentworkspace.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; [WorkspaceState](./foundation-workspace.workspacestate.md) &gt; [setCurrentWorkspace](./foundation-workspace.workspacestate.setcurrentworkspace.md)
+
+## WorkspaceState.setCurrentWorkspace() 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
+setCurrentWorkspace(workspace: SavedWorkspace | null): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+workspace
+
+
+</td><td>
+
+[SavedWorkspace](./foundation-workspace.savedworkspace.md) \| null
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/index.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[@genesislcap/foundation-workspace](./foundation-workspace.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+