Skip to main content

%DeepSee.UI.Analyzer

Class %DeepSee.UI.Analyzer Extends %DeepSee.UI.standardPage [ System = 4 ]

DeepSee Analyzer page.

Parameters​

RESOURCE​

Parameter RESOURCE = "%DeepSee_Analyzer,%DeepSee_AnalyzerEdit";

PAGENAME​

Parameter PAGENAME = "Analyzer";

DEFAULTVIEWMODE​

Parameter DEFAULTVIEWMODE = "pivot";

If this page has multiple views, this is its initial display mode.

USERMODE​

Parameter USERMODE As BOOL = 0;

If true, we are launched from the USER portal.

ANALYZERURL​

Parameter ANALYZERURL As STRING = "_DeepSee.UI.Analyzer.zen";

URL for Analyzer.

DOCBOOKID​

Parameter DOCBOOKID = "D2ANLY_ch_intro";

Properties​

autosave​

Property autosave As %ZEN.Datatype.string(ZENURL = "AUTOSAVE");

Token to load unsaved pivot state.

autosaveOverride​

Property autosaveOverride As %ZEN.Datatype.string(ZENURL = "AUTOSAVEOVERRIDE");

Token to load unsaved pivot state.

lastLeftWidth​

Property lastLeftWidth As %ZEN.Datatype.integer [ InitialExpression = 300 ];

Token to load unsaved pivot state.

cubeFullName​

Property cubeFullName As %ZEN.Datatype.string(ZENURL = "CUBE");

Name of Cube (with extension).

cubeName​

Property cubeName As %ZEN.Datatype.string;

Name of cube to explore.

readOnly​

Property readOnly As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, user cannot modify the current pivot.

canWrite​

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

If true, user can modify (non-read-only) pivots.

pivotName​

Property pivotName As %ZEN.Datatype.string(ZENURL = "PIVOT");

Name of saved pivotTable to view (overrides CUBE if present).

pivotDescription​

Property pivotDescription As %ZEN.Datatype.string;

Description of the saved pivot (if any).

pivotResource​

Property pivotResource As %ZEN.Datatype.string;

Resource of the saved pivot (if any).

pivotOwner​

Property pivotOwner As %ZEN.Datatype.string;

Owner of the saved pivot (if any).

pivotLocked​

Property pivotLocked As %ZEN.Datatype.boolean;

Locked state of the saved pivot.

pivotPublic​

Property pivotPublic As %ZEN.Datatype.boolean;

Public state of the saved pivot.

pivotKeywords​

Property pivotKeywords As %ZEN.Datatype.string;

Keywords of the saved pivot (if any).

pivotCategory​

Property pivotCategory As %ZEN.Datatype.string;

Category of the saved pivot.

analyzerURL​

Property analyzerURL As %ZEN.Datatype.string [ InitialExpression = {..#ANALYZERURL} ];

URL for Analyzer.

useClientEmail​

Property useClientEmail As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, send e-mail using client-side mailto application.

multiChart​

Property multiChart As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, show one chart for each data series.

hasAnalysis​

Property hasAnalysis As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, use the new analysis dialog.

hasPDF​

Property hasPDF As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, show the print/pdf option.

sessionCookie​

Property sessionCookie As %ZEN.Datatype.string;

Current CSP session.

autoExec​

Property autoExec As %ZEN.Datatype.boolean(ZENURL = "EXEC") [ InitialExpression = 1 ];

Initial value of autoexec setting for pivot table.

previewMode​

Property previewMode As %ZEN.Datatype.boolean(ZENURL = "PREVIEW") [ InitialExpression = 0 ];

Initial value of previewMode setting for the Analyzer.

actionNames​

Property actionNames As list Of %ZEN.Datatype.string;

List of names for any actions for the current cube.

actionCaptions​

Property actionCaptions As list Of %ZEN.Datatype.string;

List of captions for any actions for the current cube.

isEmbedded​

Property isEmbedded As %ZEN.Datatype.boolean(ZENURL = "EMBED");

Convenience property. Setting this true is equivalent to NOTITLE=1

noTitle​

Property noTitle As %ZEN.Datatype.boolean(ZENURL = "NOTITLE");

If true, then do not display the title area of this page.

showDimensions​

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

If true, show the dimensions tree.

tempStorageRoot​

Property tempStorageRoot As %ZEN.Datatype.string [ InitialExpression = "$Temp/Analyzer/" ];

Location of the autosave items

treeMode​

Property treeMode As %ZEN.Datatype.string;

What to show in the dimensions tree.

chartSeriesScheme​

Property chartSeriesScheme As %ZEN.Datatype.string;

Chart series color scheme.

chartSeriesColors​

Property chartSeriesColors As %ZEN.Datatype.string;

Chart series color list.

cubeSupportsSqlRestrict​

Property cubeSupportsSqlRestrict As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Flag to indicate whether or not the cube can use the special %SQLRESTRICT dimension.

warnUser​

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

Flag to indicate whether to warn user of unsaved changes on page unload

XDatas​

Style​

XData Style

contentPane​

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

This XML defines the contents of the contents pane for this page.

Methods​

%OnGetTitle​

Method %OnGetTitle() As %String

Get the (localized) title string for the page.

GetTitle​

Method GetTitle() As %String [ ZenMethod ]

getPageTitle​

ClientMethod getPageTitle() As %String [ Language = javascript ]

Get the title string to add to the locator row. This should be implemented in a subclass.

%OnGetPageName​

Method %OnGetPageName() As %String

Get the name for the page.

%OnGetProductName​

Method %OnGetProductName() As %String

Get the product name for the page.

OnGetRibbonInfo​

Method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) As %Status

Get information to display in the ribbon bar.

OnDrawRibbon​

Method OnDrawRibbon() As %Status

Draw additional stuff in the ribbon bar

DrawCubeName​

Method DrawCubeName(pSeed As %String) As %Status

Draw cube name above member tree.

changeSubjectArea​

ClientMethod changeSubjectArea() [ Language = javascript ]

Launch the subject area finder dialog.

addCalculatedMember​

ClientMethod addCalculatedMember() [ Language = javascript ]

Launch the calculated member dialog..

addNamedFilter​

ClientMethod addNamedFilter() [ Language = javascript ]

Launch the add named filter dialog..

addPivotVariable​

ClientMethod addPivotVariable() [ Language = javascript ]

Launch the add pivot variable dialog.

isCalculatedMember​

ClientMethod isCalculatedMember() [ Language = javascript ]

Test if the current item in the tree is a calculated member. If so, return the index of the item within the calculatedMembers array.

isNamedFilter​

ClientMethod isNamedFilter() [ Language = javascript ]

Test if the current item in the tree is a named filter. If so, return the filter name else return ''.

isPivotVariable​

ClientMethod isPivotVariable() [ Language = javascript ]

Test if the current item in the tree is a pivot variable. If so, return the variable name else return ''.

showQuery​

ClientMethod showQuery() [ Language = javascript ]

Launch the show query dialog.

showChartOptions​

ClientMethod showChartOptions() [ Language = javascript ]

Launch the chart options dialog.

showFormatOptions​

ClientMethod showFormatOptions() [ Language = javascript ]

Launch the cell format options dialog.

showPivotOptions​

ClientMethod showPivotOptions() [ Language = javascript ]

Launch the pivot options dialog.

showPDFOptions​

ClientMethod showPDFOptions() [ Language = javascript ]

Launch the pdf options dialog.

showBreakdown​

ClientMethod showBreakdown() [ Language = javascript ]

Launch the pivot analysis dialog.

onPopupAction​

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

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

restorePivot​

ClientMethod restorePivot() [ Language = javascript ]

WAL053

newPivot​

ClientMethod newPivot() [ Language = javascript ]

Create a new saved pivot.

GetOverrideValue​

Method GetOverrideValue(pToken) As %String [ ZenMethod ]

CheckAutosaveSetting​

Method CheckAutosaveSetting() As %Boolean [ ZenMethod ]

loadPivot​

ClientMethod loadPivot() [ Language = javascript ]

Launch the open saved pivot finder dialog.

savePivot​

ClientMethod savePivot(showDialog) [ Language = javascript ]

Launch the save pivot dialog.

SaveTempTables​

Method SaveTempTables() As %String [ ZenMethod ]

Save and manage a temp version of this table and a "Last" copy for autosave

SavePivotTable​

Method SavePivotTable(pPivotName As %String = "") As %String [ ZenMethod ]

Save the pivot table. If the optional pPivotName is supplied, a copy of the pivot definition currently open will be filed under that identifier. If no such custom identifier is supplied, the table will be saved under the name currently in use.

deletePivot​

ClientMethod deletePivot() [ Language = javascript ]

Delete the pivot table.

DeletePivotTable​

Method DeletePivotTable() As %String [ ZenMethod ]

Delete the pivot table.

pivot​

ClientMethod pivot() [ Language = javascript ]

pivot

setDim​

ClientMethod setDim(dim, val) [ Language = javascript ]

GetDimensionInfo​

ClassMethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the dimension tree.

GetPivotInfo​

ClassMethod GetPivotInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the saved pivot dimension tree.

GetQMSRInfo​

ClassMethod GetQMSRInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the quality measures dimension tree.

GetListingFieldsInfo​

ClassMethod GetListingFieldsInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the listing fields dimension tree.

Method %GetLocatorLinks(Output pLink) As %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

onlayoutHandler​

ClientMethod onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

positionResizeHandles​

ClientMethod positionResizeHandles(initial) [ Language = javascript ]

getFirstTableRow​

ClientMethod getFirstTableRow(div) [ Language = javascript ]

startDrag​

ClientMethod startDrag(engine, wrapper) [ Language = javascript ]

Callback to initiate window resize event

endDrag​

ClientMethod endDrag(engine, wrapper) [ Language = javascript ]

Callback to wrap up window resize event

constrainDragX​

ClientMethod constrainDragX(engine, wrapper, intendedX) [ Language = javascript ]

Callback to limit horizontal resizing

constrainDragY​

ClientMethod constrainDragY(engine, wrapper, intendedY) [ Language = javascript ]

Callback to limit vertical resizing

adjustSizes​

ClientMethod adjustSizes(load) [ Language = javascript ]

Adjust sizes of components on the page.

getCurrentChart​

ClientMethod getCurrentChart() [ Language = javascript ]

Return the current chart, if any.

getPivot​

ClientMethod getPivot() [ Language = javascript ]

Return the current pivot table.

getChartType​

ClientMethod getChartType() [ Language = javascript ]

Get the type of the current chart.

getGridType​

ClientMethod getGridType() [ Language = javascript ]

Get the grid type of the current chart.

setChartOptions​

ClientMethod setChartOptions(type, grid, textSize, title, min, max) [ Language = javascript ]

Apply the chart dialog options to the current chart.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

This class method callback is called just before the server-side page object is created.

setViewModeHandler​

ClientMethod setViewModeHandler(mode) [ Language = javascript ]

Do the actual work of updating the view to match the current view mode.

chartElementClick​

ClientMethod chartElementClick(chart) [ Language = javascript ]

User has clicked on a chart element.

treeChange​

ClientMethod treeChange(tree) [ Language = javascript ]

User has selected a new element in the tree control.

deleteCalculatedMember​

ClientMethod deleteCalculatedMember(force) [ Language = javascript ]

Delete the selected Calculated Member, named filter, or pivot variable.

treeDoubleClick​

ClientMethod treeDoubleClick(tree) [ Language = javascript ]

User has double-clicked on an element in the tree control.

pivotTreeChange​

ClientMethod pivotTreeChange(tree) [ Language = javascript ]

User has selected a new element in the pivot tree control.

pivotTreeDoubleClick​

ClientMethod pivotTreeDoubleClick(tree) [ Language = javascript ]

User has double-clicked on an element in the pivot tree control.

%OnPreHTTP​

ClassMethod %OnPreHTTP() As %Boolean [ ServerOnly = 1 ]

Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.

%OnDrawHTMLHead​

Method %OnDrawHTMLHead() As %Status

Add include files to support color schemes.

DeleteNamedFilter​

ClassMethod DeleteNamedFilter(pCubeName As %String, pFilterName As %String) As %String [ ZenMethod ]

Called from client to delete a named filter.

DeleteSharedCalcMember​

ClassMethod DeleteSharedCalcMember(pCubeName, pCalcMbrName, pDimension) As %String [ ZenMethod ]

Called from client to delete a shared calculated member.

DeletePivotVariable​

ClassMethod DeletePivotVariable(pCubeName As %String, pVariableName As %String) As %String [ ZenMethod ]

Called from client to delete a pivot variable.

UpdateFilterControls​

ClassMethod UpdateFilterControls(pCubeName As %String, pGroup As %ZEN.Component.group, pPivotTable As %DeepSee.Component.pivotTable) As %String [ ZenMethod ]

Called from client to update list of filters.

%CreateFilterControls​

ClassMethod %CreateFilterControls(pCubeName As %String, pGroup As %ZEN.Component.abstractGroup, pPivot As %DeepSee.Component.pivotTable = "") As %Status

Create the set of filter controls along the top of the pivot table.
pGroup is the parent group containing the filter controls.
pPivot is the pivot table supplying the filter definitions.

%FindPivotVariables​

ClassMethod %FindPivotVariables(pList As %Collection.AbstractList, ByRef pVariables) As %Status

Get list of pivot variables within the given collection.

pivotVariableChangeHandler​

ClientMethod pivotVariableChangeHandler(ctrl, varName, varType) [ Language = javascript ]

User has changed a pivot variable control value.

filterChangeHandler​

ClientMethod filterChangeHandler(ctrl, filterNo) [ Language = javascript ]

User has changed a filter control value.

filterDropDown​

ClientMethod filterDropDown(ctrl) [ Language = javascript ]

Drop down is about to appear for filter control.

toggleExportMenu​

ClientMethod toggleExportMenu(menuId) [ Language = javascript ]

closeExportMenu​

ClientMethod closeExportMenu(menuId) [ Language = javascript ]

exportExcel​

ClientMethod exportExcel() [ Language = javascript ]

Export current query to excel

exportCSV​

ClientMethod exportCSV(simple) [ Language = javascript ]

Export current query to a CSV file.

exportPDF​

ClientMethod exportPDF() [ Language = javascript ]

Export current query to PDF.

collectPrintParameters​

ClientMethod collectPrintParameters() [ Language = javascript ]

Collect the print parameters for this pivot container. This includes both URL parameters (ALL CAPS) and parameters specific to the SVG printing utility.

prepareSvgPrintParameters​

ClientMethod prepareSvgPrintParameters(parms) [ Internal, Language = javascript ]

Transform a set of printing parameters that are compatible with the ZenReport-based %DeepSee.UI.MDXPDF, %DeepSee.UI.ChartPDF, etc, into the parameters expected by the %DeepSee.Component.deepseeSvgImageProvider

ClassMethod GetContextLinks(Output pLinks) As %Status

Define any context links for the context menu in the header.

updateMemberTree​

ClientMethod updateMemberTree() [ Language = javascript ]

Update the contents of the member tree.

updateQMSRTree​

ClientMethod updateQMSRTree() [ Language = javascript ]

Update the contents of the qmsr tree.

updatePivotTree​

ClientMethod updatePivotTree() [ Language = javascript ]

Update the contents of the pivot tree.

updateListingsTree​

ClientMethod updateListingsTree() [ Language = javascript ]

Update the contents of the listings tree.

canUserModify​

ClientMethod canUserModify() [ Language = javascript ]

Test if the user has write privilege.

dropOnFilterGroup​

ClientMethod dropOnFilterGroup(dragData) [ Internal, Language = javascript ]

Data drop on filter tgroup area.

mailPivot​

ClientMethod mailPivot() [ Language = javascript ]

email this pivot.

sendMail​

ClientMethod sendMail(url, title) [ Language = javascript ]

Launch the send email dialog. Copy of method in %DeepSee.UserPortal.standardPage.

toggleAutoExecute​

ClientMethod toggleAutoExecute() [ Language = javascript ]

Toggle autoexec mode.

autoExecChange​

ClientMethod autoExecChange() [ Language = javascript ]

Change of auto-exec checkbox.

togglePreviewMode​

ClientMethod togglePreviewMode(id) [ Language = javascript ]

Toggle preview mode. The argument id is unused in the Analyzer case, but is provided to match the signature of the call from the pivot component so a custom page embedding multiple pivots could make use of a custom implementation of this method.

previewModeChange​

ClientMethod previewModeChange() [ Language = javascript ]

Change of preview mode checkbox.

setPreviewMode​

ClientMethod setPreviewMode(setChecked) [ Language = javascript ]

Set the state of preview mode checkbox.

createChartsForSeries​

ClientMethod createChartsForSeries() [ Language = javascript ]

Create additional charts, one per data series.

getSelectedTreeValue​

ClientMethod getSelectedTreeValue() [ Language = javascript ]

Get the value and text of the selected item in the tree (as an object).

actionHandler​

ClientMethod actionHandler(ctrl) [ Language = javascript ]

User chose an action.

SendActionToDataSource​

ClassMethod SendActionToDataSource(pCubeName As %String, pAction As %String, pContext As %ZEN.proxyObject, pPivotVariables As %ZEN.proxyObject = "", pFilters As %ZEN.proxyObject = "") As %String [ Internal, ZenMethod ]

Dispatch DataSource Action back to server-side class.
pContext is a proxy object that carries the server action back to the client.

showDimensionTree​

ClientMethod showDimensionTree(flag) [ Language = javascript ]

changeTreeMode​

ClientMethod changeTreeMode(mode) [ Language = javascript ]

Change display mode for dimension tree.

KillTempSubFolders​

ClassMethod KillTempSubFolders(pFolder As %String) As %String [ ZenMethod ]

KillTempPivot​

ClassMethod KillTempPivot(pPivotName As %String) As %String [ ZenMethod ]

deleteLastPivotResult​

ClientMethod deleteLastPivotResult() [ Language = javascript ]

Helper function to make %DeepSee.Component.pivotTable.DeleteLastResult() server call in asynchronous mode

onlogoutHandler​

ClientMethod onlogoutHandler() [ Language = javascript ]

Ensure that auto-logout is not blocked by onunloadHandler checking for unsaved changes

logout​

ClientMethod logout() [ Language = javascript ]

Override the superclass logout function to delete the last pivotTable query from the local cache before exiting

onunloadHandler​

ClientMethod onunloadHandler() [ Language = javascript ]

runAutosave​

ClientMethod runAutosave() [ Language = javascript ]

Perform an autosave of the current pivot, filed under the current user. This method cotnains only asynchronous calls

CreateQueryNonce​

ClassMethod CreateQueryNonce(pQuery As %String) As %String [ Internal, ZenMethod ]

Generate a nonce for an MDX query.

CreateParameterNonce​

ClassMethod CreateParameterNonce(pParmValue As %String) As %String [ Internal, ZenMethod ]

Generate a nonce for parameter value. This function will perform UTF8 conversion.