WorkspaceRoot

Extends

• WorkspaceContainer

Constructors

new WorkspaceRoot()

new WorkspaceRoot(): WorkspaceRoot

Returns

WorkspaceRoot

Inherited from

WorkspaceContainer.constructor

Properties

_

_: Record<string, EventsEntry[]>

Inherited from

WorkspaceContainer._

---

app

app: App

Inherited from

WorkspaceContainer.app

---

component

component: Component

Inherited from

WorkspaceContainer.component

---

containerEl

containerEl: HTMLDivElement

Inherited from

WorkspaceContainer.containerEl

---

dimension

dimension: null | number

Inherited from

WorkspaceContainer.dimension

---

doc

doc: Document

Overrides

WorkspaceContainer.doc

---

id

id: string

Inherited from

WorkspaceContainer.id

---

parent

parent: WorkspaceParent

Inherited from

WorkspaceContainer.parent

---

parentSplit?

readonly optional parentSplit: WorkspaceParent

Inherited from

WorkspaceContainer.parentSplit

---

resizeHandleEl

resizeHandleEl: HTMLHRElement

Inherited from

WorkspaceContainer.resizeHandleEl

---

type

type: string

Inherited from

WorkspaceContainer.type

---

win

win: Window

Overrides

WorkspaceContainer.win

---

workspace

workspace: Workspace

Inherited from

WorkspaceContainer.workspace

Methods

detach()

detach(): void

Returns

void

Inherited from

WorkspaceContainer.detach

---

getContainer()

getContainer(): WorkspaceContainer

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

• WorkspaceRoot
• WorkspaceWindow

Returns

WorkspaceContainer

Inherited from

WorkspaceContainer.getContainer

---

getIcon()

getIcon(): string

Returns

string

Inherited from

WorkspaceContainer.getIcon

---

getRoot()

getRoot(): WorkspaceItem

Returns

WorkspaceItem

Inherited from

WorkspaceContainer.getRoot

---

off()

off(name, callback): void

Parameters

• name: string

• callback

Returns

void

Inherited from

WorkspaceContainer.off

---

offref()

offref(ref): void

Parameters

• ref: EventRef

Returns

void

Inherited from

WorkspaceContainer.offref

---

on()

on(name, callback, ctx?): EventRef

Parameters

• name: string

• callback

• ctx?: any

Returns

EventRef

Inherited from

WorkspaceContainer.on

---

onResizeStart()

onResizeStart(evt): void

Parameters

• evt: MouseEvent

Returns

void

Inherited from

WorkspaceContainer.onResizeStart

---

serialize()

serialize(): SerializedWorkspaceItem

Returns

SerializedWorkspaceItem

Inherited from

WorkspaceContainer.serialize

---

setDimension()

setDimension(dimension): void

Parameters

• dimension: null | number

Returns

void

Inherited from

WorkspaceContainer.setDimension

---

setParent()

setParent(parent): void

Parameters

• parent: WorkspaceParent

Returns

void

Inherited from

WorkspaceContainer.setParent

---

trigger()

trigger(name, …data): void

Parameters

• name: string

• …data: unknown[]

Returns

void

Inherited from

WorkspaceContainer.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Parameters

• evt: EventRef

• args: unknown[]

Returns

void

Inherited from

WorkspaceContainer.tryTrigger