WorkspaceLeaf

Class: WorkspaceLeaf

Defined in: workspace.svelte.ts:3255

Single navigable pane in the workspace that hosts one View at a time.

Extends

WorkspaceItem<{ group-change: [boolean]; pinned-change: [boolean]; }>

Constructors

Constructor

new WorkspaceLeaf(view?): WorkspaceLeaf

Defined in: workspace.svelte.ts:3294

Parameters

view?

View

Returns

WorkspaceLeaf

Overrides

WorkspaceItem<{ "pinned-change": [pinned: boolean]; "group-change": [pinned: boolean]; }>.constructor

Properties

_root

_root: WorkspaceItem<EventMap<T>> | undefined = undefined

Defined in: workspace.svelte.ts:102

Inherited from

WorkspaceSidedock._root

containerEl

containerEl: HTMLElement

Defined in: workspace.svelte.ts:3266

contentEl

contentEl: HTMLElement

Defined in: workspace.svelte.ts:3265

currentState

currentState: ViewState

Defined in: workspace.svelte.ts:3271

group

group: string | null

Defined in: workspace.svelte.ts:3262

history

history: HistoryManager<ViewState>

Defined in: workspace.svelte.ts:3268

hoverPopover

hoverPopover: null = null

Defined in: workspace.svelte.ts:3260

id

id: string

Defined in: workspace.svelte.ts:96

Inherited from

WorkspaceSidedock.id

parent

parent: WorkspaceTabs | WorkspaceSidebarGroup

Defined in: workspace.svelte.ts:3270

Overrides

WorkspaceSidedock.parent

pinned

pinned: boolean

Defined in: workspace.svelte.ts:3261

Accessors

app

Get Signature

get app(): App

Defined in: workspace.svelte.ts:3370

Returns

App

isDeferred

Get Signature

get isDeferred(): boolean

Defined in: workspace.svelte.ts:3522

Returns

boolean

state

Get Signature

get state(): ViewState

Defined in: workspace.svelte.ts:3280

Returns

ViewState

Set Signature

set state(value): void

Defined in: workspace.svelte.ts:3287

Parameters

value

ViewState

Returns

void

view

Get Signature

get view(): View

Defined in: workspace.svelte.ts:3351

Returns

View

Set Signature

set view(view): void

Defined in: workspace.svelte.ts:3355

Parameters

view

View

Returns

void

Methods

captureCurrentViewState()

captureCurrentViewState(): ViewState

Defined in: workspace.svelte.ts:3329

Returns

ViewState

close()

close(): void

Defined in: workspace.svelte.ts:3573

Returns

void

detach()

detach(softDelete?): WorkspaceTabsChild | undefined

Defined in: workspace.svelte.ts:3276

Parameters

softDelete?

boolean = false

Returns

WorkspaceTabsChild | undefined

dispatch()

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

Defined in: events.ts:105

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

eventName

T

args

…ArgumentMap<{ group-change: [boolean]; pinned-change: [boolean]; }>[Extract<T, "pinned-change" | "group-change">]

Returns

boolean

Inherited from

WorkspaceItem.dispatch

emit()

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

Defined in: events.ts:98

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

eventName

T

args

…ArgumentMap<{ group-change: [boolean]; pinned-change: [boolean]; }>[Extract<T, "pinned-change" | "group-change">]

Returns

boolean

Inherited from

WorkspaceItem.emit

getContainer()

getContainer(): WorkspaceContainer

Defined in: workspace.svelte.ts:3567

Returns

WorkspaceContainer

getDisplayText()

getDisplayText(): string

Defined in: workspace.svelte.ts:3563

Returns

string

getEphemeralState()

getEphemeralState(): any

Defined in: workspace.svelte.ts:3530

Returns

any

getIcon()

getIcon(): string

Defined in: workspace.svelte.ts:3559

Returns

string

getRoot()

getRoot(): WorkspaceItem

Defined in: workspace.svelte.ts:103

Returns

WorkspaceItem

Inherited from

WorkspaceItem.getRoot

getViewState()

getViewState(): ViewState

Defined in: workspace.svelte.ts:3518

Returns

ViewState

loadIfDeferred()

loadIfDeferred(): Promise<void>

Defined in: workspace.svelte.ts:3526

Returns

Promise<void>

loadJson()

loadJson(layout): Promise<void>

Defined in: workspace.svelte.ts:3577

Parameters

layout

WorkspaceLeafJson

Returns

Promise<void>

off()

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

Defined in: events.ts:78

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

eventName

T

listener

(…args) => void

context?

any

once?

boolean

Returns

void

Inherited from

WorkspaceItem.off

offref()

offref<T>(ref): void

Defined in: events.ts:87

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

ref

EventRef<{ group-change: [boolean]; pinned-change: [boolean]; }, T>

Returns

void

Inherited from

WorkspaceItem.offref

on()

on<T>(eventName, listener, context?): EventRef<{ group-change: [boolean]; pinned-change: [boolean]; }, T, any>

Defined in: events.ts:48

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ group-change: [boolean]; pinned-change: [boolean]; }, T, any>

Inherited from

WorkspaceItem.on

once()

once<T>(eventName, listener, context?): EventRef<{ group-change: [boolean]; pinned-change: [boolean]; }, T, any>

Defined in: events.ts:63

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ group-change: [boolean]; pinned-change: [boolean]; }, T, any>

Inherited from

WorkspaceItem.once

onResize()

onResize(): void

Defined in: workspace.svelte.ts:3571

Returns

void

open()

open(view, result?, state?): Promise<View>

Defined in: workspace.svelte.ts:3374

Parameters

Returns

Promise<View>

openFile()

openFile(file, __namedParameters?): Promise<void>

Defined in: workspace.svelte.ts:3408

Parameters

file

TFile

__namedParameters?

result?

ViewStateResult

state?

ViewState

view?

View

Returns

Promise<void>

reload()

reload(): void

Defined in: workspace.svelte.ts:3588

Returns

void

setEphemeralState()

setEphemeralState(state): void

Defined in: workspace.svelte.ts:3534

Parameters

state

any

Returns

void

setGroup()

setGroup(group): void

Defined in: workspace.svelte.ts:3554

Parameters

group

string

Returns

void

setGroupMember()

setGroupMember(other): void

Defined in: workspace.svelte.ts:3548

Parameters

other

WorkspaceLeaf

Returns

void

setPinned()

setPinned(pinned): void

Defined in: workspace.svelte.ts:3542

Parameters

pinned

boolean

Returns

void

setViewState()

setViewState(viewState, eState?): Promise<void>

Defined in: workspace.svelte.ts:3484

Parameters

viewState

ViewState

eState?

any

Returns

Promise<void>

togglePinned()

togglePinned(): void

Defined in: workspace.svelte.ts:3538

Returns

void

toJson()

toJson(): WorkspaceLeafJson

Defined in: workspace.svelte.ts:3592

Returns

WorkspaceLeafJson

trigger()

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

Defined in: events.ts:91

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

eventName

T

args

…ArgumentMap<{ group-change: [boolean]; pinned-change: [boolean]; }>[Extract<T, "pinned-change" | "group-change">]

Returns

boolean

Inherited from

WorkspaceItem.trigger

tryTrigger()

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

Defined in: events.ts:112

Type Parameters

T

T extends "pinned-change" | "group-change"

Parameters

evt

EventRef<{ group-change: [boolean]; pinned-change: [boolean]; }, T>

args

…ArgumentMap<{ group-change: [boolean]; pinned-change: [boolean]; }>[Extract<T, "pinned-change" | "group-change">]

Returns

void

Inherited from

WorkspaceItem.tryTrigger

updateHistory()

updateHistory(state): Promise<void>

Defined in: workspace.svelte.ts:3310

Parameters

state

ViewState

Returns

Promise<void>