Namespace: types
Type Aliases
ActiveWorkspace
Ƭ ActiveWorkspace: Workspace
The data representation of the active workspace. KW: Currently identical to the Workspace type after removal of the guid property
GroupData
Ƭ GroupData: Object
Type declaration
| Name | Type |
|---|---|
isARectangle | boolean |
isAlwaysOnTop | boolean |
isMovable | boolean |
topRightWindow | string |
ungroupedAlwaysOnTopState | Record<string, Boolean> |
windowNames | string[] |
Workspace
Ƭ Workspace: WorkspaceBase & { windows: string[] }
The complete data representation of a Workspace.
WorkspaceBase
Ƭ WorkspaceBase: Object
This interface represents base data that all workspace-type objects have in common and extend.
Type declaration
| Name | Type | Description |
|---|---|---|
groups | Record<string, GroupData> | - |
name | string | A string uniquely identifying the workspace from other workspaces. NOTE: Does not differentiate between instances of the same workspace. For that, see the guid property of the ActiveWorkspace type. |
type | "workspace" | "template" | Distinguishes normal workspaces from templates. Templates are workspaces that are distributed by Finsemble administrators to users and are not modified, much like a template document in Microsoft Office. The different behavior between workspaces and templates isn't yet implemented, but will be soon. |
version | "1.0.0" | The version of the API schema. Used to maintain backward compatibility. |
WorkspaceEventName
Ƭ WorkspaceEventName: "load-requested" | "load-complete" | "load-failed" | "load-interrupted" | "close-requested" | "close-complete" | "close-canceled" | "close-failed" | "save-requested" | "save-complete" | "save-failed"
WorkspaceImport
Ƭ WorkspaceImport: WorkspaceBase & { componentStates?: Record<string, any> ; default?: boolean ; windowData?: FinsembleWindowData[] ; windows: string[] }