Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%DeepSee.UI.Dialog.WidgetWizard

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

This dialog creates a new widget for a dashboard.

Property Inventory

Method Inventory

Parameters

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

Properties

property controlDefs as list of %DeepSee.Component.controlDefinition;
List of control definitions for the widget.
Property methods: controlDefsBuildValueArray(), controlDefsCollectionToDisplay(), controlDefsCollectionToOdbc(), controlDefsDisplayToCollection(), controlDefsGet(), controlDefsGetObject(), controlDefsGetObjectId(), controlDefsGetSwizzled(), controlDefsIsValid(), controlDefsOdbcToCollection(), controlDefsSet(), controlDefsSetObject(), controlDefsSetObjectId()
property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Dashboard name.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
Data link name.
Property methods: dataLinkDisplayToLogical(), dataLinkGet(), dataLinkIsValid(), dataLinkLogicalToDisplay(), dataLinkLogicalToOdbc(), dataLinkNormalize(), dataLinkSet()
property dataPropertyDefs as list of %DeepSee.Component.dataPropertyDefinition;
List of data property definitions for the widget.
Property methods: dataPropertyDefsBuildValueArray(), dataPropertyDefsCollectionToDisplay(), dataPropertyDefsCollectionToOdbc(), dataPropertyDefsDisplayToCollection(), dataPropertyDefsGet(), dataPropertyDefsGetObject(), dataPropertyDefsGetObjectId(), dataPropertyDefsGetSwizzled(), dataPropertyDefsIsValid(), dataPropertyDefsOdbcToCollection(), dataPropertyDefsSet(), dataPropertyDefsSetObject(), dataPropertyDefsSetObjectId()
property dataSeriesDefs as list of %DeepSee.Component.dataSeriesDefinition;
List of data series definitions for the widget.
Property methods: dataSeriesDefsBuildValueArray(), dataSeriesDefsCollectionToDisplay(), dataSeriesDefsCollectionToOdbc(), dataSeriesDefsDisplayToCollection(), dataSeriesDefsGet(), dataSeriesDefsGetObject(), dataSeriesDefsGetObjectId(), dataSeriesDefsGetSwizzled(), dataSeriesDefsIsValid(), dataSeriesDefsOdbcToCollection(), dataSeriesDefsSet(), dataSeriesDefsSetObject(), dataSeriesDefsSetObjectId()
property dataSource as %ZEN.Datatype.string;
Data source name.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property drillDownDataSource as %ZEN.Datatype.string;
Drill down data source name.
Property methods: drillDownDataSourceDisplayToLogical(), drillDownDataSourceGet(), drillDownDataSourceIsValid(), drillDownDataSourceLogicalToDisplay(), drillDownDataSourceLogicalToOdbc(), drillDownDataSourceNormalize(), drillDownDataSourceSet()
property localDataSource as %ZEN.Datatype.string;
Local data source name (if any).
Property methods: localDataSourceDisplayToLogical(), localDataSourceGet(), localDataSourceIsValid(), localDataSourceLogicalToDisplay(), localDataSourceLogicalToOdbc(), localDataSourceNormalize(), localDataSourceSet()
property previewName as %ZEN.Datatype.string;
Name of dashboard used to hold preview copy.
Property methods: previewNameDisplayToLogical(), previewNameGet(), previewNameIsValid(), previewNameLogicalToDisplay(), previewNameLogicalToOdbc(), previewNameNormalize(), previewNameSet()
property showPreview as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Should dialog show the widget preview.
Property methods: showPreviewDisplayToLogical(), showPreviewGet(), showPreviewIsValid(), showPreviewLogicalToDisplay(), showPreviewLogicalToOdbc(), showPreviewLogicalToXSD(), showPreviewNormalize(), showPreviewSet(), showPreviewXSDToLogical()
property widgetCount as %ZEN.Datatype.csv (ZENURL = "COUNT");
Number of widgets on dashboard.
Property methods: widgetCountDisplayToLogical(), widgetCountGet(), widgetCountIsValid(), widgetCountLogicalToDisplay(), widgetCountLogicalToOdbc(), widgetCountNormalize(), widgetCountSet()
property widgetDescription as %ZEN.Datatype.string;
Description of the widget (if any).
Property methods: widgetDescriptionDisplayToLogical(), widgetDescriptionGet(), widgetDescriptionIsValid(), widgetDescriptionLogicalToDisplay(), widgetDescriptionLogicalToOdbc(), widgetDescriptionNormalize(), widgetDescriptionSet()
property widgetKey as %ZEN.Datatype.string (ZENURL = "KEY");
Key for widget (if editing).
Property methods: widgetKeyDisplayToLogical(), widgetKeyGet(), widgetKeyIsValid(), widgetKeyLogicalToDisplay(), widgetKeyLogicalToOdbc(), widgetKeyNormalize(), widgetKeySet()
property widgetKeywords as %ZEN.Datatype.string;
Keywords of the saved widget (if any).
Property methods: widgetKeywordsDisplayToLogical(), widgetKeywordsGet(), widgetKeywordsIsValid(), widgetKeywordsLogicalToDisplay(), widgetKeywordsLogicalToOdbc(), widgetKeywordsNormalize(), widgetKeywordsSet()
property widgetName as %ZEN.Datatype.string (ZENURL = "WIDGETNAME");
Name of widget (on the dashboard).
Property methods: widgetNameDisplayToLogical(), widgetNameGet(), widgetNameIsValid(), widgetNameLogicalToDisplay(), widgetNameLogicalToOdbc(), widgetNameNormalize(), widgetNameSet()
property widgetNames as %ZEN.Datatype.csv (ZENURL = "NAMES");
List of current widget names on dashboard.
Property methods: widgetNamesDisplayToLogical(), widgetNamesGet(), widgetNamesIsValid(), widgetNamesLogicalToDisplay(), widgetNamesLogicalToOdbc(), widgetNamesNormalize(), widgetNamesSet()
property widgetOwner as %ZEN.Datatype.string (MAXLEN = 255);
Widget owner.
Property methods: widgetOwnerDisplayToLogical(), widgetOwnerGet(), widgetOwnerIsValid(), widgetOwnerLogicalToDisplay(), widgetOwnerLogicalToOdbc(), widgetOwnerNormalize(), widgetOwnerSet()
property widgetPropertyArray as array of %ZEN.Datatype.string;
Additional name/value pairs for the widget.
Property methods: widgetPropertyArrayBuildValueArray(), widgetPropertyArrayCollectionToDisplay(), widgetPropertyArrayCollectionToOdbc(), widgetPropertyArrayDisplayToCollection(), widgetPropertyArrayDisplayToLogical(), widgetPropertyArrayGet(), widgetPropertyArrayGetObject(), widgetPropertyArrayGetObjectId(), widgetPropertyArrayGetSwizzled(), widgetPropertyArrayIsValid(), widgetPropertyArrayLogicalToDisplay(), widgetPropertyArrayLogicalToOdbc(), widgetPropertyArrayNormalize(), widgetPropertyArrayOdbcToCollection(), widgetPropertyArraySet(), widgetPropertyArraySetObject(), widgetPropertyArraySetObjectId()
property widgetResource as %ZEN.Datatype.string (MAXLEN = 255);
Widget resource.
Property methods: widgetResourceDisplayToLogical(), widgetResourceGet(), widgetResourceIsValid(), widgetResourceLogicalToDisplay(), widgetResourceLogicalToOdbc(), widgetResourceNormalize(), widgetResourceSet()
property widgetSubtype as %ZEN.Datatype.string;
Current selected widget subtype.
Property methods: widgetSubtypeDisplayToLogical(), widgetSubtypeGet(), widgetSubtypeIsValid(), widgetSubtypeLogicalToDisplay(), widgetSubtypeLogicalToOdbc(), widgetSubtypeNormalize(), widgetSubtypeSet()
property widgetTemplateName as %ZEN.Datatype.string;
Name used to save this widget to the catalog!
Property methods: widgetTemplateNameDisplayToLogical(), widgetTemplateNameGet(), widgetTemplateNameIsValid(), widgetTemplateNameLogicalToDisplay(), widgetTemplateNameLogicalToOdbc(), widgetTemplateNameNormalize(), widgetTemplateNameSet()
property widgetType as %ZEN.Datatype.string;
Current selected widget type.
Property methods: widgetTypeDisplayToLogical(), widgetTypeGet(), widgetTypeIsValid(), widgetTypeLogicalToDisplay(), widgetTypeLogicalToOdbc(), widgetTypeNormalize(), widgetTypeSet()

Methods

method %OnAfterCreatePage() as %Status
Apply changes to page.
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, pWidgetName As %String, pInfo As %ZEN.proxyObject, pPreview As %Boolean = 0) as %String [ ZenMethod ]
Add a widget to the given dashboard definition. If pPreview, then save to the private preview dashboard.
classmethod GetWidgetInfo(pKey As %String, pInfo As %ZEN.proxyObject) as %String [ ZenMethod ]
Get info on the selected widget.
method GetWidgetTypeList(ByRef pParameters, Output pMetaData, Output pData) as %Status
Return JSON array of widget types.
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
clientmethod browseDataSources() [ Language = javascript ]
Launch the data source finder.
clientmethod browseDrillDataSources() [ Language = javascript ]
Launch the data source finder.
clientmethod chooseDataSource(id) [ Language = javascript ]
Show data source finder for widget property control
clientmethod clearDataSource() [ Language = javascript ]
Clear the data source. If there is a local override, first clear it and restore the original value.
clientmethod clearDrillDataSource() [ Language = javascript ]
Clear the data source.
clientmethod dataSourceChange() [ Language = javascript ]
User edit of dataSource.
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 loadKPI() [ Language = javascript ]
Launch the KPI finder dialog.
clientmethod loadPivot() [ Language = javascript ]
Launch the pivot finder dialog.
clientmethod loadWorksheet() [ Language = javascript ]
Launch the worksheet finder dialog.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
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 selectWidgetType(key) [ Language = javascript ]
User selected a widget type.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab