Skip to main content
Version: Next

Class: SidebarService

molecule.SidebarService

Hierarchy

Implements

Constructors

constructor

new SidebarService()

Overrides

Component.constructor

Defined in

services/workbench/sidebarService.ts:54

Properties

state

Protected state: ISidebar

Implementation of

ISidebarService.state

Overrides

Component.state

Defined in

services/workbench/sidebarService.ts:52

Methods

add

add(data, isActive?): void

Add a new Sidebar pane

Parameters

NameTypeDefault value
dataISidebarPaneundefined
isActivebooleanfalse

Returns

void

Implementation of

ISidebarService.add

Defined in

services/workbench/sidebarService.ts:70


count

count(name): number

Count the service event

Parameters

NameTypeDescription
namestringEvent name

Returns

number

Implementation of

ISidebarService.count

Inherited from

Component.count

Defined in

common/event/eventBus.ts:28


emit

emit(name, ...args): void

Emit the service event

Parameters

NameTypeDescription
namestringEvent name
...argsanyArguments

Returns

void

Implementation of

ISidebarService.emit

Inherited from

Component.emit

Defined in

common/event/eventBus.ts:20


forceUpdate

forceUpdate(): void

Force to update the Component

Returns

void

Implementation of

ISidebarService.forceUpdate

Inherited from

Component.forceUpdate

Defined in

react/component.ts:81


get

get(id): undefined | ISidebarPane

Get a specific pane via id

Parameters

NameType
idUniqueId

Returns

undefined | ISidebarPane

Implementation of

ISidebarService.get

Defined in

services/workbench/sidebarService.ts:65


getPane

Private getPane(id): undefined | ISidebarPane

Parameters

NameType
idUniqueId

Returns

undefined | ISidebarPane

Defined in

services/workbench/sidebarService.ts:59


getState

getState(): ISidebar

Get the Component state

Returns

ISidebar

Implementation of

ISidebarService.getState

Inherited from

Component.getState

Defined in

react/component.ts:85


onUpdateState

onUpdateState(listener): void

Listen to the Component state update event

Parameters

NameType
listener(prevState: ISidebar, nextState: ISidebar) => void

Returns

void

Implementation of

ISidebarService.onUpdateState

Inherited from

Component.onUpdateState

Defined in

react/component.ts:73


remove

remove(id): void

Remove a pane

Parameters

NameType
idUniqueId

Returns

void

Implementation of

ISidebarService.remove

Defined in

services/workbench/sidebarService.ts:105


removeOnUpdateState

removeOnUpdateState(listener?): void

Remove the Component update event listening, default is remove all, also you can remove one by pass the listener

Parameters

NameType
listener?Function

Returns

void

Implementation of

ISidebarService.removeOnUpdateState

Inherited from

Component.removeOnUpdateState

Defined in

react/component.ts:77


render

render(nextState?): void

Initiative notify the component to render the view by the state

Parameters

NameType
nextState?ISidebar

Returns

void

Implementation of

ISidebarService.render

Inherited from

Component.render

Defined in

react/component.ts:69


reset

reset(): void

Reset the sidebar data

Returns

void

Implementation of

ISidebarService.reset

Defined in

services/workbench/sidebarService.ts:143


setActive

setActive(id?): void

Set the specific pane as active

Parameters

NameType
id?UniqueId

Returns

void

Implementation of

ISidebarService.setActive

Defined in

services/workbench/sidebarService.ts:126


setState

setState(values, callback?): void

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

Parameters

NameTypeDescription
valuesPartial<ISidebar>update target state values
callback?(prevState: ISidebar, nextState: ISidebar) => void-

Returns

void

Implementation of

ISidebarService.setState

Inherited from

Component.setState

Defined in

react/component.ts:56


subscribe

subscribe(name, listener): void

Subscribe the service event

Parameters

NameTypeDescription
namestring | string[]Event name
listenerFunctionListener function

Returns

void

Implementation of

ISidebarService.subscribe

Inherited from

Component.subscribe

Defined in

common/event/eventBus.ts:11


unsubscribe

unsubscribe(name, listener?): void

Unsubscribe the specific event and the listener function

Parameters

NameTypeDescription
nameanyThe event name
listener?Functionoptional, it unsubscribes events via name if not pass the listener function

Returns

void

Implementation of

ISidebarService.unsubscribe

Inherited from

Component.unsubscribe

Defined in

common/event/eventBus.ts:37


update

update(pane): void

Update a specific pane

Parameters

NameType
paneISidebarPane

Returns

void

Implementation of

ISidebarService.update

Defined in

services/workbench/sidebarService.ts:91