Skip to main content

WorkspaceLeaf

Extends WorkspaceItem

Constructor​

constructor();

Properties​

view​

view: View

Methods​

openFile​

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

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

open​

open(view: View): Promise<View>;

getViewState​

getViewState(): ViewState;

setViewState​

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

getEphemeralState​

getEphemeralState(): any;

setEphemeralState​

setEphemeralState(state: any): void;

togglePinned​

togglePinned(): void;

setPinned​

setPinned(pinned: boolean): void;

setGroupMember​

setGroupMember(other: WorkspaceLeaf): void;

setGroup​

setGroup(group: string): void;

detach​

detach(): void;

getIcon​

getIcon(): IconName;

getDisplayText​

getDisplayText(): string;

onResize​

onResize(): void;

on​

on(name: 'pinned-change', callback: (pinned: boolean) => any, ctx?: any): EventRef;

on​

on(name: 'group-change', callback: (group: string) => any, ctx?: any): EventRef;