Skip to main content
Version: v26

IWidgetbarApi

Interface

Widget Bar API

Methods

changeWidgetBarVisibility

Change the visibility of the right toolbar

Signature

changeWidgetBarVisibility(visible: boolean) => void

Parameters

NameTypeDescription
visiblebooleantrue to display the toolbar, false to hide

Returns

void


closeOrderPanel

Close order panel widget

Signature

closeOrderPanel() => void

Returns

void


destroy

Clean up (destroy) any subscriptions, intervals, or other resources that this IDestroyable instance has.

Signature

destroy() => void

Returns

void


hidePage

Hide page

Signature

hidePage(pageName: PageName) => void

Parameters

NameTypeDescription
pageNamePageNamename of page to hide

Returns

void


isPageVisible

Checks if page is visible

Signature

isPageVisible(pageName: PageName) => boolean

Parameters

NameTypeDescription
pageNamePageNamepage to check if visible

Returns

true` when page is visible

boolean


openOrderPanel

Open order panel widget

Signature

openOrderPanel() => void

Returns

void


showPage

Show page

Signature

showPage(pageName: PageName) => void

Parameters

NameTypeDescription
pageNamePageNamename of page to show

Returns

void