This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.Component.Widget.portlet

%DeepSee.Component.Widget.portlet

class %DeepSee.Component.Widget.portlet extends %DeepSee.Component.Widget.widget

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.

Method Inventory

Methods

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).
classmethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) as %Status
Return information used to list this widget within the "widget catalog".
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.
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.
method %OnCreateWidget(pGroup As %ZEN.Component.group) as %Status
This callback is responsible for creating the contents of the widget.
clientmethod adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
clientmethod exportExcel() [ Language = javascript ]
Export current query to excel
clientmethod exportPDF() [ Language = javascript ]
Export current query to pdf. If we are in chart mode, export the chart.
clientmethod getDataController() [ Language = javascript ]
If this widget contains a data controller, return it. This allows for generic capabilities in this base class.
clientmethod onApplyFilters(refresh) [ Language = javascript ]
Notification that a filter has changed.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window