WorkspaceSidedock

Defined in: obsidian.d.ts:5169

Extends

• WorkspaceSplit

Constructors

new WorkspaceSidedock()

new WorkspaceSidedock(): WorkspaceSidedock

Returns

WorkspaceSidedock

Inherited from

WorkspaceSplit.constructor

Properties

_

_: Record<string, EventsEntry[]>

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

Inherited from

WorkspaceSplit._

---

allowSingleChild

allowSingleChild: boolean

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

---

app

app: App

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

Inherited from

WorkspaceSplit.app

---

autoManageDOM

autoManageDOM: boolean

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

---

children

children: WorkspaceTabs[]

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

---

collapsed

collapsed: boolean

Defined in: obsidian.d.ts:5172

---

component

component: Component

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

Inherited from

WorkspaceSplit.component

---

containerEl

containerEl: HTMLDivElement

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

Inherited from

WorkspaceSplit.containerEl

---

dimension

dimension: null | number

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

Inherited from

WorkspaceSplit.dimension

---

direction

direction: string

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

---

emptyStateEl

emptyStateEl: HTMLDivElement

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

---

id

id: string

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

Inherited from

WorkspaceSplit.id

---

isResizing

isResizing: boolean

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

---

originalSizes

originalSizes: null

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

---

parent

parent: WorkspaceParent

Defined in: obsidian.d.ts:5188

Inherited from

WorkspaceSplit.parent

---

parentSplit?

readonly optional parentSplit: WorkspaceParent

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

Inherited from

WorkspaceSplit.parentSplit

---

resizeHandleEl

resizeHandleEl: HTMLHRElement

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

Inherited from

WorkspaceSplit.resizeHandleEl

---

resizeStartPos

resizeStartPos: null

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

---

side

side: string

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

---

size

size: number

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

---

type

type: string

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

Inherited from

WorkspaceSplit.type

---

workspace

workspace: Workspace

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

Inherited from

WorkspaceSplit.workspace

Methods

collapse()

collapse(): void

Defined in: obsidian.d.ts:5177

Returns

void

---

detach()

detach(): void

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

Returns

void

Inherited from

WorkspaceSplit.detach

---

expand()

expand(): void

Defined in: obsidian.d.ts:5179

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

Inherited from

WorkspaceSplit.getContainer

---

getIcon()

getIcon(): string

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

Returns

string

Inherited from

WorkspaceSplit.getIcon

---

getRoot()

getRoot(): WorkspaceItem

Defined in: obsidian.d.ts:4995

Returns

WorkspaceItem

Inherited from

WorkspaceSplit.getRoot

---

off()

off(name, callback): void

Defined in: obsidian.d.ts:1441

Parameters

name

string

callback

(…data) => unknown

Returns

void

Inherited from

WorkspaceSplit.off

---

offref()

offref(ref): void

Defined in: obsidian.d.ts:1445

Parameters

ref

EventRef

Returns

void

Inherited from

WorkspaceSplit.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

WorkspaceSplit.on

---

onResizeStart()

onResizeStart(evt): void

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

Parameters

evt

MouseEvent

Returns

void

Inherited from

WorkspaceSplit.onResizeStart

---

onSidedockResizeStart()

onSidedockResizeStart(evt): void

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

Parameters

evt

MouseEvent

Returns

void

---

recomputeChildrenDimensions()

recomputeChildrenDimensions(): void

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

Returns

void

---

serialize()

serialize(): SerializedWorkspaceSidedock

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

Returns

SerializedWorkspaceSidedock

Inherited from

WorkspaceSplit.serialize

---

setDimension()

setDimension(dimension): void

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

Parameters

dimension

null | number

Returns

void

Inherited from

WorkspaceSplit.setDimension

---

setParent()

setParent(parent): void

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

Parameters

parent

WorkspaceParent

Returns

void

Inherited from

WorkspaceSplit.setParent

---

setSize()

setSize(size): void

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

Parameters

size

number

Returns

void

---

toggle()

toggle(): void

Defined in: obsidian.d.ts:5175

Returns

void

---

trigger()

trigger(name, …data): void

Defined in: obsidian.d.ts:1449

Parameters

name

string

data

…unknown[]

Returns

void

Inherited from

WorkspaceSplit.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Defined in: obsidian.d.ts:1453

Parameters

evt

EventRef

args

unknown[]

Returns

void

Inherited from

WorkspaceSplit.tryTrigger