Interface: IPanelService

molecule.IPanelService

Hierarchy

• Component<IPanel>

  ↳ IPanelService

Implemented by

• PanelService

Properties

outputEditorInstance

• Readonly outputEditorInstance: undefined | IStandaloneCodeEditor

The editorInstance of Output

Defined in

src/services/workbench/panelService.ts:25

---

state

• Protected Abstract state: IPanel

Inherited from

Component.state

Defined in

src/react/component.ts:42

Methods

add

▸ add(data): void

Add new Panel items

Parameters

Name	Type
data	IPanelItem<any> | IPanelItem<any>[]

Returns

void

Defined in

src/services/workbench/panelService.ts:50

---

appendOutput

▸ appendOutput(content): void

Append the content into Output panel

Parameters

Name	Type
content	string

Returns

void

Defined in

src/services/workbench/panelService.ts:97

---

cleanOutput

▸ cleanOutput(): void

Clean the Output content

Returns

void

Defined in

src/services/workbench/panelService.ts:101

---

count

▸ count(name): number

Count the service event

Parameters

Name	Type	Description
name	string	Event name

Returns

number

Inherited from

Component.count

Defined in

src/common/event/eventBus.ts:28

---

emit

▸ emit(name, ...args): void

Emit the service event

Parameters

Name	Type	Description
name	string	Event name
...args	any	Arguments

Returns

void

Inherited from

Component.emit

Defined in

src/common/event/eventBus.ts:20

---

forceUpdate

▸ forceUpdate(): void

Force to update the Component

Returns

void

Inherited from

Component.forceUpdate

Defined in

src/react/component.ts:79

---

getOutputValue

▸ getOutputValue(): string

Get the value of Output Panel

Returns

string

Defined in

src/services/workbench/panelService.ts:92

---

getPanel

▸ getPanel(id): undefined | IPanelItem<any>

Get the specific panel

Parameters

Name	Type
id	UniqueId

Returns

undefined | IPanelItem<any>

Defined in

src/services/workbench/panelService.ts:45

---

getState

▸ getState(): IPanel

Get the Component state

Returns

IPanel

Inherited from

Component.getState

Defined in

src/react/component.ts:83

---

onTabChange

▸ onTabChange(callback): void

Listen to the Panel tabs onChange event

Parameters

Name	Type
callback	(panelId: UniqueId) => void

Returns

void

Defined in

src/services/workbench/panelService.ts:76

---

onTabClose

▸ onTabClose(callback): void

Listen to the Panel tabs close event

Parameters

Name	Type
callback	(panelId: UniqueId) => void

Returns

void

Defined in

src/services/workbench/panelService.ts:88

---

onToolbarClick

▸ onToolbarClick(callback): void

Listen to the Panel toolbar click event

Parameters

Name	Type
callback	(e: MouseEvent<Element, MouseEvent>, item: IActionBarItemProps<any>) => void

Returns

void

Defined in

src/services/workbench/panelService.ts:81

---

onUpdateState

▸ onUpdateState(callback): void

Listen to the Component state update event

Parameters

Name	Type
callback	(prevState: IPanel, nextState: IPanel) => void

Returns

void

Inherited from

Component.onUpdateState

Defined in

src/react/component.ts:71

---

open

▸ open(panel): void

Open a new or existing panel item as the active in Panel view

Parameters

Name	Type
panel	IPanelItem<any>

Returns

void

Defined in

src/services/workbench/panelService.ts:40

---

remove

▸ remove(id): undefined | IPanelItem<any>

Remove the specific panel

Parameters

Name	Type
id	UniqueId

Returns

undefined | IPanelItem<any>

Defined in

src/services/workbench/panelService.ts:67

---

removeOnUpdateState

▸ removeOnUpdateState(): void

Remove the Component update event listening

Returns

void

Inherited from

Component.removeOnUpdateState

Defined in

src/react/component.ts:75

---

render

▸ render(nextState?): void

Initiative notify the component to render the view by the state

Parameters

Name	Type
nextState?	IPanel

Returns

void

Inherited from

Component.render

Defined in

src/react/component.ts:67

---

reset

▸ reset(): void

Reset data in state

Returns

void

Defined in

src/services/workbench/panelService.ts:105

---

setActive

▸ setActive(id): void

Set the current active panel

This method will log error when couldn't find target panel in state data. So if you want to add a panel and meanwhile active it, please use the open method

Parameters

Name	Type	Description
id	UniqueId	target panel id

Returns

void

Defined in

src/services/workbench/panelService.ts:35

---

setState

▸ setState(values, callback?): void

Set the state values, and notify the view component to re render

Parameters

Name	Type	Description
values	Partial<IPanel>	update target state values
callback?	(prevState: IPanel, nextState: IPanel) => void	-

Returns

void

Inherited from

Component.setState

Defined in

src/react/component.ts:54

---

subscribe

▸ subscribe(name, callback): void

Subscribe the service event

Parameters

Name	Type	Description
name	string | string[]	Event name
callback	Function	Callback function

Returns

void

Inherited from

Component.subscribe

Defined in

src/common/event/eventBus.ts:11

---

toggleMaximize

▸ toggleMaximize(): void

Toggle the panel between maximized or normal

Returns

void

Defined in

src/services/workbench/panelService.ts:71

---

unsubscribe

▸ unsubscribe(name): void

Unsubscribe the specific event

Parameters

Name	Type	Description
name	any	The event name

Returns

void

Inherited from

Component.unsubscribe

Defined in

src/common/event/eventBus.ts:37

---

update

▸ update(panel): undefined | IPanelItem<any>

Update the specific panel

Parameters

Name	Type	Description
panel	IPanelItem<any>	the id field is required

Returns

undefined | IPanelItem<any>

Defined in

src/services/workbench/panelService.ts:55

---

updateOutput

▸ updateOutput(panel): undefined | IPanelItem<any>

Update the Output panel, except the value

If you want to update the value of this panel, please use the appendOutput method

Parameters

Name	Type
panel	IPanelItem<any>

Returns

undefined | IPanelItem<any>

Defined in

src/services/workbench/panelService.ts:62