This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%DeepSee.Component.Portlet.abstractPortlet

class %DeepSee.Component.Portlet.abstractPortlet extends %ZEN.Component.component, %ZEN.Component.dataView

Base class for DeepSee Dashboard portlets.
A portlet is a specialized Zen component that can be plugged into a DeepSee dashboard to supply customized content.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter NAMESPACE = http://www.intersystems.com/deepsee;
Inherited description: This is the XML namespace used for library components.

Properties

property settings as %String [ MultiDimensional ];
MultiDimensional property containing the current settings values for this portlet.
Property methods: settingsDisplayToLogical(), settingsGet(), settingsIsValid(), settingsLogicalToDisplay(), settingsLogicalToOdbc(), settingsNormalize(), settingsSet()

Methods

method %DrawHTML()
Static HTML display method: draw the BODY of this component as HTML.
This should be overridden in subclasses.
classmethod %OnGetPortletIcon() as %String
Return the URL of the icon to display for this portlet. This is displayed in the Widget Builder dialog. This should be overridden in subclasses.
classmethod %OnGetPortletName() as %String
Return the localized caption of this portlet. This is displayed in the Widget Builder dialog. This should be overridden in subclasses.
classmethod %OnGetPortletSettings(Output pInfo As %List, ByRef pSettings) as %Status
Return an optional array of "settings" values for this portlet.
The list of settings is displayed in the Widget Builder where the user can view and edit them. When the portlet is rendered, the values of all settings is made available to the portlet's %DrawHTML() method via the settings--a multidimensional array subscripted by setting name.
On return, pInfo can contain a list of settings in the form:
pInfo(n) = $LB(name,value,type,caption,title)
name is the logical name of the setting.
value is the default value of the setting.
type indicates the type of the setting. This determines the control displayed to get the value of the setting. If omitted the type is assumed to be a string. The type can be: "%Integer", "%Boolean", or "ENUM^caption1:value1,caption2:value2".
caption is the localized caption of the setting.
title is an optional tooltip displayed for the setting.
Custom portlet settings can be controlled using the SETTINGS=PORTLET parameter in the dashboard URL
abstract clientmethod adjustContentSize(load, width, height) [ Language = javascript ]
Notification from the containing widget that the page is loaded or the widget is resized. Subclass can implement this, if they wish.
abstract clientmethod onApplyFilters(refresh, widget) [ Language = javascript ]
Notification that a filter has changed. Subclass can implement this, if they wish.
refresh inidicates if the display should be refreshed.
widget is the containing widget object.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback