Workspace

Class: Workspace

Defined in: workspace.svelte.ts:1285

Owns the workspace layout tree, leaf registry, and view-type routing.

Workspace coordinates default file navigation, sidebar placement, layout persistence, and the active editor/leaf state that plugins interact with.

Extends

• EventDispatcher<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }>

Constructors

Constructor

new Workspace(app): Workspace

Defined in: workspace.svelte.ts:1951

Parameters

app

App

Returns

Workspace

Overrides

EventDispatcher.constructor

Properties

_activeLeaf

_activeLeaf: WorkspaceLeaf | null

Defined in: workspace.svelte.ts:1324

---

app

readonly app: App

Defined in: workspace.svelte.ts:1951

---

containerEl

containerEl: HTMLElement

Defined in: workspace.svelte.ts:1344

---

editorViews

readonly editorViews: EditorViewRegistry

Defined in: workspace.svelte.ts:1318

---

floating

floating: WorkspaceFloating

Defined in: workspace.svelte.ts:1335

---

focusedHostId

focusedHostId: string

Defined in: workspace.svelte.ts:1326

---

focusMode

focusMode: WorkspaceFocusModeState | null

Defined in: workspace.svelte.ts:1325

---

layoutReady

layoutReady: boolean

Defined in: workspace.svelte.ts:1336

---

leftRibbon

leftRibbon: WorkspaceRibbon

Defined in: workspace.svelte.ts:1342

---

leftSplit

leftSplit: WorkspaceSidedock

Defined in: workspace.svelte.ts:1327

---

rightRibbon

rightRibbon: WorkspaceRibbon

Defined in: workspace.svelte.ts:1343

---

rightSplit

rightSplit: WorkspaceSidedock

Defined in: workspace.svelte.ts:1331

---

rootContainer

rootContainer: WorkspaceRoot

Defined in: workspace.svelte.ts:1322

---

rootSplit

rootSplit: WorkspaceView

Defined in: workspace.svelte.ts:1323

---

statusCompatEl

statusCompatEl: HTMLElement

Defined in: workspace.svelte.ts:1341

---

statusEl

statusEl: HTMLElement

Defined in: workspace.svelte.ts:1340

Accessors

activeEditor

Get Signature

get activeEditor(): MarkdownFileInfo | null

Defined in: workspace.svelte.ts:1826

Returns

MarkdownFileInfo | null

---

activeLeaf

Get Signature

get activeLeaf(): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:1800

Returns

WorkspaceLeaf | null

Set Signature

set activeLeaf(leaf): void

Defined in: workspace.svelte.ts:1822

Parameters

leaf

WorkspaceLeaf | null

Returns

void

---

activeRootLeaf

Get Signature

get activeRootLeaf(): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:1811

Returns

WorkspaceLeaf | null

Methods

changeLayout()

changeLayout(workspace): Promise<void>

Defined in: workspace.svelte.ts:2025

Parameters

workspace

any

Returns

Promise<void>

---

clearFocusModeForLeaf()

clearFocusModeForLeaf(leaf): boolean

Defined in: workspace.svelte.ts:1860

Parameters

leaf

WorkspaceLeaf

Returns

boolean

---

closeFloatingWindow()

closeFloatingWindow(window, options?): void

Defined in: workspace.svelte.ts:2976

Parameters

window

WorkspaceWindow

options?

closeHost?

boolean

operation?

string

Returns

void

---

collapseFloatingWindow()

collapseFloatingWindow(window): void

Defined in: workspace.svelte.ts:2928

Parameters

window

WorkspaceWindow

Returns

void

---

commitFloatingWindowBounds()

commitFloatingWindowBounds(window, bounds, operation?): void

Defined in: workspace.svelte.ts:2967

Parameters

window

WorkspaceWindow

bounds

Partial<Record<"x" | "y" | "width" | "height", number>>

operation?

string = "resize-floating-pane"

Returns

void

---

convertSidebarGroupToLeaves()

convertSidebarGroupToLeaves(group): WorkspaceLeaf[]

Defined in: workspace.svelte.ts:2642

Parameters

group

WorkspaceSidebarGroup

Returns

WorkspaceLeaf[]

---

convertSidebarLeavesToGroup()

convertSidebarLeavesToGroup(side, leaves, options?): WorkspaceSidebarGroup

Defined in: workspace.svelte.ts:2598

Parameters

side

SidebarSide

leaves

WorkspaceLeaf[]

options?

SidebarGroupOptions & object = {}

Returns

WorkspaceSidebarGroup

---

createLeafBySplit()

createLeafBySplit(leaf, direction?, before?): WorkspaceLeaf

Defined in: workspace.svelte.ts:2466

Parameters

leaf

WorkspaceLeaf

direction?

SplitDirection = "vertical"

before?

boolean = false

Returns

WorkspaceLeaf

---

createLeafInParent()

createLeafInParent(parent, index): WorkspaceLeaf

Defined in: workspace.svelte.ts:2460

Parameters

parent

WorkspaceSplit

index

number

Returns

WorkspaceLeaf

---

detachLeavesOfType()

detachLeavesOfType(viewType): void

Defined in: workspace.svelte.ts:2444

Remove all leaves of the given type.

Parameters

viewType

string

Returns

void

---

determineViewType()

determineViewType(type): string | undefined

Defined in: workspace.svelte.ts:2312

Parameters

type

string

Returns

string | undefined

---

determineViewTypeForPath()

determineViewTypeForPath(path): string | undefined

Defined in: workspace.svelte.ts:2322

Parameters

path

string

Returns

string | undefined

---

dispatch()

dispatch<T>(eventName, …args): boolean

Defined in: events.ts:105

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

eventName

T

args

…ArgumentMap<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }>[Extract<T, "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu">]

Returns

boolean

Inherited from

EventDispatcher.dispatch

---

dropWorkspaceItemOnTabs()

dropWorkspaceItemOnTabs(parent, options): Promise<boolean>

Defined in: workspace.svelte.ts:1487

Parameters

parent

WorkspaceTabs | WorkspaceSplit<EventMap<T>>

options

file?

TFile

item?

WorkspaceLeaf

operation?

string

position

WorkspaceLayoutDropPosition

source?

WorkspaceLayoutDropSource

Returns

Promise<boolean>

---

duplicateLeaf()

duplicateLeaf(leaf, leafType, direction?): Promise<WorkspaceLeaf>

Defined in: workspace.svelte.ts:3083

Parameters

leaf

WorkspaceLeaf

leafType

boolean | PaneType

direction?

SplitDirection = "vertical"

Returns

Promise<WorkspaceLeaf>

---

emit()

emit<T>(eventName, …args): boolean

Defined in: events.ts:98

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

eventName

T

args

…ArgumentMap<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }>[Extract<T, "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu">]

Returns

boolean

Inherited from

EventDispatcher.emit

---

endLayoutDrag()

endLayoutDrag(options): WorkspaceLayoutDropEvent

Defined in: workspace.svelte.ts:1414

Parameters

options

Omit<WorkspaceLayoutDropEvent, "defaultPrevented" | "preventDefault">

Returns

WorkspaceLayoutDropEvent

---

ensureSideLeaf()

ensureSideLeaf(type, sideOrOptions?, options?): WorkspaceLeaf

Defined in: workspace.svelte.ts:2693

Parameters

type

string

sideOrOptions?

SidebarSide | EnsureSideLeafOptions

options?

EnsureSideLeafOptions = {}

Returns

WorkspaceLeaf

---

enterFocusMode()

enterFocusMode(leaf?): boolean

Defined in: workspace.svelte.ts:1840

Parameters

leaf?

WorkspaceLeaf | null

Returns

boolean

---

exitFocusMode()

exitFocusMode(): boolean

Defined in: workspace.svelte.ts:1856

Returns

boolean

---

focusFloatingWindow()

focusFloatingWindow(window): void

Defined in: workspace.svelte.ts:2895

Parameters

window

WorkspaceWindow

Returns

void

---

focusRootHost()

focusRootHost(): void

Defined in: workspace.svelte.ts:1796

Returns

void

---

getActiveFile()

getActiveFile(): TFile | null

Defined in: workspace.svelte.ts:2411

Returns the file for the current view if it’s a FileView. Otherwise, it will return the most recently active file.

Returns

TFile | null

---

getActiveViewOfType()

getActiveViewOfType<T>(type): T | null

Defined in: workspace.svelte.ts:2388

Get the currently active view of a given type.

Type Parameters

T

T extends View

Parameters

type

Constructor<T>

Returns

T | null

---

getCommandHostDocument()

getCommandHostDocument(hostId?): Document

Defined in: workspace.svelte.ts:1771

Parameters

hostId?

string = ...

Returns

Document

---

getCommandHostIdForLeaf()

getCommandHostIdForLeaf(target): string

Defined in: workspace.svelte.ts:1758

Parameters

target

WorkspaceLeaf | null

Returns

string

---

getCommandHostLeaf()

getCommandHostLeaf(hostId): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:1762

Parameters

hostId

string

Returns

WorkspaceLeaf | null

---

getEditorAssociationForPath()

getEditorAssociationForPath(path): { editorViewId: string; pattern: string; view?: RegisteredEditorViewContribution; } | undefined

Defined in: workspace.svelte.ts:2213

Parameters

path

string

Returns

{ editorViewId: string; pattern: string; view?: RegisteredEditorViewContribution; } | undefined

---

getFocusedCommandHostId()

getFocusedCommandHostId(): string

Defined in: workspace.svelte.ts:1784

Returns

string

---

getGroupLeaves()

getGroupLeaves(group): WorkspaceLeaf[]

Defined in: workspace.svelte.ts:2501

Parameters

group

string

Returns

WorkspaceLeaf[]

---

getLastOpenFiles()

getLastOpenFiles(): string[]

Defined in: workspace.svelte.ts:2658

Returns

string[]

---

getLayout()

getLayout(): Record<string, unknown>

Defined in: workspace.svelte.ts:2039

Returns

Record<string, unknown>

---

getLeaf()

getLeaf(newLeaf?, direction?): WorkspaceLeaf

Defined in: workspace.svelte.ts:3143

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 'tab' or true then a new leaf will be created in the preferred location within the root split and returned.

If newLeaf is 'split' then a new leaf will be created adjacent to the currently active leaf.

If newLeaf is 'window' then a popout window will be created with a new leaf inside.

Parameters

newLeaf?

boolean | PaneType

direction?

SplitDirection

Returns

WorkspaceLeaf

---

getLeafById()

getLeafById(id): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:2375

Retrieve a leaf by its id.

Parameters

id

string

Id of the leaf to retrieve.

Returns

WorkspaceLeaf | null

---

getLeavesOfType()

getLeavesOfType(viewType): WorkspaceLeaf[]

Defined in: workspace.svelte.ts:2450

Parameters

viewType

string

Returns

WorkspaceLeaf[]

---

getLeftLeaf()

getLeftLeaf(split): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:3074

Create a new leaf inside the left sidebar.

Parameters

split

boolean

Should the existing split be split up?

Returns

WorkspaceLeaf | null

---

getMostRecentLeaf()

getMostRecentLeaf(): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:1971

Returns

WorkspaceLeaf | null

---

getOrCreateSidebarGroup()

getOrCreateSidebarGroup(side, group, options?): WorkspaceSidebarGroup

Defined in: workspace.svelte.ts:2569

Parameters

side

SidebarSide

group

string

options?

SidebarGroupOptions = {}

Returns

WorkspaceSidebarGroup

---

getRightLeaf()

getRightLeaf(split): WorkspaceLeaf | null

Defined in: workspace.svelte.ts:3059

Create a new leaf inside the right sidebar.

Parameters

split

boolean

Should the existing split be split up?

Returns

WorkspaceLeaf | null

---

getSidebarGroup()

getSidebarGroup(side, group): WorkspaceSidebarGroup | null

Defined in: workspace.svelte.ts:2557

Parameters

side

SidebarSide

group

string

Returns

WorkspaceSidebarGroup | null

---

getSidebarGroupLeaves()

getSidebarGroupLeaves(side, group): WorkspaceLeaf[]

Defined in: workspace.svelte.ts:2594

Parameters

side

SidebarSide

group

string

Returns

WorkspaceLeaf[]

---

getSidebarGroups()

getSidebarGroups(side?): WorkspaceSidebarGroup[]

Defined in: workspace.svelte.ts:2540

Parameters

side?

SidebarSide

Returns

WorkspaceSidebarGroup[]

---

getUnpinnedLeaf()

getUnpinnedLeaf(): WorkspaceLeaf

Defined in: workspace.svelte.ts:2497

Returns

WorkspaceLeaf

---

getVisibleHintTargets()

getVisibleHintTargets(): WorkspaceHintTarget[]

Defined in: workspace.svelte.ts:1975

Returns

WorkspaceHintTarget[]

---

handleLinkContextMenu()

handleLinkContextMenu(menu, linktext, sourcePath, event?): void

Defined in: workspace.svelte.ts:2738

Parameters

menu

Menu

linktext

string

sourcePath

string

event?

MouseEvent

Returns

void

---

isFocusModeForTabs()

isFocusModeForTabs(tabs): boolean

Defined in: workspace.svelte.ts:1868

Parameters

tabs

WorkspaceTabs

Returns

boolean

---

iterateAllLeaves()

iterateAllLeaves<T>(callback): void | T

Defined in: workspace.svelte.ts:2425

Iterate through all leaves, including main area leaves, floating leaves, and sidebar leaves.

Type Parameters

T

T = any

Parameters

callback

(leaf) => T

Returns

void | T

---

iterateRootLeaves()

iterateRootLeaves(callback): void

Defined in: workspace.svelte.ts:2401

Iterate through all leaves in the main area of the workspace.

Parameters

callback

(leaf) => any

Returns

void

---

loadLayout()

loadLayout(file?): Promise<void>

Defined in: workspace.svelte.ts:1907

Parameters

file?

string = "workspace.json"

Returns

Promise<void>

---

maximizeFloatingWindow()

maximizeFloatingWindow(window): void

Defined in: workspace.svelte.ts:2944

Parameters

window

WorkspaceWindow

Returns

void

---

minimizeFloatingWindow()

minimizeFloatingWindow(window): void

Defined in: workspace.svelte.ts:2936

Parameters

window

WorkspaceWindow

Returns

void

---

moveLeafToPopout()

moveLeafToPopout(leaf, data?): WorkspaceWindow

Defined in: workspace.svelte.ts:2751

Parameters

leaf

WorkspaceLeaf

data?

WorkspaceWindowInitData

Returns

WorkspaceWindow

---

moveLeafToSidebarGroup()

moveLeafToSidebarGroup(leaf, group, options?): boolean

Defined in: workspace.svelte.ts:1677

Parameters

leaf

WorkspaceLeaf

group

WorkspaceSidebarGroup

options?

operation?

string

source?

WorkspaceLayoutDropSource

Returns

boolean

---

moveLeafToSidebarGroupIndex()

moveLeafToSidebarGroupIndex(leaf, group, index, options): boolean

Defined in: workspace.svelte.ts:1626

Parameters

leaf

WorkspaceLeaf

group

WorkspaceSidebarGroup

index

number

options

operation?

string

position

"bottom" | "top"

source?

WorkspaceLayoutDropSource

Returns

boolean

---

moveWorkspaceChildToFloating()

moveWorkspaceChildToFloating(item, data?, options?): WorkspaceWindow

Defined in: workspace.svelte.ts:2790

Parameters

item

WorkspaceTabsChild

data?

WorkspaceWindowInitData

options?

operation?

string

source?

WorkspaceLayoutDropSource

Returns

WorkspaceWindow

---

moveWorkspaceChildToPopout()

moveWorkspaceChildToPopout(item, data?): WorkspaceWindow

Defined in: workspace.svelte.ts:2762

Parameters

item

WorkspaceTabsChild

data?

WorkspaceWindowInitData

Returns

WorkspaceWindow

---

moveWorkspaceChildToTabIndex()

moveWorkspaceChildToTabIndex(item, target, index, options): boolean

Defined in: workspace.svelte.ts:1423

Parameters

item

WorkspaceLeaf | WorkspaceSidebarGroup

target

WorkspaceTabs

index

number

options

operation?

string

position

"right" | "left"

source?

WorkspaceLayoutDropSource

Returns

boolean

---

off()

off<T>(eventName, listener, context?, once?): void

Defined in: events.ts:78

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

eventName

T

listener

(…args) => void

context?

any

once?

boolean

Returns

void

Inherited from

EventDispatcher.off

---

offref()

offref<T>(ref): void

Defined in: events.ts:87

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

ref

EventRef<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }, T>

Returns

void

Inherited from

EventDispatcher.offref

---

on()

on<T>(eventName, listener, context?): EventRef<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }, T, any>

Defined in: events.ts:48

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }, T, any>

Inherited from

EventDispatcher.on

---

once()

once<T>(eventName, listener, context?): EventRef<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }, T, any>

Defined in: events.ts:63

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }, T, any>

Inherited from

EventDispatcher.once

---

onLayoutReady()

onLayoutReady(callback): void

Defined in: workspace.svelte.ts:1943

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.

Parameters

callback

() => any

Returns

void

---

openLinkText()

openLinkText(linktext, sourcePath, newLeaf?, openState?): Promise<void>

Defined in: workspace.svelte.ts:2668

Parameters

linktext

string

sourcePath

string

newLeaf?

boolean | PaneType

openState?

OpenViewState

Returns

Promise<void>

---

openPopoutLeaf()

openPopoutLeaf(data?): WorkspaceLeaf

Defined in: workspace.svelte.ts:2773

Parameters

data?

WorkspaceWindowInitData

Returns

WorkspaceLeaf

---

registerEditorView()

registerEditorView(contribution): () => void

Defined in: workspace.svelte.ts:2078

Parameters

contribution

EditorViewContribution

Returns

() => void

---

registerExtensions()

registerExtensions(extensions, viewType): void

Defined in: workspace.svelte.ts:2263

Parameters

extensions

string[]

viewType

string

Returns

void

---

registerHoverLinkSource()

registerHoverLinkSource(id, info): void

Defined in: workspace.svelte.ts:2099

Registers a view with the ‘Page preview’ core plugin as an emitter of the ‘hover-link’ event.

Parameters

id

string

info

HoverLinkSource

Returns

void

---

registerSidebarView()

registerSidebarView(type, options?): void

Defined in: workspace.svelte.ts:2082

Parameters

type

string

options?

SidebarViewPlacementOptions = {}

Returns

void

---

registerView()

registerView(type, viewCreator): void

Defined in: workspace.svelte.ts:2074

Parameters

type

string

viewCreator

ViewCreator

Returns

void

---

requestSaveLayout()

requestSaveLayout(event?): void

Defined in: workspace.svelte.ts:1358

Parameters

event?

WorkspaceLayoutChangeEvent = ...

Returns

void

---

restoreFloatingWindow()

restoreFloatingWindow(window): void

Defined in: workspace.svelte.ts:2952

Parameters

window

WorkspaceWindow

Returns

void

---

revealLeaf()

revealLeaf(leaf): Promise<void>

Defined in: workspace.svelte.ts:2050

Bring a given leaf to the foreground. If the leaf is in a sidebar, the sidebar will be uncollapsed. await this function to ensure your view has been fully loaded and is not deferred.

Parameters

leaf

WorkspaceLeaf

Returns

Promise<void>

---

setActiveLeaf()

setActiveLeaf(leaf, params?): void

Defined in: workspace.svelte.ts:2358

Parameters

leaf

WorkspaceLeaf

params?

focus?

boolean

Returns

void

---

setFloatingWindowBounds()

setFloatingWindowBounds(window, bounds): void

Defined in: workspace.svelte.ts:2960

Parameters

window

WorkspaceWindow

bounds

Partial<Record<"x" | "y" | "width" | "height", number>>

Returns

void

---

setFloatingWindowDisplayState()

setFloatingWindowDisplayState(window, displayState, operation?): void

Defined in: workspace.svelte.ts:2914

Parameters

window

WorkspaceWindow

displayState

WorkspaceWindowDisplayState

operation?

string = ...

Returns

void

---

splitActiveLeaf()

splitActiveLeaf(direction?): WorkspaceLeaf

Defined in: workspace.svelte.ts:2493

Parameters

direction?

SplitDirection

Returns

WorkspaceLeaf

---

startLayoutDrag()

startLayoutDrag(options): WorkspaceLayoutDropEvent

Defined in: workspace.svelte.ts:1405

Parameters

options

Omit<WorkspaceLayoutDropEvent, "defaultPrevented" | "preventDefault">

Returns

WorkspaceLayoutDropEvent

---

supportsPopoutWindows()

supportsPopoutWindows(): boolean

Defined in: workspace.svelte.ts:2804

Returns

boolean

---

toJson()

toJson(): WorkspaceJson

Defined in: workspace.svelte.ts:1872

Returns

WorkspaceJson

---

trigger()

trigger<T>(eventName, …args): boolean

Defined in: events.ts:91

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

eventName

T

args

…ArgumentMap<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }>[Extract<T, "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu">]

Returns

boolean

Inherited from

EventDispatcher.trigger

---

tryTrigger()

tryTrigger<T>(evt, …args): void

Defined in: events.ts:112

Type Parameters

T

T extends "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu"

Parameters

evt

EventRef<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }, T>

args

…ArgumentMap<{ active-leaf-change: [WorkspaceLeaf | null]; editor-menu: [Menu, Editor]; editor-updated: [Editor, readonly TransactionSpec[]]; file-change: [TFile, string]; file-menu: [Menu, TAbstractFile, string, WorkspaceLeaf]; file-open: [TFile | null]; files-menu: [Menu, TAbstractFile[], string, WorkspaceLeaf]; focus-mode-change: [WorkspaceFocusModeState | null]; layout-change: [WorkspaceLayoutChangeEvent]; layout-did-drop: [WorkspaceLayoutDropEvent]; layout-drag-end: [WorkspaceLayoutDropEvent]; layout-drag-start: [WorkspaceLayoutDropEvent]; layout-ready: []; layout-will-drop: [WorkspaceLayoutDropEvent]; layout-will-show-overlay: [WorkspaceLayoutDropEvent]; quick-preview: [TFile, string]; resize: [any]; }>[Extract<T, "editor-updated" | "resize" | "active-leaf-change" | "focus-mode-change" | "layout-ready" | "layout-change" | "layout-drag-start" | "layout-drag-end" | "layout-will-show-overlay" | "layout-will-drop" | "layout-did-drop" | "quick-preview" | "file-open" | "file-change" | "file-menu" | "files-menu" | "editor-menu">]

Returns

void

Inherited from

EventDispatcher.tryTrigger

---

unregisterExtensions()

unregisterExtensions(extensions, viewType): void

Defined in: workspace.svelte.ts:2295

Parameters

extensions

string[]

viewType

string

Returns

void

---

unregisterHoverLinkSource()

unregisterHoverLinkSource(id): void

Defined in: workspace.svelte.ts:2103

Parameters

id

string

Returns

void

---

unregisterSidebarView()

unregisterSidebarView(type): void

Defined in: workspace.svelte.ts:2089

Parameters

type

string

Returns

void

---

unregisterView()

unregisterView(type): boolean

Defined in: workspace.svelte.ts:2125

Parameters

type

string

Returns

boolean

---

updateOptions()

updateOptions(): void

Defined in: workspace.svelte.ts:2107

Returns

void

---

viewCreator()

viewCreator(type): ViewCreator | undefined

Defined in: workspace.svelte.ts:2342

Parameters

type

string | TFile

Returns

ViewCreator | undefined

---

willShowLayoutDropOverlay()

willShowLayoutDropOverlay(options): WorkspaceLayoutDropEvent

Defined in: workspace.svelte.ts:1396

Parameters

options

Omit<WorkspaceLayoutDropEvent, "defaultPrevented" | "preventDefault">

Returns

WorkspaceLayoutDropEvent