Skip to main content

%DeepSee.Component.Widget.controlPanel

Class %DeepSee.Component.Widget.controlPanel Extends %DeepSee.Component.Widget.widget [ System = 4 ]

A specialized DeepSee Dashboard widget that displays controls without attached content. The widget does not require a dataSource to allow definition of controls. Some controls themselves require a dataSource to add information, for example the filter controls.

Properties​

showTitleBar​

Property showTitleBar As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

This widget can override the title bar display.

showToolbarBottomBorder​

Property showToolbarBottomBorder As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Specify whether to display the separator between the toolbar and widget content

XDatas​

Style​

XData Style

Style for widget sections

Methods​

%GetCatalogInfo​

ClassMethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) As %Status

Return information used to list this widget within the "widget catalog".

%GetWidgetPropertyInfo​

ClassMethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) As %Status

Return information on additional "properties" supported by this widget for the given subtype.

%OnCreateWidget​

Method %OnCreateWidget(pGroup As %ZEN.Component.group) As %Status

This callback is responsible for creating the contents of the widget.

%CreateController​

Method %CreateController(pGroup As %ZEN.Component.abstractGroup, Output pController As %ZEN.Auxiliary.abstractController) As %Status

If this widget has a data source, create a data controller that will serve this data to the client.
The controller's id is "controller" (within the scope of this widget).

%OnAddToPageBefore​

Method %OnAddToPageBefore() As %Status
ClientMethod navSelectItem(key, value, final) [ Language = javascript ]

extractTDNodes​

ClientMethod extractTDNodes(tableRoot, tdArray) [ Internal, Language = javascript ]

adjustContentSize​

ClientMethod adjustContentSize(load, width, height) [ Language = javascript ]

Called when page is loaded or widget is resized.

applyFilter​

ClientMethod applyFilter(name, value) [ Language = javascript ]

Apply the given filter to this widget.

getDataController​

ClientMethod getDataController() [ Language = javascript ]

If this widget contains a data controller, return it. This allows for generic capabilities in this base class.

%GetDataController​

Method %GetDataController() As %ZEN.Auxiliary.abstractController

If this widget contains a data controller, return it.

isReady​

ClientMethod isReady() [ Internal, Language = javascript ]

Test if this widget is ready to be resized.

%OnCreateControls​

Method %OnCreateControls(pGroup As %ZEN.Component.group) As %Status

This callback is called just before controls are added to the top of the widget. pGroup is the header in which new Zen control can be added.