WorkspaceTabs
Defined in: obsidian.d.ts:5282
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorkspaceTabs():
WorkspaceTabs
Returns
Section titled “Returns”WorkspaceTabs
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”_:
Record<string,EventsEntry[]>
Defined in: src/obsidian/augmentations/Events.d.ts:12
Inherited from
Section titled “Inherited from”app:
App
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:12
Inherited from
Section titled “Inherited from”component
Section titled “component”component:
Component
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:18
Inherited from
Section titled “Inherited from”containerEl
Section titled “containerEl”containerEl:
HTMLDivElement
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:24
Inherited from
Section titled “Inherited from”dimension
Section titled “dimension”dimension:
null|number
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:30
Inherited from
Section titled “Inherited from”id:
string
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:36
Inherited from
Section titled “Inherited from”parent
Section titled “parent”parent:
WorkspaceSplit
Defined in: obsidian.d.ts:5285
Inherited from
Section titled “Inherited from”parent__
Section titled “parent__”parent__:
WorkspaceParent
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:44
The direct parent of the leaf.
Inherited from
Section titled “Inherited from”resizeHandleEl
Section titled “resizeHandleEl”resizeHandleEl:
HTMLHRElement
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:50
Inherited from
Section titled “Inherited from”WorkspaceParent.resizeHandleEl
type:
string
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:56
Inherited from
Section titled “Inherited from”workspace
Section titled “workspace”workspace:
Workspace
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:62
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”detach()
Section titled “detach()”detach():
void
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:68
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getContainer()
Section titled “getContainer()”Call Signature
Section titled “Call Signature”getContainer():
WorkspaceContainer
Defined in: obsidian.d.ts:5087
Get the root container parent item, which can be one of:
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getContainer():
WorkspaceContainer
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:77
Get the root container parent item, which can be one of:.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”getIcon()
Section titled “getIcon()”getIcon():
string
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:83
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getRoot()
Section titled “getRoot()”Call Signature
Section titled “Call Signature”getRoot():
WorkspaceItem
Defined in: obsidian.d.ts:5080
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getRoot():
WorkspaceItem
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:90
Get the root item.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”off(
name,callback):void
Defined in: obsidian.d.ts:1480
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(…data) => unknown
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”off(
name,callback):void
Defined in: src/obsidian/augmentations/Events.d.ts:25
Remove an event listener.
Parameters
Section titled “Parameters”string
The name of the event.
callback
Section titled “callback”(…data) => unknown
The callback to remove.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.off('my-event', myListener);Inherited from
Section titled “Inherited from”offref()
Section titled “offref()”Call Signature
Section titled “Call Signature”offref(
ref):void
Defined in: obsidian.d.ts:1484
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”offref(
ref):void
Defined in: src/obsidian/augmentations/Events.d.ts:37
Remove an event listener by reference.
Parameters
Section titled “Parameters”The reference to the event listener.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.offref(myRef);Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”on(
name,callback,ctx?):EventRef
Defined in: obsidian.d.ts:1476
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(…data) => unknown
any
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”on(
name,callback,ctx?):EventRef
Defined in: src/obsidian/augmentations/Events.d.ts:54
Add an event listener.
Parameters
Section titled “Parameters”string
The name of the event.
callback
Section titled “callback”(…data) => unknown
The callback to call when the event is triggered.
any
The context passed as this to the callback.
Returns
Section titled “Returns”A reference to the event listener.
Example
Section titled “Example”events.on('my-event', (arg1, arg2) => { console.log(arg1, arg2);});Inherited from
Section titled “Inherited from”onResizeStart()
Section titled “onResizeStart()”onResizeStart(
evt):void
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:96
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”serialize()
Section titled “serialize()”serialize():
SerializedWorkspaceItem
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:102
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”setDimension()
Section titled “setDimension()”setDimension(
dimension):void
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:108
Parameters
Section titled “Parameters”dimension
Section titled “dimension”null | number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setParent()
Section titled “setParent()”setParent(
parent):void
Defined in: src/obsidian/augmentations/WorkspaceItem.d.ts:114
Parameters
Section titled “Parameters”parent
Section titled “parent”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”trigger()
Section titled “trigger()”Call Signature
Section titled “Call Signature”trigger(
name, …data):void
Defined in: obsidian.d.ts:1488
Parameters
Section titled “Parameters”string
…unknown[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”trigger(
name, …data):void
Defined in: src/obsidian/augmentations/Events.d.ts:67
Trigger an event, executing all the listeners in order even if some of them throw an error.
Parameters
Section titled “Parameters”string
The name of the event.
…unknown[]
The data to pass to the event listeners.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.trigger('my-event', 'arg1', 'arg2');Inherited from
Section titled “Inherited from”tryTrigger()
Section titled “tryTrigger()”Call Signature
Section titled “Call Signature”tryTrigger(
evt,args):void
Defined in: obsidian.d.ts:1492
Parameters
Section titled “Parameters”unknown[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”tryTrigger(
evt,args):void
Defined in: src/obsidian/augmentations/Events.d.ts:80
Try to trigger an event, executing all the listeners in order even if some of them throw an error.
Parameters
Section titled “Parameters”The event reference.
unknown[]
The data to pass to the event listeners.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.tryTrigger(myRef, ['arg1', 'arg2']);