Skip to main content

%DeepSee.UI.Dialog.WidgetWizard

Class %DeepSee.UI.Dialog.WidgetWizard Extends %DeepSee.UI.Dialog.standardDialog [ System = 4 ]

This dialog creates a new widget for a dashboard.

Parameters​

APPLYBUTTON​

Parameter APPLYBUTTON = 0;

Properties​

dashboardName​

Property dashboardName As %ZEN.Datatype.string(ZENURL = "DASHBOARD");

Dashboard name.

dataSource​

Property dataSource As %ZEN.Datatype.string;

Data source name.

localDataSource​

Property localDataSource As %ZEN.Datatype.string;

Local data source name (if any).

drillDownDataSource​

Property drillDownDataSource As %ZEN.Datatype.string;

Drill down data source name.

Property dataLink As %ZEN.Datatype.string;

Data link name.

widgetName​

Property widgetName As %ZEN.Datatype.string(ZENURL = "WIDGETNAME");

Name of widget (on the dashboard).

widgetKey​

Property widgetKey As %ZEN.Datatype.string(ZENURL = "KEY");

Key for widget (if editing).

widgetType​

Property widgetType As %ZEN.Datatype.string;

Current selected widget type.

widgetSubtype​

Property widgetSubtype As %ZEN.Datatype.string;

Current selected widget subtype.

dataSeriesDefs​

Property dataSeriesDefs As list Of %DeepSee.Component.dataSeriesDefinition;

List of data series definitions for the widget.

controlDefs​

Property controlDefs As list Of %DeepSee.Component.controlDefinition;

List of control definitions for the widget.

dataPropertyDefs​

Property dataPropertyDefs As list Of %DeepSee.Component.dataPropertyDefinition;

List of data property definitions for the widget.

widgetTemplateName​

Property widgetTemplateName As %ZEN.Datatype.string;

Name used to save this widget to the catalog!

widgetDescription​

Property widgetDescription As %ZEN.Datatype.string;

Description of the widget (if any).

widgetOwner​

Property widgetOwner As %ZEN.Datatype.string(MAXLEN = 255);

Widget owner.

widgetResource​

Property widgetResource As %ZEN.Datatype.string(MAXLEN = 255);

Widget resource.

widgetKeywords​

Property widgetKeywords As %ZEN.Datatype.string;

Keywords of the saved widget (if any).

widgetPropertyArray​

Property widgetPropertyArray As array Of %ZEN.Datatype.string;

Additional name/value pairs for the widget.

widgetNames​

Property widgetNames As %ZEN.Datatype.csv(ZENURL = "NAMES");

List of current widget names on dashboard.

widgetCount​

Property widgetCount As %ZEN.Datatype.csv(ZENURL = "COUNT");

Number of widgets on dashboard.

showPreview​

Property showPreview As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Should dialog show the widget preview.

previewName​

Property previewName As %ZEN.Datatype.string;

Name of dashboard used to hold preview copy.

XDatas​

Style​

XData Style

dialogBody​

XData dialogBody [ XMLNamespace = "http://www.intersystems.com/zen" ]

Contents of the dialog body.

Methods​

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

Apply changes to page.

%OnGetTitle​

Method %OnGetTitle() As %String

Get the (localized) title string for the dialog. This should be implemented in a subclass.

%OnGetSubtitle​

Method %OnGetSubtitle() As %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

getDialogValue​

ClientMethod getDialogValue() [ Language = javascript ]

ondialogStart​

ClientMethod ondialogStart() [ Language = javascript ]

This callback, if defined, is called when the dialog page is loaded.

ondialogFinish​

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.

AddWidgetToDashboard​

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.

dataSourceChange​

ClientMethod dataSourceChange() [ Language = javascript ]

User edit of dataSource.

clearDataSource​

ClientMethod clearDataSource() [ Language = javascript ]

Clear the data source. If there is a local override, first clear it and restore the original value.

browseDataSources​

ClientMethod browseDataSources() [ Language = javascript ]

Launch the data source finder.

browseDrillDataSources​

ClientMethod browseDrillDataSources() [ Language = javascript ]

Launch the data source finder.

clearDrillDataSource​

ClientMethod clearDrillDataSource() [ Language = javascript ]

Clear the data source.

loadPivot​

ClientMethod loadPivot() [ Language = javascript ]

Launch the pivot finder dialog.

loadKPI​

ClientMethod loadKPI() [ Language = javascript ]

Launch the KPI finder dialog.

loadWorksheet​

ClientMethod loadWorksheet() [ Language = javascript ]

Launch the worksheet finder dialog.

onPopupAction​

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this page fires an action.

adjustSize​

ClientMethod adjustSize() [ Language = javascript ]

Adjust size and position of components on this page.

chooseDataSource​

ClientMethod chooseDataSource(id) [ Language = javascript ]

Show data source finder for widget property control

selectWidgetType​

ClientMethod selectWidgetType(key) [ Language = javascript ]

User selected a widget type.

GetWidgetInfo​

ClassMethod GetWidgetInfo(pKey As %String, pInfo As %ZEN.proxyObject) As %String [ ZenMethod ]

Get info on the selected widget.

GetWidgetTypeList​

Method GetWidgetTypeList(ByRef pParameters, Output pMetaData, Output pData) As %Status

Return JSON array of widget types.