Interface: ISidebarService
services.ISidebarService
Hierarchy
Component\<ISidebar>↳
ISidebarService
Table of contents
Properties
Methods
Properties
state
• Protected Abstract state: ISidebar
Inherited from
Component.state
Defined in
Methods
add
▸ add(pane, isActive?): void
Add a new Sidebar pane
Parameters
| Name | Type | Description |
|---|---|---|
pane | ISidebarPane | |
isActive? | boolean | Whether to activate the current pane |
Returns
void
Defined in
src/services/workbench/sidebarService.ts:17
get
▸ get(id): undefined | ISidebarPane
Get a specific pane via id
Parameters
| Name | Type |
|---|---|
id | UniqueId |
Returns
undefined | ISidebarPane
Defined in
src/services/workbench/sidebarService.ts:11
remove
▸ remove(id): void
Remove a pane
Parameters
| Name | Type |
|---|---|
id | UniqueId |
Returns
void
Defined in
src/services/workbench/sidebarService.ts:27
reset
▸ reset(): void
Reset the sidebar data
Returns
void
Defined in
src/services/workbench/sidebarService.ts:36
setActive
▸ setActive(id?): void
Set the specific pane as active
Parameters
| Name | Type |
|---|---|
id? | UniqueId |
Returns
void
Defined in
src/services/workbench/sidebarService.ts:32
subscribe
▸ subscribe(name, listener): void
Subscribe the service event
Parameters
| Name | Type | Description |
|---|---|---|
name | string | string[] | Event name |
listener | Function | Listener function |
Returns
void
Inherited from
Component.subscribe
Defined in
src/common/event/eventBus.ts:11
unsubscribe
▸ unsubscribe(name, listener?): void
Unsubscribe the specific event and the listener function
Parameters
| Name | Type | Description |
|---|---|---|
name | any | The event name |
listener? | Function | optional, it unsubscribes events via name if not pass the listener function |
Returns
void
Inherited from
Component.unsubscribe
Defined in
src/common/event/eventBus.ts:39
update
▸ update(pane): void
Update a specific pane
Parameters
| Name | Type |
|---|---|
pane | ISidebarPane |
Returns
void