WorkspaceSidebarGroup
Class: WorkspaceSidebarGroup
Section titled “Class: WorkspaceSidebarGroup”Defined in: workspace.svelte.ts:779
Sidebar-only container that groups leaves into a named view container.
Extends
Section titled “Extends”WorkspaceParent
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorkspaceSidebarGroup(
options?):WorkspaceSidebarGroup
Defined in: workspace.svelte.ts:789
Parameters
Section titled “Parameters”options?
Section titled “options?”SidebarGroupOptions = {}
Returns
Section titled “Returns”WorkspaceSidebarGroup
Overrides
Section titled “Overrides”WorkspaceParent.constructor
Properties
Section titled “Properties”_root:
WorkspaceItem<EventMap<T>> |undefined=undefined
Defined in: workspace.svelte.ts:108
Inherited from
Section titled “Inherited from”WorkspaceParent._root
children
Section titled “children”children:
WorkspaceLeaf[]
Defined in: workspace.svelte.ts:787
collapsed
Section titled “collapsed”collapsed:
Record<string,boolean>
Defined in: workspace.svelte.ts:785
hiddenLeafIds
Section titled “hiddenLeafIds”hiddenLeafIds:
string[]
Defined in: workspace.svelte.ts:784
icon:
string|undefined
Defined in: workspace.svelte.ts:783
id:
string
Defined in: workspace.svelte.ts:102
Inherited from
Section titled “Inherited from”WorkspaceParent.id
name:
string
Defined in: workspace.svelte.ts:782
panelSizes
Section titled “panelSizes”panelSizes:
Record<string,number>
Defined in: workspace.svelte.ts:786
parent
Section titled “parent”parent:
WorkspaceTabs
Defined in: workspace.svelte.ts:780
Overrides
Section titled “Overrides”WorkspaceParent.parent
Methods
Section titled “Methods”addChild()
Section titled “addChild()”addChild(
child,index?):void
Defined in: workspace.svelte.ts:805
Parameters
Section titled “Parameters”index?
Section titled “index?”number
Returns
Section titled “Returns”void
detach()
Section titled “detach()”detach(
softDelete?):WorkspaceTabsChild|undefined
Defined in: workspace.svelte.ts:801
Parameters
Section titled “Parameters”softDelete?
Section titled “softDelete?”boolean = false
Returns
Section titled “Returns”WorkspaceTabsChild | undefined
dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”WorkspaceParent.dispatch
emit()
Section titled “emit()”emit<
T>(eventName, …args):boolean
Defined in: events.ts:98
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”WorkspaceParent.emit
getLeafPanelSize()
Section titled “getLeafPanelSize()”getLeafPanelSize(
leaf):number|undefined
Defined in: workspace.svelte.ts:892
Parameters
Section titled “Parameters”string | WorkspaceLeaf
Returns
Section titled “Returns”number | undefined
getRoot()
Section titled “getRoot()”getRoot():
WorkspaceItem
Defined in: workspace.svelte.ts:109
Returns
Section titled “Returns”WorkspaceItem
Inherited from
Section titled “Inherited from”WorkspaceParent.getRoot
getSelectedLeaf()
Section titled “getSelectedLeaf()”getSelectedLeaf():
WorkspaceLeaf|null
Defined in: workspace.svelte.ts:851
Returns
Section titled “Returns”WorkspaceLeaf | null
isLeafCollapsed()
Section titled “isLeafCollapsed()”isLeafCollapsed(
leaf):boolean
Defined in: workspace.svelte.ts:881
Parameters
Section titled “Parameters”string | WorkspaceLeaf
Returns
Section titled “Returns”boolean
isLeafHidden()
Section titled “isLeafHidden()”isLeafHidden(
leaf):boolean
Defined in: workspace.svelte.ts:864
Parameters
Section titled “Parameters”string | WorkspaceLeaf
Returns
Section titled “Returns”boolean
iterateAllLeaves()
Section titled “iterateAllLeaves()”iterateAllLeaves<
T>(callback):void|T
Defined in: workspace.svelte.ts:855
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”callback
Section titled “callback”(leaf) => T
Returns
Section titled “Returns”void | T
loadJson()
Section titled “loadJson()”loadJson(
layout):Promise<void>
Defined in: workspace.svelte.ts:918
Parameters
Section titled “Parameters”layout
Section titled “layout”WorkspaceSidebarGroupJson
Returns
Section titled “Returns”Promise<void>
off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”WorkspaceParent.off
offref()
Section titled “offref()”offref<
T>(ref):void
Defined in: events.ts:87
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”EventRef<EventMap<T>, T>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”WorkspaceParent.offref
on<
T>(eventName,listener,context?):EventRef<EventMap<T>,T,any>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<EventMap<T>, T, any>
Inherited from
Section titled “Inherited from”WorkspaceParent.on
once()
Section titled “once()”once<
T>(eventName,listener,context?):EventRef<EventMap<T>,T,any>
Defined in: events.ts:63
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<EventMap<T>, T, any>
Inherited from
Section titled “Inherited from”WorkspaceParent.once
removeChild()
Section titled “removeChild()”removeChild(
index,softDelete?):WorkspaceLeaf|undefined
Defined in: workspace.svelte.ts:822
Parameters
Section titled “Parameters”number | WorkspaceLeaf
softDelete?
Section titled “softDelete?”boolean = false
Returns
Section titled “Returns”WorkspaceLeaf | undefined
setLeafCollapsed()
Section titled “setLeafCollapsed()”setLeafCollapsed(
leaf,collapsed):void
Defined in: workspace.svelte.ts:886
Parameters
Section titled “Parameters”string | WorkspaceLeaf
collapsed
Section titled “collapsed”boolean
Returns
Section titled “Returns”void
setLeafHidden()
Section titled “setLeafHidden()”setLeafHidden(
leaf,hidden):void
Defined in: workspace.svelte.ts:869
Parameters
Section titled “Parameters”string | WorkspaceLeaf
hidden
Section titled “hidden”boolean
Returns
Section titled “Returns”void
setPanelSizes()
Section titled “setPanelSizes()”setPanelSizes(
leaves,sizes):void
Defined in: workspace.svelte.ts:897
Parameters
Section titled “Parameters”leaves
Section titled “leaves”number[]
Returns
Section titled “Returns”void
toJson()
Section titled “toJson()”toJson():
WorkspaceSidebarGroupJson
Defined in: workspace.svelte.ts:937
Returns
Section titled “Returns”WorkspaceSidebarGroupJson
trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”WorkspaceParent.trigger
tryTrigger()
Section titled “tryTrigger()”tryTrigger<
T>(evt, …args):void
Defined in: events.ts:112
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”EventRef<EventMap<T>, T>
…any[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”WorkspaceParent.tryTrigger