Skip to main content


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

Special version of the analyzer that runs within a dialog. This is displayed when a user uses the Analyze option in a widget.

Property Inventory

Method Inventory


parameter APPLYBUTTON = 1;
Inherited description: If true, then this dialog displays an Apply button.
parameter DEFAULTVIEWMODE = pivot;
If this page has multiple views, this is its initial display mode.


property cubeName as %ZEN.Datatype.string (ZENURL = "CUBE");
Name of cube to explore.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property currViewMode as %ZEN.Datatype.string [ InitialExpression = ..#DEFAULTVIEWMODE ];
If this page has "views", this is the current view type.
Property methods: currViewModeDisplayToLogical(), currViewModeGet(), currViewModeIsValid(), currViewModeLogicalToDisplay(), currViewModeLogicalToOdbc(), currViewModeNormalize(), currViewModeSet()
property filterState as %ZEN.Datatype.string (MAXLEN = 5000, ZENURL = "FILTERSTATE");
If provided, state of filters on widget that launched this dialog.
Property methods: filterStateDisplayToLogical(), filterStateGet(), filterStateIsValid(), filterStateLogicalToDisplay(), filterStateLogicalToOdbc(), filterStateNormalize(), filterStateSet()
property localPivotName as %ZEN.Datatype.string (ZENURL = "LOCALNAME");
If provided, use this name to save the pivot.
Property methods: localPivotNameDisplayToLogical(), localPivotNameGet(), localPivotNameIsValid(), localPivotNameLogicalToDisplay(), localPivotNameLogicalToOdbc(), localPivotNameNormalize(), localPivotNameSet()
property pivotDescription as %ZEN.Datatype.string;
Description of the saved pivot (if any).
Property methods: pivotDescriptionDisplayToLogical(), pivotDescriptionGet(), pivotDescriptionIsValid(), pivotDescriptionLogicalToDisplay(), pivotDescriptionLogicalToOdbc(), pivotDescriptionNormalize(), pivotDescriptionSet()
property pivotKeywords as %ZEN.Datatype.string;
Keywords of the saved pivot (if any).
Property methods: pivotKeywordsDisplayToLogical(), pivotKeywordsGet(), pivotKeywordsIsValid(), pivotKeywordsLogicalToDisplay(), pivotKeywordsLogicalToOdbc(), pivotKeywordsNormalize(), pivotKeywordsSet()
property pivotName as %ZEN.Datatype.string (ZENURL = "PIVOT");
Name of saved pivotTable to view (overrides CUBE if present).
Property methods: pivotNameDisplayToLogical(), pivotNameGet(), pivotNameIsValid(), pivotNameLogicalToDisplay(), pivotNameLogicalToOdbc(), pivotNameNormalize(), pivotNameSet()
property resetData as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, reset the data source when the dialog is applied.
Property methods: resetDataDisplayToLogical(), resetDataGet(), resetDataIsValid(), resetDataLogicalToDisplay(), resetDataLogicalToOdbc(), resetDataLogicalToXSD(), resetDataNormalize(), resetDataSet(), resetDataXSDToLogical()
property widgetKey as %ZEN.Datatype.string (ZENURL = "KEY");
Key (within its dashboard) of widget that launched this dialog.
Property methods: widgetKeyDisplayToLogical(), widgetKeyGet(), widgetKeyIsValid(), widgetKeyLogicalToDisplay(), widgetKeyLogicalToOdbc(), widgetKeyNormalize(), widgetKeySet()


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.
classmethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the dimension tree.
method SavePivotTable(pResetData As %Boolean = 0) as %String [ ZenMethod ]
Save the pivot table.
classmethod UpdateFilterControls(pCubeName As %String, pGroup As, pPivotTable As %DeepSee.Component.pivotTable) as %String [ ZenMethod ]
Called from client to update list of filters.
clientmethod adjustSize() [ Language = javascript ]
Adjust sizes of analyzer components on the page.
clientmethod filterChangeHandler(ctrl, filterNo) [ Language = javascript ]
User has changed a filter control value.
clientmethod filterDropDown(ctrl) [ Language = javascript ]
Drop down is about to appear for filter 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 getPivot() [ Language = javascript ]
Return the current pivot table.
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 resetLocalDataSource() [ Language = javascript ]
Reset the local data source for our widget.
clientmethod showFormatOptions() [ Language = javascript ]
Launch the cell format options dialog.
clientmethod showPivotOptions() [ Language = javascript ]
Launch the pivot options dialog.
clientmethod showQuery() [ Language = javascript ]
Launch the show query dialog.
clientmethod treeDoubleClick(tree) [ Language = javascript ]
User has double-clicked on an element in the tree control. This is copied from the same method in the main Analyzer page.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab