This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).


class %DeepSee.UI.Dialog.WidgetCatalog extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user select a widget template from the DeepSee widget catalog.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.

Properties (Including Private)

property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Name of dashbvoard that launched the dialog.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property widgetDescription as %ZEN.Datatype.string;
Description of selected widget.
Property methods: widgetDescriptionDisplayToLogical(), widgetDescriptionGet(), widgetDescriptionIsValid(), widgetDescriptionLogicalToDisplay(), widgetDescriptionLogicalToOdbc(), widgetDescriptionNormalize(), widgetDescriptionSet()
property widgetId as %ZEN.Datatype.string;
Id of selected widget.
Property methods: widgetIdDisplayToLogical(), widgetIdGet(), widgetIdIsValid(), widgetIdLogicalToDisplay(), widgetIdLogicalToOdbc(), widgetIdNormalize(), widgetIdSet()
property widgetNo as %ZEN.Datatype.string;
Row number of selected widget.
Property methods: widgetNoDisplayToLogical(), widgetNoGet(), widgetNoIsValid(), widgetNoLogicalToDisplay(), widgetNoLogicalToOdbc(), widgetNoNormalize(), widgetNoSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method AddWidgetToDashboard(pDashboardName As %String, pWidgetTemplateName As %String) as %String [ ZenMethod ]
Add a widget to the given dashboard definition.
method ChangeWidget(pWidgetTemplateId As %String) as %String [ ZenMethod ]
Display a new preview widget.
method DrawWidgetList(pSeed As %String) as %Status
Render contents of the widget list.
classmethod RemoveFromCatalog(pName As %String) as %String [ ZenMethod ]
Remove item from catalog.
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod removeFromList(name) [ Language = javascript ]
Remove item from catalog.
clientmethod selectWidget(no, id) [ Language = javascript ]
User selected a widget in the list.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window