Skip to main content

%DeepSee.Component.Widget.portlet

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

A specialized DeepSee Dashboard widget that displays a user-defined "portlet". A portlet serves users defined HTML or SVG content that is displayed within the widge. The portlet type is specified by the subtype property.
If you wish to create your own portlet, do NOT subclass this component; instead, create a subclass of the %DeepSee.Component.Portlet.abstractPortlet class.

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, ByRef pSettings) 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.

%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.

%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).

adjustContentSize​

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

Called when page is loaded or widget is resized.

onApplyFilters​

ClientMethod onApplyFilters(refresh) [ Language = javascript ]

Notification that a filter has changed.

getDataController​

ClientMethod getDataController() [ Language = javascript ]

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

exportExcel​

ClientMethod exportExcel() [ Language = javascript ]

Export current query to excel

exportPDF​

ClientMethod exportPDF() [ Language = javascript ]

Export current query to pdf. If we are in chart mode, export the chart.