TypedWorkspaceLeaf

On desktop, a leaf is always a child of a WorkspaceTabs component. On mobile, a leaf might be a child of a WorkspaceMobileDrawer. Perform an instanceof check before making an assumption about the parent.

Inherited from

WorkspaceLeaf.parent

parentSplit?

readonly optional parentSplit: WorkspaceParent

Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:10

Inherited from

WorkspaceLeaf.parentSplit

resizeHandleEl

resizeHandleEl: HTMLHRElement

Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:11

Inherited from

WorkspaceLeaf.resizeHandleEl

tabHeaderEl

tabHeaderEl: HTMLElement

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:6

Inherited from

WorkspaceLeaf.tabHeaderEl

tabHeaderInnerIconEl

tabHeaderInnerIconEl: HTMLElement

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:7

Inherited from

WorkspaceLeaf.tabHeaderInnerIconEl

tabHeaderInnerTitleEl

tabHeaderInnerTitleEl: HTMLElement

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:8

Inherited from

WorkspaceLeaf.tabHeaderInnerTitleEl

type

type: string

Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:12

Inherited from

WorkspaceLeaf.type

view

view: MaybeDeferredView<TView>

Defined in: src/obsidian/internals/TypedWorkspaceLeaf.d.ts:9

The view associated with this leaf. Do not attempt to cast this to your custom View without first checking instanceof.

Overrides

WorkspaceLeaf.view

workspace

workspace: Workspace

Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:13

Inherited from

WorkspaceLeaf.workspace

Accessors

isDeferred

Get Signature

get isDeferred(): boolean

Defined in: node_modules/obsidian/obsidian.d.ts:5058

Returns true if this leaf is currently deferred because it is in the background. A deferred leaf will have a DeferredView as its view, instead of the View that it should normally have for its type (like MarkdownView for the markdown type).

Since

1.7.2

Returns

boolean

Inherited from

WorkspaceLeaf.isDeferred

Methods

detach()

detach(): void

Defined in: obsidian.d.ts:5093

Returns

void

Inherited from

WorkspaceLeaf.detach

getContainer()

getContainer(): WorkspaceContainer

Defined in: obsidian.d.ts:5002

Get the root container parent item, which can be one of:

Returns

WorkspaceContainer

Inherited from

WorkspaceLeaf.getContainer

getDisplayText()

getDisplayText(): string

Defined in: obsidian.d.ts:5102

Returns

string

Inherited from

WorkspaceLeaf.getDisplayText

getEphemeralState()

getEphemeralState(): any

Defined in: obsidian.d.ts:5069

Returns

any

Inherited from

WorkspaceLeaf.getEphemeralState

getIcon()

getIcon(): string

Defined in: obsidian.d.ts:5098

Returns

string

Inherited from

WorkspaceLeaf.getIcon

getRoot()

getRoot(): WorkspaceItem

Defined in: obsidian.d.ts:4995

Returns

WorkspaceItem

Inherited from

WorkspaceLeaf.getRoot

getViewState()

getViewState(): ViewState

Defined in: obsidian.d.ts:5046

Returns

ViewState

Inherited from

WorkspaceLeaf.getViewState

loadIfDeferred()

loadIfDeferred(): Promise<void>

Defined in: obsidian.d.ts:5064

If this view is currently deferred, load it and await that it has fully loaded.

Returns

Promise<void>

Since

1.7.2

Inherited from

WorkspaceLeaf.loadIfDeferred

off()

off(name, callback): void

Defined in: obsidian.d.ts:1441

Parameters

name

string

callback

(…data) => unknown

Returns

void

Inherited from

WorkspaceLeaf.off

offref()

offref(ref): void

Defined in: obsidian.d.ts:1445

Parameters

ref

EventRef

Returns

void

Inherited from

WorkspaceLeaf.offref

on()

Call Signature

on(name, callback, ctx?): EventRef

Defined in: obsidian.d.ts:5112

Parameters

name

"pinned-change"

callback

(pinned) => any

ctx?

any

Returns

EventRef

Inherited from

WorkspaceLeaf.on

Call Signature

on(name, callback, ctx?): EventRef

Defined in: obsidian.d.ts:5116

Parameters

name

"group-change"

callback

(group) => any

ctx?

any

Returns

EventRef

Inherited from

WorkspaceLeaf.on

Call Signature

on(name, callback, ctx?): EventRef

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:14

Triggers when the leaf’s history gets updated (e.g. when new file is opened, or moving through history)

Parameters

name

"history-change"

callback

() => void

ctx?

unknown

Returns

EventRef

Inherited from

WorkspaceLeaf.on

Call Signature

on(name, callback, ctx?): EventRef

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:18

Triggers when context menu action is executed on the leaf

Parameters

name

"leaf-menu"

callback

(menu, leaf) => void

ctx?

unknown

Returns

EventRef

Inherited from

WorkspaceLeaf.on

onResize()

onResize(): void

Defined in: obsidian.d.ts:5107

Returns

void

Inherited from

WorkspaceLeaf.onResize

onResizeStart()

onResizeStart(evt): void

Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:17

Parameters

evt

MouseEvent

Returns

void

Inherited from

WorkspaceLeaf.onResizeStart

open()

open(view): Promise<View>

Defined in: obsidian.d.ts:5041

Parameters

openFile()

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

Defined in: obsidian.d.ts:5036

By default, openFile will also make the leaf active. Pass in { active: false } to override.

Parameters

file

TFile

openState?

OpenViewState

Returns

Promise<void>

Inherited from

WorkspaceLeaf.openFile

openLinkText()

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

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:25

Open a link in the current leaf

Parameters

linktext

string

The link text to open

sourcePath

string

The path of the source file

openViewState?

OpenViewState

The view state to open the link in

Returns

Promise<void>

Inherited from

WorkspaceLeaf.openLinkText

serialize()

serialize(): SerializedWorkspaceItem

Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:18

Returns

SerializedWorkspaceItem

Inherited from

WorkspaceLeaf.serialize

setDimension()

setDimension(flexgrow?): void

Defined in: src/obsidian/augmentations/WorkspaceLeaf.d.ts:35

Set the vertical height a leaf may occupy if it is in a split. The height is not set directly, but by setting the flex-grow (css) of the element. This means to predictably affect the height, you also need to use setDimension on the other leafs of the column. (The flex-grow values of every leaf work basically like a ratio, e.g. 1:2 meaning the first leaf takes 33% of the height, and the second 67%.)