Interface: IStatusBarService
services.IStatusBarService
Hierarchy
Component\<IStatusBar>↳
IStatusBarService
Table of contents
Properties
Methods
Properties
state
• Protected Abstract state: IStatusBar
Inherited from
Component.state
Defined in
Methods
add
▸ add(item, float): void
Add a new StatusBar item into right or left status
Parameters
| Name | Type | Description |
|---|---|---|
item | IStatusBarItem\<any> | |
float | Float | position the item to left or right |
Returns
void
Defined in
src/services/workbench/statusBarService.ts:16
getStatusBarItem
▸ getStatusBarItem(id, float?): null | IStatusBarItem\<any>
Get the specific StatusBar item
Parameters
| Name | Type |
|---|---|
id | UniqueId |
float? | Float |
Returns
null | IStatusBarItem\<any>
Defined in
src/services/workbench/statusBarService.ts:33
onClick
▸ onClick(callback): any
Listen to the StatusBar click event
Parameters
| Name | Type |
|---|---|
callback | (e: MouseEvent, item: IStatusBarItem\<any>) => void |
Returns
any
Defined in
src/services/workbench/statusBarService.ts:42
remove
▸ remove(id, float?): void
Remove the specific StatusBar item
Parameters
| Name | Type | Description |
|---|---|---|
id | UniqueId | |
float? | Float | if provided, it'll remove the item in spcific position |
Returns
void
Defined in
src/services/workbench/statusBarService.ts:22
reset
▸ reset(): void
Reset the contextMenu data and the StatusBar data , including right and left
Returns
void
Defined in
src/services/workbench/statusBarService.ts:37
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(item, float?): void
Update the specific StatusBar item, it'll update the item found in left
Parameters
| Name | Type | Description |
|---|---|---|
item | IStatusBarItem\<any> | the id field is required |
float? | Float | if provided, it'll update the item in specific position |
Returns
void