WorkspaceItem

Defined in: obsidian.d.ts:4984

Extends

• Events

Extended by

• WorkspaceLeaf
• WorkspaceParent

Constructors

new WorkspaceItem()

new WorkspaceItem(): WorkspaceItem

Returns

WorkspaceItem

Inherited from

Events.constructor

Properties

_

_: Record<string, EventsEntry[]>

Defined in: src/obsidian/augmentations/Events.d.ts:5

Inherited from

Events._

---

app

app: App

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

---

component

component: Component

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

---

containerEl

containerEl: HTMLDivElement

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

---

dimension

dimension: null | number

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

---

id

id: string

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

---

parent

abstract parent: WorkspaceParent

Defined in: obsidian.d.ts:4990

The direct parent of the leaf.

---

parentSplit?

readonly optional parentSplit: WorkspaceParent

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

---

resizeHandleEl

resizeHandleEl: HTMLHRElement

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

---

type

type: string

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

---

workspace

workspace: Workspace

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

Methods

detach()

detach(): void

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

Returns

void

---

getContainer()

getContainer(): WorkspaceContainer

Defined in: obsidian.d.ts:5002

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

• WorkspaceRoot
• WorkspaceWindow

Returns

WorkspaceContainer

---

getIcon()

getIcon(): string

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

Returns

string

---

getRoot()

getRoot(): WorkspaceItem

Defined in: obsidian.d.ts:4995

Returns

WorkspaceItem

---

off()

off(name, callback): void

Defined in: obsidian.d.ts:1441

Parameters

name

string

callback

(…data) => unknown

Returns

void

Inherited from

Events.off

---

offref()

offref(ref): void

Defined in: obsidian.d.ts:1445

Parameters

ref

EventRef

Returns

void

Inherited from

Events.offref

---

on()

on(name, callback, ctx?): EventRef

Defined in: obsidian.d.ts:1437

Parameters

name

string

callback

(…data) => unknown

ctx?

any

Returns

EventRef

Inherited from

Events.on

---

onResizeStart()

onResizeStart(evt): void

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

Parameters

evt

MouseEvent

Returns

void

---

serialize()

serialize(): SerializedWorkspaceItem

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

Returns

SerializedWorkspaceItem

---

setDimension()

setDimension(dimension): void

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

Parameters

dimension

null | number

Returns

void

---

setParent()

setParent(parent): void

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

Parameters

parent

WorkspaceParent

Returns

void

---

trigger()

trigger(name, …data): void

Defined in: obsidian.d.ts:1449

Parameters

name

string

data

…unknown[]

Returns

void

Inherited from

Events.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Defined in: obsidian.d.ts:1453

Parameters

evt

EventRef

args

unknown[]

Returns

void

Inherited from

Events.tryTrigger