@genesislcap/foundation-workspace 14.406.0-workspaces.8 → 14.412.0

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

@@ -1,67 +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; [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

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

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

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

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

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

package/docs/api/foundation-workspace.md

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

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

@@ -1,79 +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; [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

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

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