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?


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

This dialog adds (or edits) a new data property definition to a DeepSee dashboard widget.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter JSINCLUDES = dsparser.js;
Inherited description: Comma-separated list of additional JS include files for the page.


property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Dashboard name.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property dataSource as %ZEN.Datatype.string (ZENURL = "DATASOURCE");
Data source name.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property itemNumber as %ZEN.Datatype.string (ZENURL = "NUMBER");
Index of property within parent dialog list or "" for new.
Property methods: itemNumberDisplayToLogical(), itemNumberGet(), itemNumberIsValid(), itemNumberLogicalToDisplay(), itemNumberLogicalToOdbc(), itemNumberNormalize(), itemNumberSet()
property widgetName as %ZEN.Datatype.string (ZENURL = "WIDGETNAME");
Name of widget.
Property methods: widgetNameDisplayToLogical(), widgetNameGet(), widgetNameIsValid(), widgetNameLogicalToDisplay(), widgetNameLogicalToOdbc(), widgetNameNormalize(), widgetNameSet()
property widgetType as %ZEN.Datatype.string (ZENURL = "WIDGETTYPE");
Type of widget, used to decide what controls to show.
Property methods: widgetTypeDisplayToLogical(), widgetTypeGet(), widgetTypeIsValid(), widgetTypeLogicalToDisplay(), widgetTypeLogicalToOdbc(), widgetTypeNormalize(), widgetTypeSet()


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.
clientmethod changeAutoLabel() [ Language = javascript ]
Change to "autoLabel" control.
clientmethod changeDisplay() [ Language = javascript ]
Change to "display" control.
clientmethod changeHidden() [ Language = javascript ]
Change to "hidden" control.
clientmethod changeSummary() [ Language = javascript ]
Change to summary value control.
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 ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod validateValue(ctrl) [ Language = javascript ]
Validate the value (expression) within the given control.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)