WorkspaceSidedock

Extends

• WorkspaceSplit

Constructors

new WorkspaceSidedock()

new WorkspaceSidedock(): WorkspaceSidedock

Returns

WorkspaceSidedock

Inherited from

WorkspaceSplit.constructor

Properties

_

_: Record<string, EventsEntry[]>

Inherited from

WorkspaceSplit._

---

allowSingleChild

allowSingleChild: boolean

---

app

app: App

Inherited from

WorkspaceSplit.app

---

autoManageDOM

autoManageDOM: boolean

---

children

children: WorkspaceTabs[]

---

collapsed

collapsed: boolean

---

component

component: Component

Inherited from

WorkspaceSplit.component

---

containerEl

containerEl: HTMLDivElement

Inherited from

WorkspaceSplit.containerEl

---

dimension

dimension: null | number

Inherited from

WorkspaceSplit.dimension

---

direction

direction: string

---

emptyStateEl

emptyStateEl: HTMLDivElement

---

id

id: string

Inherited from

WorkspaceSplit.id

---

isResizing

isResizing: boolean

---

originalSizes

originalSizes: null

---

parent

parent: WorkspaceParent

Inherited from

WorkspaceSplit.parent

---

parentSplit?

readonly optional parentSplit: WorkspaceParent

Inherited from

WorkspaceSplit.parentSplit

---

resizeHandleEl

resizeHandleEl: HTMLHRElement

Inherited from

WorkspaceSplit.resizeHandleEl

---

resizeStartPos

resizeStartPos: null

---

side

side: string

---

size

size: number

---

type

type: string

Inherited from

WorkspaceSplit.type

---

workspace

workspace: Workspace

Inherited from

WorkspaceSplit.workspace

Methods

collapse()

collapse(): void

Returns

void

---

detach()

detach(): void

Returns

void

Inherited from

WorkspaceSplit.detach

---

expand()

expand(): void

Returns

void

---

getContainer()

getContainer(): WorkspaceContainer

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

• WorkspaceRoot
• WorkspaceWindow

Returns

WorkspaceContainer

Inherited from

WorkspaceSplit.getContainer

---

getIcon()

getIcon(): string

Returns

string

Inherited from

WorkspaceSplit.getIcon

---

getRoot()

getRoot(): WorkspaceItem

Returns

WorkspaceItem

Inherited from

WorkspaceSplit.getRoot

---

off()

off(name, callback): void

Parameters

• name: string

• callback

Returns

void

Inherited from

WorkspaceSplit.off

---

offref()

offref(ref): void

Parameters

• ref: EventRef

Returns

void

Inherited from

WorkspaceSplit.offref

---

on()

on(name, callback, ctx?): EventRef

Parameters

• name: string

• callback

• ctx?: any

Returns

EventRef

Inherited from

WorkspaceSplit.on

---

onResizeStart()

onResizeStart(evt): void

Parameters

• evt: MouseEvent

Returns

void

Inherited from

WorkspaceSplit.onResizeStart

---

onSidedockResizeStart()

onSidedockResizeStart(evt): void

Parameters

• evt: MouseEvent

Returns

void

---

recomputeChildrenDimensions()

recomputeChildrenDimensions(): void

Returns

void

---

serialize()

serialize(): SerializedWorkspaceSidedock

Returns

SerializedWorkspaceSidedock

Inherited from

WorkspaceSplit.serialize

---

setDimension()

setDimension(dimension): void

Parameters

• dimension: null | number

Returns

void

Inherited from

WorkspaceSplit.setDimension

---

setParent()

setParent(parent): void

Parameters

• parent: WorkspaceParent

Returns

void

Inherited from

WorkspaceSplit.setParent

---

setSize()

setSize(size): void

Parameters

• size: number

Returns

void

---

toggle()

toggle(): void

Returns

void

---

trigger()

trigger(name, …data): void

Parameters

• name: string

• …data: unknown[]

Returns

void

Inherited from

WorkspaceSplit.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Parameters

• evt: EventRef

• args: unknown[]

Returns

void

Inherited from

WorkspaceSplit.tryTrigger