Workspace - Developer Documentation

[`Workspace`](Workspace) ## Workspace class 0.9.7 **Signature:** ```typescript export class Workspace extends Events ``` **Extends:** [`Events`](Events) ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [`activeEditor`](Workspace/activeEditor) | | [`MarkdownFileInfo`](MarkdownFileInfo)<code> | null</code> | A component managing the current editor. This can be null if the active view has no editor. | | [`activeLeaf`](Workspace/activeLeaf) | | [`WorkspaceLeaf`](WorkspaceLeaf)<code> | null</code> | Indicates the currently focused leaf, if one exists.Please avoid using <code>activeLeaf</code> directly, especially without checking whether <code>activeLeaf</code> is null. 0.9.7 | | [`containerEl`](Workspace/containerEl) | | <code>HTMLElement</code> | 0.9.7 | | [`layoutReady`](Workspace/layoutReady) | | <code>boolean</code> | If the layout of the app has been successfully initialized. To react to the layout becoming ready, use [Workspace.onLayoutReady()](Workspace/onLayoutReady) 0.9.7 | | [`leftRibbon`](Workspace/leftRibbon) | | [`WorkspaceRibbon`](WorkspaceRibbon) | 0.9.7 | | [`leftSplit`](Workspace/leftSplit) | | [`WorkspaceSidedock`](WorkspaceSidedock)<code> | </code>[`WorkspaceMobileDrawer`](WorkspaceMobileDrawer) | 0.9.7 | | [`requestSaveLayout`](Workspace/requestSaveLayout) | | [`Debouncer`](Debouncer)<code><[], </code><code>Promise</code><code><void>></code> | Save the state of the current workspace layout. 0.16.0 | | [`rightRibbon`](Workspace/rightRibbon) | | [`WorkspaceRibbon`](WorkspaceRibbon) | | | [`rightSplit`](Workspace/rightSplit) | | [`WorkspaceSidedock`](WorkspaceSidedock)<code> | </code>[`WorkspaceMobileDrawer`](WorkspaceMobileDrawer) | 0.9.7 | | [`rootSplit`](Workspace/rootSplit) | | [`WorkspaceRoot`](WorkspaceRoot) | 0.9.7 | ## Methods | Method | Modifiers | Description | | --- | --- | --- | | [`changeLayout(workspace)`](Workspace/changeLayout) | | 0.9.7 | | [`createLeafBySplit(leaf, direction, before)`](Workspace/createLeafBySplit) | | 0.9.7 | | [`createLeafInParent(parent, index)`](Workspace/createLeafInParent) | | 0.9.11 | | [`detachLeavesOfType(viewType)`](Workspace/detachLeavesOfType) | | Remove all leaves of the given type. 0.9.7 | | [`duplicateLeaf(leaf, direction)`](Workspace/duplicateLeaf) | | | | [`duplicateLeaf(leaf, leafType, direction)`](Workspace/duplicateLeaf_1) | | 1.1.0 | | [`ensureSideLeaf(type, side, options)`](Workspace/ensureSideLeaf) | | Get side leaf or create one if one does not exist. 1.7.2 | | [`getActiveFile()`](Workspace/getActiveFile) | | Returns the file for the current view if it's a <code>FileView</code>. Otherwise, it will return the most recently active file. | | [`getActiveViewOfType(type)`](Workspace/getActiveViewOfType) | | Get the currently active view of a given type. 0.9.16 | | [`getGroupLeaves(group)`](Workspace/getGroupLeaves) | | Get all leaves that belong to a group | | [`getLastOpenFiles()`](Workspace/getLastOpenFiles) | | Get the filenames of the 10 most recently opened files. 0.9.7 | | [`getLayout()`](Workspace/getLayout) | | 0.9.7 | | [`getLeaf(newLeaf, direction)`](Workspace/getLeaf('split').md) | | Creates a new leaf in a leaf adjacent to the currently active leaf. If direction is <code>'vertical'</code>, the leaf will appear to the right. If direction is <code>'horizontal'</code>, the leaf will appear below the current leaf. 0.16.0 | | [`getLeaf(newLeaf)`](Workspace/getLeaf_1) | | If newLeaf is false (or not set) then an existing leaf which can be navigated is returned, or a new leaf will be created if there was no leaf available.If newLeaf is <code>'tab'</code> or <code>true</code> then a new leaf will be created in the preferred location within the root split and returned.If newLeaf is <code>'split'</code> then a new leaf will be created adjacent to the currently active leaf.If newLeaf is <code>'window'</code> then a popout window will be created with a new leaf inside. 0.16.0 | | [`getLeafById(id)`](Workspace/getLeafById) | | Retrieve a leaf by its id. | | [`getLeavesOfType(viewType)`](Workspace/getLeavesOfType) | | Get all leaves of a given type. 0.9.7 | | [`getLeftLeaf(split)`](Workspace/getLeftLeaf) | | Create a new leaf inside the left sidebar. | | [`getMostRecentLeaf(root)`](Workspace/getMostRecentLeaf) | | Get the most recently active leaf in a given workspace root. Useful for interacting with the leaf in the root split while a sidebar leaf might be active. | | [`getRightLeaf(split)`](Workspace/getRightLeaf) | | Create a new leaf inside the right sidebar. | | [`getUnpinnedLeaf()`](Workspace/getUnpinnedLeaf) | | | | [`handleLinkContextMenu(menu, linktext, sourcePath, leaf)`](Workspace/handleLinkContextMenu) | | Add a context menu to internal file links. 0.12.10 | | [`iterateAllLeaves(callback)`](Workspace/iterateAllLeaves) | | Iterate through all leaves, including main area leaves, floating leaves, and sidebar leaves. 0.9.7 | | [`iterateRootLeaves(callback)`](Workspace/iterateRootLeaves) | | Iterate through all leaves in the main area of the workspace. 0.9.7 | | [`moveLeafToPopout(leaf, data)`](Workspace/moveLeafToPopout) | | Migrates this leaf to a new popout window. Only works on the desktop app. | | [`off(name, callback)`](Events/off) | | 0.9.7(Inherited from [Events](Events)) | | [`offref(ref)`](Events/offref) | | 0.9.7(Inherited from [Events](Events)) | | [`on(name: 'quick-preview', callback, ctx)`](Workspace/on('quick-preview').md) | | Triggered when the active Markdown file is modified. React to file changes before they are saved to disk. 0.9.7 | | [`on(name: 'files-menu', callback, ctx)`](Workspace/on('files-menu').md) | | Triggered when the user opens the context menu with multiple files selected in the File Explorer. 1.4.10 | | [`on(name: 'url-menu', callback, ctx)`](Workspace/on('url-menu').md) | | Triggered when the user opens the context menu on an external URL. 1.5.1 | | [`on(name: 'editor-menu', callback, ctx)`](Workspace/on('editor-menu').md) | | Triggered when the user opens the context menu on an editor. 1.1.0 | | [`on(name: 'editor-change', callback, ctx)`](Workspace/on('editor-change').md) | | Triggered when changes to an editor has been applied, either programmatically or from a user event. 1.1.1 | | [`on(name: 'editor-paste', callback, ctx)`](Workspace/on('editor-paste').md) | | Triggered when the editor receives a paste event. Check for <code>evt.defaultPrevented</code> before attempting to handle this event, and return if it has been already handled. Use <code>evt.preventDefault()</code> to indicate that you've handled the event. 1.1.0 | | [`on(name: 'editor-drop', callback, ctx)`](Workspace/on('editor-drop').md) | | Triggered when the editor receives a drop event. Check for <code>evt.defaultPrevented</code> before attempting to handle this event, and return if it has been already handled. Use <code>evt.preventDefault()</code> to indicate that you've handled the event. 1.1.0 | | [`on(name: 'quit', callback, ctx)`](Workspace/on('quit').md) | | Triggered when the app is about to quit. Not guaranteed to actually run. Perform some best effort cleanup here. 0.10.2 | | [`on(name: 'resize', callback, ctx)`](Workspace/on('resize').md) | | Triggered when a <code>WorkspaceItem</code> is resized or the workspace layout has changed. 0.9.7 | | [`on(name: 'active-leaf-change', callback, ctx)`](Workspace/on('active-leaf-change').md) | | Triggered when the active leaf changes. 0.10.9 | | [`on(name: 'file-open', callback, ctx)`](Workspace/on('file-open').md) | | Triggered when the active file changes. The file could be in a new leaf, an existing leaf, or an embed. 0.10.9 | | [`on(name: 'layout-change', callback, ctx)`](Workspace/on('layout-change').md) | | 0.9.20 | | [`on(name: 'window-open', callback, ctx)`](Workspace/on('window-open').md) | | Triggered when a new popout window is created. 0.15.3 | | [`on(name: 'window-close', callback, ctx)`](Workspace/on('window-close').md) | | Triggered when a popout window is closed. 0.15.3 | | [`on(name: 'css-change', callback, ctx)`](Workspace/on('css-change').md) | | Triggered when the CSS of the app has changed. 0.9.7 | | [`on(name: 'file-menu', callback, ctx)`](Workspace/on('file-menu').md) | | Triggered when the user opens the context menu on a file. 0.9.12 | | [`onLayoutReady(callback)`](Workspace/onLayoutReady) | | Runs the callback function right away if layout is already ready, or push it to a queue to be called later when layout is ready. 0.11.0 | | [`openLinkText(linktext, sourcePath, newLeaf, openViewState)`](Workspace/openLinkText) | | 0.16.0 | | [`openPopoutLeaf(data)`](Workspace/openPopoutLeaf) | | Open a new popout window with a single new leaf and return that leaf. Only works on the desktop app. 0.15.4 | | [`revealLeaf(leaf)`](Workspace/revealLeaf) | | Bring a given leaf to the foreground. If the leaf is in a sidebar, the sidebar will be uncollapsed. <code>await</code> this function to ensure your view has been fully loaded and is not deferred. 1.7.2 | | [`setActiveLeaf(leaf, params)`](Workspace/setActiveLeaf) | | Sets the active leaf | | [`setActiveLeaf(leaf, pushHistory, focus)`](Workspace/setActiveLeaf_1) | | | | [`splitActiveLeaf(direction)`](Workspace/splitActiveLeaf) | | | | [`trigger(name, data)`](Events/trigger) | | 0.9.7(Inherited from [Events](Events)) | | [`tryTrigger(evt, args)`](Events/tryTrigger) | | 0.9.7(Inherited from [Events](Events)) | | [`updateOptions()`](Workspace/updateOptions) | | Calling this function will update/reconfigure the options of all Markdown views. It is fairly expensive, so it should not be called frequently. 0.13.21 |