@genesislcap/foundation-workspace 14.406.0-workspaces.7

package/docs/api/foundation-workspace.md

@@ -0,0 +1,332 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md)
+
+## foundation-workspace package
+
+## Classes
+
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[DefaultFilterRegistry](./foundation-workspace.defaultfilterregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[DefaultGridRegistry](./foundation-workspace.defaultgridregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[DefaultLayoutRegistry](./foundation-workspace.defaultlayoutregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Default layout registry implementation.
+
+
+</td></tr>
+<tr><td>
+
+[DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Default workspace persistence implementation backed by KVStorage.
+
+
+</td></tr>
+<tr><td>
+
+[GridRegister](./foundation-workspace.gridregister.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Registers an AG Grid instance so workspace state can apply/load it.
+
+
+</td></tr>
+<tr><td>
+
+[LayoutWrapper](./foundation-workspace.layoutwrapper.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Registers a layout instance so workspace state can apply/load it.
+
+
+</td></tr>
+<tr><td>
+
+[WorkspaceManager](./foundation-workspace.workspacemanager.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Workspace persistence UI (save/load + share/delete shared workspaces).
+
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FilterRegistration](./foundation-workspace.filterregistration.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[FilterRegistry](./foundation-workspace.filterregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[GridRegistration](./foundation-workspace.gridregistration.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[GridRegistry](./foundation-workspace.gridregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[LayoutRegistry](./foundation-workspace.layoutregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[SavedFilterValue](./foundation-workspace.savedfiltervalue.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[SavedGridSettings](./foundation-workspace.savedgridsettings.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Workspace persistence types. Layout and column state use generic shapes so consumers can use foundation-layout and ag-grid types.
+
+
+</td></tr>
+<tr><td>
+
+[SavedLayout](./foundation-workspace.savedlayout.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[SavedWorkspace](./foundation-workspace.savedworkspace.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[SharedWorkspace](./foundation-workspace.sharedworkspace.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[WorkspaceState](./foundation-workspace.workspacestate.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+
+## Variables
+
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FilterRegistry](./foundation-workspace.filterregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_** DI token for filter registry.
+
+
+</td></tr>
+<tr><td>
+
+[GridRegistry](./foundation-workspace.gridregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_** DI token for grid registry.
+
+
+</td></tr>
+<tr><td>
+
+[LayoutRegistry](./foundation-workspace.layoutregistry.md)
+
+
+</td><td>
+
+**_(ALPHA)_** DI token for layout registry.
+
+
+</td></tr>
+<tr><td>
+
+[workspaceComponents](./foundation-workspace.workspacecomponents.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Registration object for workspace-related components.
+
+Mirrors the shape of `rapidGridComponents` so it can be passed into `provideDesignSystem().register(...)` without additional glue code.
+
+
+</td></tr>
+<tr><td>
+
+[WorkspaceState](./foundation-workspace.workspacestate.md)
+
+
+</td><td>
+
+**_(ALPHA)_** DI token for workspace state.
+
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[LoadMode](./foundation-workspace.loadmode.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Workspace load mode.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.savedfiltervalue.filterkey.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; [SavedFilterValue](./foundation-workspace.savedfiltervalue.md) &gt; [filterKey](./foundation-workspace.savedfiltervalue.filterkey.md)
+
+## SavedFilterValue.filterKey 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
+filterKey: string;
+```

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

@@ -0,0 +1,79 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [SavedFilterValue](./foundation-workspace.savedfiltervalue.md)
+
+## SavedFilterValue 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 SavedFilterValue 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[filterKey](./foundation-workspace.savedfiltervalue.filterkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[value](./foundation-workspace.savedfiltervalue.value.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

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

package/docs/api/foundation-workspace.savedgridsettings.columnstate.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; [SavedGridSettings](./foundation-workspace.savedgridsettings.md) &gt; [columnState](./foundation-workspace.savedgridsettings.columnstate.md)
+
+## SavedGridSettings.columnState 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
+columnState: any[];
+```

package/docs/api/foundation-workspace.savedgridsettings.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; [SavedGridSettings](./foundation-workspace.savedgridsettings.md) &gt; [gridKey](./foundation-workspace.savedgridsettings.gridkey.md)
+
+## SavedGridSettings.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.savedgridsettings.md

@@ -0,0 +1,99 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [SavedGridSettings](./foundation-workspace.savedgridsettings.md)
+
+## SavedGridSettings 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.
+> 
+
+Workspace persistence types. Layout and column state use generic shapes so consumers can use foundation-layout and ag-grid types.
+
+**Signature:**
+
+```typescript
+export interface SavedGridSettings 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[columnState](./foundation-workspace.savedgridsettings.columnstate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any\[\]
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridKey](./foundation-workspace.savedgridsettings.gridkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[savedAt](./foundation-workspace.savedgridsettings.savedat.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.savedgridsettings.savedat.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; [SavedGridSettings](./foundation-workspace.savedgridsettings.md) &gt; [savedAt](./foundation-workspace.savedgridsettings.savedat.md)
+
+## SavedGridSettings.savedAt 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
+savedAt: string;
+```

package/docs/api/foundation-workspace.savedlayout.layout.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; [SavedLayout](./foundation-workspace.savedlayout.md) &gt; [layout](./foundation-workspace.savedlayout.layout.md)
+
+## SavedLayout.layout 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
+layout: unknown;
+```

package/docs/api/foundation-workspace.savedlayout.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; [SavedLayout](./foundation-workspace.savedlayout.md) &gt; [layoutKey](./foundation-workspace.savedlayout.layoutkey.md)
+
+## SavedLayout.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.savedlayout.md

@@ -0,0 +1,79 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [SavedLayout](./foundation-workspace.savedlayout.md)
+
+## SavedLayout 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 SavedLayout 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[layout](./foundation-workspace.savedlayout.layout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+unknown
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[layoutKey](./foundation-workspace.savedlayout.layoutkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.savedworkspace.description.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; [SavedWorkspace](./foundation-workspace.savedworkspace.md) &gt; [description](./foundation-workspace.savedworkspace.description.md)
+
+## SavedWorkspace.description 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
+description?: string;
+```