Controller

Login controller

new Controller()

Type: LoginController

UserScript

new UserScript($0: Object)

Type: UserScript

Extends MVC.Model

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 4/30/18

Parameters

$0 (Object)

Name	Description
$0.id any
$0.code any

Properties

name (string)

code (string)

func (function)

execute

execute(context: any): Promise<any>

Parameters

context (any)

Returns

Promise<any>:

bottom_toolbar

Extends webix.ui.toolbar

bottom_toolbar

Properties

name (String)

Static Members

▸ switchLogBtnIcon(type)

switchLogBtnIcon(type: any)

Parameters

type (any)

newBottomToolbar

newBottomToolbar(root: any)

Parameters

root (any)

logger

Extends webix.ui.list

logger

Properties

name (String)

Instance Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

▸ log(item)

log(item: any)

Parameters

item (any)

ScriptingConsole

ScriptingConsole

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 4/30/18

Static Members

▸ upper_toolbar

upper_toolbar

Static Members

▸ onBindApply(script)

Event listener.

onBindApply(script: any)

Parameters

script (any)

▸ onBindRequest()

Event listener. Work-around [object Object] in this field.

onBindRequest()

▸ script_code

script_code

▸ scripts_list

scripts_list

▸ output

output

▸ scripting_console

Extends webix.ui.layout

scripting_console

Properties

name (String)

Static Members

▸ save()

save(): UserScript

Returns

UserScript:

▸ remove()

remove(): UserScript

Returns

UserScript:

▸ execute()

execute()

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

onAfterSelect

Fires event:item_selected

onAfterSelect(id: string)

Parameters

id (string)

$init

$init(config: any)

Parameters

config (any)

DeviceViewPanel

This module contains two panels related to tango device: info panel and control panel.

Info panel is responsible for displaying device's info as datatable and commands, attributes and pipes as lists

Control panel executes commands; reads, writes attributes and pipes

DeviceViewPanel

Static Members

▸ DevicePanelAttributes

Extends webix.ui.form

DevicePanelAttributes

Type: protoUI

Extends webix.ui.form

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

Properties

attr (TangoAttribute) : -- set in TODO method link onBindApply

info (kAttr_info_datatable)

Static Members

▸ setAttribute(attr)

setAttribute(attr: TangoAttribute)

Parameters

attr (TangoAttribute)

▸ $init(config)

$init(config: any)

Parameters

config (any)

▸ DevicePanelCommands

Extends webix.ui.form

DevicePanelCommands

Type: protoUI

Extends webix.ui.form

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

Properties

command (TangoCommand)

info (commands_info_datatable)

Static Members

▸ setCommand(command)

setCommand(command: TangoCommand)

Parameters

command (TangoCommand)

▸ $init(config)

$init(config: any)

Parameters

config (any)

▸ device_tree_list

More info: webix.ui.list

device_tree_list

Type: protoUI

Extends webix.ui.list

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

▸ device_info_panel

See webix.ui.layout

device_info_panel

Type: protoUI

Extends webix.ui.layout

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

Properties

info (info_datatable)

commands (DeviceTreeList)

attrs (DeviceTreeList)

pipes (DeviceTreeList)

Related

webix.ui.layout

▸ info_panel_empty

More info: webix.ui.view

info_panel_empty

Type: protoUI

Extends webix.ui.view

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

▸ info_control_panel

See webix.ui.layout

info_control_panel

Type: protoUI

Extends webix.ui.layout

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

Properties

commands (DevicePanelCommands)

attrs (DevicePanelAttributes)

pipes (DevicePanelPipes)

Related

webix.ui.layout

▸ DevicePanelPipes

Extends webix.ui.form

DevicePanelPipes

Type: protoUI

Extends webix.ui.form

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 9/10/18

Properties

pipe (TangoPipe)

Static Members

▸ setPipe(pipe)

setPipe(pipe: TangoPipe)

Parameters

pipe (TangoPipe)

▸ $init(config)

$init(config: any)

Parameters

config (any)

▸ kInfoControlPanelHeaderIcon

kInfoControlPanelHeaderIcon

Type: string

run

run()

$init

new $init(config: any)

Parameters

config (any)

$drop

$drop()

Related

onBeforeDrop

AttrsMonitorView

AttrsMonitorView

Static Members

▸ newScalarSettings(config)

newScalarSettings(config: any): webix.config

Parameters

config (any)

Returns

webix.config: form

▸ scalars

Extends webix.ui.datatable

scalars

Properties

name (string)

Static Members

▸ onAfterSelect(id)

Fires event:item_selected

onAfterSelect(id: any)

Parameters

id (any)

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

▸ newScalars(config)

newScalars(config: any)

Parameters

config (any)

▸ attrs_monitor

Extends webix.ui.layout

attrs_monitor

Properties

name (string)

addTrace

addTrace(trace: any, x: [], y: [], ndx: int)

Parameters

trace (any) name

x ([]) timestamps

y ([]) values

ndx (int)

addTraces

addTraces(traces: Array<string>, x: [], y: [])

Parameters

traces (Array<string>) names

x ([]) timestamps

y ([]) values

deleteTrace

deleteTrace(ndx: int)

Parameters

ndx (int) same as used in addTrace

updateTraces

updateTraces(traces: [], times: [], data: [])

Parameters

traces ([]) an array of traces indices

times ([])

data ([]) an array of data arrays

update

Updates this plot with single data item

update(data: {timestamp: int, value: data})

Parameters

data ({timestamp: int, value: data})

updateMulti

Updates this plot with multiple data items

updateMulti(data: [{timestamp: int, value: data}])

Parameters

data ([{timestamp: int, value: data}])

clearAll

clearAll()

$init

new $init(config: any)

Parameters

config (any)

update

update(data: any)

Parameters

data (any)

$init

new $init(config: any)

Parameters

config (any)

Plot

Plot

Static Members

▸ spectrum_text

Extends webix.ui.list

spectrum_text

Properties

name (String)

Static Members

▸ update(command)

update(command: any)

Parameters

command (any)

▸ update(data)

update(data: TangoAttribute)

Parameters

data (TangoAttribute)

▸ update(data)

update(data: any)

Parameters

data (any)

▸ image_plot

image_plot

Extends webix.ui.view

Properties

name (String)

value (String)

Static Members

▸ update(resp)

update(resp: any)

Parameters

resp (any)

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

▸ kMargins

kMargins

▸ scalar_text

Extends webix.ui.list

scalar_text

Properties

name (String)

▸ scalar

scalar

Extends webix.ui.view

Properties

name (String)

▸ spectrum

spectrum

Extends webix.ui.view

Properties

name (String)

InfoDatatable

InfoDatatable

DevicesTree

DevicesTree

Static Members

▸ tree

tree

Extends webix.ui.tree

Properties

name (String)

Related

webix.ui.tree

Static Members

▸ onBeforeContextMenu(id, e, node)

Event listener.

onBeforeContextMenu(id: any, e: any, node: any)

Parameters

id (any)

e (any)

node (any)

▸ onItemDblClick(id)

Event listener.

onItemDblClick(id: any)

Parameters

id (any)

▸ onAfterSelect(id)

Event listener.Happens after click event

Sets tango host cursor. If alias or member is clicked fetches device.

onAfterSelect(id: any): boolean

Parameters

id (any)

Returns

boolean:

Instance Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

▸ kDevicesTreePanelHeaderIcon

kDevicesTreePanelHeaderIcon

Type: string

▸ kDevicesTreePanelHeader

kDevicesTreePanelHeader

Type: string

dashboard_device_filters

Extends webix.ui.layout

dashboard_device_filters

Properties

name (String)

Static Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

dashboard_tango_hosts

Extends webix.ui.layout

dashboard_tango_hosts

Properties

name (String)

Static Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

textarea0

Extends webix.ui.textarea

textarea0

Properties

name (String)

Static Members

▸ getValue()

getValue()

▸ setValue(value)

setValue(value: any)

Parameters

value (any)

server_wizard

Extends webix.ui.layout

server_wizard

Properties

name (String)

Static Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

clearAll

clearAll()

HintController

HintController

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 05.11.2019

svg

svg

Static Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

svg

svg

Type: webix.protoUI

Static Members

▸ new $init(config)

new $init(config: any)

Parameters

config (any)

astor

astor

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 4/28/19

parseInfo

parseInfo(info: AttributeInfo): Array

Parameters

info (AttributeInfo)

Returns

Array:

kWidgetDashboardProfilesId

kWidgetDashboardProfilesId

Type: string

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 6/12/19

onBindApply

TODO can be this done in a better way? dynamic building?

onBindApply(attr: TangoAttribute)

Parameters

attr (TangoAttribute)

onBindApply

onBindApply(command: Member)

Parameters

command (Member)

loadInfo

loadInfo(device: any): Array<{value: any, info: any}>

Parameters

device (any)

Returns

Array<{value: any, info: any}>:

getRestTangoDevice

getRestTangoDevice(): Promise<tango.TangoDevice>

Returns

Promise<tango.TangoDevice>:

setDevice

setDevice(device: TangoDevice): Promise<boolean>

Parameters

device (TangoDevice)

Returns

Promise<boolean>:

image

image

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 3/25/19

groupAttributesByDeviceId

groupAttributesByDeviceId(attrs: Array<ContextEntity>): Map<TangoDevice, TangoAttribute>

Parameters

attrs (Array<ContextEntity>)

Returns

Map<TangoDevice, TangoAttribute>:

TangoId

TangoId

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 6/12/19

addAttribute

addAttribute(attr: TangoAttribute, force: any)

Parameters

attr (TangoAttribute)

force (any)

addCommand

addCommand(cmd: TangoCommand)

Parameters

cmd (TangoCommand)

addDevice

addDevice(device: TangoDevice)

Parameters

device (TangoDevice)

scalar_text

scalar_text

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 3/25/19

spectrum_text

spectrum_text

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 3/25/19

getColumnConfig

getColumnConfig(attr: TangoAttribute)

Parameters

attr (TangoAttribute)

addAttribute

addAttribute(attr: TangoAttribute)

Parameters

attr (TangoAttribute)

addCommand

addCommand(cmd: TangoCommand)

Parameters

cmd (TangoCommand)

removeAttribute

removeAttribute(name: string): string

Parameters

name (string)

Returns

string: removed attr name

addDevice

addDevice(device: TangoDevice): Promise<void>

Parameters

device (TangoDevice)

Returns

Promise<void>:

leftPanel

leftPanel

Returns

webix.ui.baseview:

mainView

mainView

Returns

webix.ui.baseview:

rightPanel

rightPanel

Returns

webix.ui.baseview:

beforeCloseMain

Removes side panel before closing main tab

beforeCloseMain()

saveScript

saveScript(script: UserScript)

Parameters

script (UserScript)

removeScript

removeScript(id: string)

Parameters

id (string)

executeScript

executeScript(script: UserScript): Promise<any>

Parameters

script (UserScript)

Returns

Promise<any>:

constructor

constructor(app: Application, cmd: TangoCommand)

Parameters

app (Application)

cmd (TangoCommand)

getUserContext

getUserContext(): Promise<UserContext>

Returns

Promise<UserContext>:

shouldRetry

Should retry when errors stack does not contain DEVICE_NOT_EXPORTED or Api_NOT_SUPPORTED

shouldRetry(error: any): boolean

Parameters

error (any)

Returns

boolean:

setDevice

setDevice(id: TangoId)

Parameters

id (TangoId)

readAttribute

readAttribute(attribute: TangoAttribute)

Parameters

attribute (TangoAttribute)

openAttributeWindow

openAttributeWindow(attr: TangoAttribute)

Parameters

attr (TangoAttribute)

openCommandWindow

openCommandWindow(cmd: TangoCommand): CommandWidget

Parameters

cmd (TangoCommand)

Returns

CommandWidget:

openPipeWindow

openPipeWindow(pipe: TangoPipe): PipeWidget

Parameters

pipe (TangoPipe)

Returns

PipeWidget:

setDevice

setDevice(id: TangoId): Promise<void>

Parameters

id (TangoId)

Returns

Promise<void>:

setAttribute

setAttribute(id: TangoId): Promise<void>

Parameters

id (TangoId)

Returns

Promise<void>:

setCommand

setCommand(id: TangoId): Promise<void>

Parameters

id (TangoId)

Returns

Promise<void>:

setPipe

setPipe(id: TangoId): Promise<void>

Parameters

id (TangoId)

Returns

Promise<void>:

getTangoRest

getTangoRest(): Promise<TangoRestApi>

Returns

Promise<TangoRestApi>:

getUserContext

getUserContext(): Promise<UserContext>

Returns

Promise<UserContext>:

addAttribute

addAttribute(id: TangoId)

Parameters

id (TangoId)

writeAttribute

writeAttribute(id: TangoId, value: any)

Parameters

id (TangoId)

value (any)

removeAttribute

removeAttribute(id: TangoId): Promise<void>

Parameters

id (TangoId)

Returns

Promise<void>:

setTangoHost

setTangoHost(id: TangoId)

Parameters

id (TangoId)

setStarter

setStarter(admin: TangoAdmin): Promise<void>

Parameters

admin (TangoAdmin)

Returns

Promise<void>:

loadDevices

Clears devices list if server is undefined

loadDevices(server: TangoServer)

Parameters

server (TangoServer = undefined)

view

Returns this widget's webix view

view

Returns

webix.ui:

constructor

constructor(app: Application, pipe: TangoPipe)

Parameters

app (Application)

pipe (TangoPipe)

getTangoRest

getTangoRest(): Promise<TangoRestApi>

Returns

Promise<TangoRestApi>:

getUserContext

getUserContext(): Promise<UserContext>

Returns

Promise<UserContext>:

addAttribute

addAttribute(id: TangoId)

Parameters

id (TangoId)

removeAttribute

removeAttribute(id: TangoId)

Parameters

id (TangoId)

removeAttribute

removeAttribute(id: TangoId)

Parameters

id (TangoId)

addAttribute

addAttribute(id: TangoId, force: any): Promise<void>

Parameters

id (TangoId)

force (any = false)

Returns

Promise<void>:

writeAttribute

writeAttribute(id: TangoId, value: any)

Parameters

id (TangoId)

value (any)

addDevice

addDevice(id: TangoId): Promise<void>

Parameters

id (TangoId)

Returns

Promise<void>:

removeDevice

removeDevice(id: TangoId)

Parameters

id (TangoId)

addCommand

addCommand(id: TangoId, force: any)

Parameters

id (TangoId)

force (any = false)

execute

execute(id: TangoId)

Parameters

id (TangoId)

selectHost

selectHost(tangoHostId: TangoId): TangoHost

Parameters

tangoHostId (TangoId)

Returns

TangoHost:

selectDevice

selectDevice(tangoDeviceId: TangoId)

Parameters

tangoDeviceId (TangoId)

addTangoDevices

addTangoDevices($0: Object, tango_host: string, server: string, className: string, devices: [string]): Promise<void>

Parameters

$0 (Object)

Name	Description
$0.tango_host any
$0.server any
$0.className any
$0.devices any

tango_host (string) e.g. localhost:10000

server (string)

className (string)

devices ([string])

Returns

Promise<void>: