Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [UI] >  [Analyzer]
Private  Storage   

class %DeepSee.UI.Analyzer extends %DeepSee.UI.standardPage

DeepSee Analyzer page.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 33 98


Summary

This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage actionCaptions
actionNames align analyzerURL autoExec
autosave autosaveOverride aux backgroundTimerInterval
canWrite cellAlign cellSize cellStyle
cellVAlign chartSeriesColors chartSeriesScheme children
composite contactPage containerStyle cssLevel
cubeFullName cubeName cubeSupportsSqlRestrict currSortMode
currStep currViewMode disabled docbookId
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle hasAnalysis hasPDF height
hidden hint hintClass hintStyle
homePage id index isEmbedded
label labelClass labelDisabledClass labelPosition
labelStyle lastLeftWidth layout limitPopups
multiChart name noTitle onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent pivotCategory pivotDescription
pivotKeywords pivotLocked pivotName pivotOwner
pivotPublic pivotResource previewMode readOnly
searchKey sessionCookie showDimensions showLabel
slice tempStorageRoot title treeMode
tuple useClientEmail useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%CreateFilterControls %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %FindPivotVariables %ForceClientRender %GetChildIndex
%GetComponent %GetComponentById %GetComponentByName %GetEventHandlers
%GetLinks %GetLocatorLinks %GetPageName %GetParameter
%GetRootLink %GetValueById %GetValueByName %GetXMLName
%IsA %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage
%OnBeforeCreatePage %OnCreateApplication %OnCreatePage %OnDetermineCSSLevel
%OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta
%OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName %OnGetProductName
%OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion BuildMenu
CheckAutosaveSetting CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DeleteNamedFilter DeletePivotTable DeletePivotVariable
DeleteSharedCalcMember DoLogout DrawCubeName DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL GetCSPURL GetContextLinks GetDimensionInfo
GetDocPage GetListingFieldsInfo GetNewURL GetOverrideValue
GetPivotInfo GetQMSRInfo GetQuickLinks GetTitle
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate KillTempPivot KillTempSubFolders
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL SavePivotTable ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateFilterControls XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType actionHandler addCalculatedMember addChild
addChildAfter addChildBefore addNamedFilter addPivotVariable
adjustSizes autoExecChange canUserModify cancelPopup
changePassword changeSubjectArea changeTreeMode chartElementClick
childrenMutated constrainDragX constrainDragY correctIELayering
createChartsForSeries createComponent createComponentNS deleteCalculatedMember
deleteComponent deletePivot disableCommandButton dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endDrag endModal
exportExcel exportPDF exposeComponent filterChangeHandler
filterDropDown findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChartType getChildIndex
getComponent getComponentById getCurrentChart getEnclosingDiv
getFirstTableRow getGridType getHidden getHintElement
getLabelElement getOpener getPageTitle getPivot
getProperty getSelectedTreeValue getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton invokeSuper isCalculatedMember
isNamedFilter isOfType isPivotVariable launchPopupWindow
loadPivot logout mailPivot makeId
navigate newPivot onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler pivot
pivotTreeChange pivotTreeDoubleClick pivotVariableChangeHandler popupActionHandler
positionResizeHandles previewModeChange refreshContents reloadPage
removeChild render renderContents renderSVG
restorePivot savePivot searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress sendMail
setChartOptions setComponentId setConnectivityStatusMsg setDim
setHidden setModified setOverlayMode setPageTitle
setPreviewMode setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showBreakdown showChartOptions showCommandButton
showContact showDimensionTree showFormatOptions showHelp
showPDFOptions showPivotOptions showQuery startDrag
startModal startProgressBar stopProgressBar switchNamespace
toggleAutoExecute togglePreviewMode treeChange treeDoubleClick
updateListingsTree updateMemberTree updatePivotTree updateQMSRTree

Subclasses
%DeepSee.UserPortal.Analyzer

Parameters

• parameter ANALYZERURL = "_DeepSee.UI.Analyzer.zen";
URL for Analyzer.
• parameter DEFAULTVIEWMODE = "pivot";
If this page has multiple views, this is its initial display mode.
• parameter DOCBOOKID = "D2ANLY_ch_intro";
Docbook ID for this page.
• parameter PAGENAME = "Analyzer";
Name of this page.
• parameter USERMODE = 0;
If true, we are launched from the USER portal.

Properties

• property actionCaptions as list of %ZEN.Datatype.string;
List of captions for any actions for the current cube.
• property actionNames as list of %ZEN.Datatype.string;
List of names for any actions for the current cube.
• property analyzerURL as %ZEN.Datatype.string [ InitialExpression = ..#ANALYZERURL ];
URL for Analyzer.
• property autoExec as %ZEN.Datatype.boolean(ZENURL="EXEC") [ InitialExpression = 1 ];
Initial value of autoexec setting for pivot table.
• property autosave as %ZEN.Datatype.string(ZENURL="AUTOSAVE");
Token to load unsaved pivot state.
• property autosaveOverride as %ZEN.Datatype.string(ZENURL="AUTOSAVEOVERRIDE");
Token to load unsaved pivot state.
• property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) pivots.
• property chartSeriesColors as %ZEN.Datatype.string;
Chart series color list.
• property chartSeriesScheme as %ZEN.Datatype.string;
Chart series color scheme.
• property cubeFullName as %ZEN.Datatype.string(ZENURL="CUBE");
Name of Cube (with extension).
• property cubeName as %ZEN.Datatype.string;
Name of cube to explore.
• property cubeSupportsSqlRestrict as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether or not the cube can use the special %SQLRESTRICT dimension.
• property hasAnalysis as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, use the new analysis dialog.
• property hasPDF as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show the print/pdf option.
• property isEmbedded as %ZEN.Datatype.boolean(ZENURL="EMBED");
Convenience property. Setting this true is equivalent to NOTITLE=1
• property lastLeftWidth as %ZEN.Datatype.integer [ InitialExpression = 300 ];
Token to load unsaved pivot state.
• property multiChart as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show one chart for each data series.
• property noTitle as %ZEN.Datatype.boolean(ZENURL="NOTITLE");
If true, then do not display the title area of this page.
• property pivotCategory as %ZEN.Datatype.string;
Category of the saved pivot.
• property pivotDescription as %ZEN.Datatype.string;
Description of the saved pivot (if any).
• property pivotKeywords as %ZEN.Datatype.string;
Keywords of the saved pivot (if any).
• property pivotLocked as %ZEN.Datatype.boolean;
Locked state of the saved pivot.
• property pivotName as %ZEN.Datatype.string(ZENURL="PIVOT");
Name of saved pivotTable to view (overrides CUBE if present).
• property pivotOwner as %ZEN.Datatype.string;
Owner of the saved pivot (if any).
• property pivotPublic as %ZEN.Datatype.boolean;
Public state of the saved pivot.
• property pivotResource as %ZEN.Datatype.string;
Resource of the saved pivot (if any).
• property previewMode as %ZEN.Datatype.boolean(ZENURL="PREVIEW") [ InitialExpression = 0 ];
Initial value of previewMode setting for the Analyzer.
• property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify the current pivot.
• property sessionCookie as %ZEN.Datatype.string;
Current CSP session.
• property showDimensions as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show the dimensions tree.
• property tempStorageRoot as %ZEN.Datatype.string [ InitialExpression = "$Temp/Analyzer/" ];
Location of the autosave items
• property treeMode as %ZEN.Datatype.string;
What to show in the dimensions tree.
• property useClientEmail as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, send e-mail using client-side mailto application.

Methods

• 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.
• classmethod %FindPivotVariables(pList As %Collection.AbstractList, ByRef pVariables) as %Status
Get list of pivot variables within the given collection.
• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
• method %OnDrawHTMLHead() as %Status
Add include files to support color schemes.
• method %OnGetPageName() as %String
Get the name for the page.
• method %OnGetProductName() as %String
Get the product name for the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod %OnPreHTTP() as %Boolean
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.
• method CheckAutosaveSetting() as %Boolean [ ZenMethod ]
• classmethod DeleteNamedFilter(pCubeName As %String, pFilterName As %String) as %String [ ZenMethod ]
Called from client to delete a named filter.
• method DeletePivotTable() as %String [ ZenMethod ]
Delete the pivot table.
• classmethod DeletePivotVariable(pCubeName As %String, pVariableName As %String) as %String [ ZenMethod ]
Called from client to delete a pivot variable.
• classmethod DeleteSharedCalcMember(pCubeName, pCalcMbrName, pDimension) as %String [ ZenMethod ]
Called from client to delete a shared calculated member.
• method DrawCubeName(pSeed As %String) as %Status
Draw cube name above member tree.
• classmethod GetContextLinks(Output pLinks) as %Status
Define any context links for the context menu in the header.
• classmethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the dimension tree.
• classmethod GetListingFieldsInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the listing fields dimension tree.
• method GetOverrideValue(pToken) as %String [ ZenMethod ]
• classmethod GetPivotInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the saved pivot dimension tree.
• classmethod GetQMSRInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the quality measures dimension tree.
• method GetTitle() as %String [ ZenMethod ]
• classmethod KillTempPivot(pPivotName As %String) as %String [ ZenMethod ]
• classmethod KillTempSubFolders(pFolder As %String) as %String [ ZenMethod ]
• method OnDrawRibbon() as %Status
Draw additional stuff in the ribbon bar
• 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.
• method SavePivotTable() as %String [ ZenMethod ]
Save the pivot table.
• 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.
• method actionHandler(ctrl) [ Language = javascript ]
User chose an action.
• method addCalculatedMember() [ Language = javascript ]
Launch the calculated member dialog..
• method addNamedFilter() [ Language = javascript ]
Launch the add named filter dialog..
• method addPivotVariable() [ Language = javascript ]
Launch the add pivot variable dialog.
• method adjustSizes(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method autoExecChange() [ Language = javascript ]
Change of auto-exec checkbox.
• method canUserModify() [ Language = javascript ]
Test if the user has write privilege.
• method changeSubjectArea() [ Language = javascript ]
Launch the subject area finder dialog.
• method changeTreeMode(mode) [ Language = javascript ]
Change display mode for dimension tree.
• method chartElementClick(chart) [ Language = javascript ]
User has clicked on a chart element.
• method constrainDragX(engine, wrapper, intendedX) [ Language = javascript ]
Callback to limit horizontal resizing
• method constrainDragY(engine, wrapper, intendedY) [ Language = javascript ]
Callback to limit vertical resizing
• method createChartsForSeries() [ Language = javascript ]
Create additional charts, one per data series.
• method deleteCalculatedMember(force) [ Language = javascript ]
Delete the selected Calculated Member, named filter, or pivot variable.
• method deletePivot() [ Language = javascript ]
Delete the pivot table.
• method endDrag(engine, wrapper) [ Language = javascript ]
Callback to wrap up window resize event
• method exportExcel() [ Language = javascript ]
Export current query to excel
• method exportPDF() [ Language = javascript ]
Export current query to PDF.
• method filterChangeHandler(ctrl, filterNo) [ Language = javascript ]
User has changed a filter control value.
• method filterDropDown(ctrl) [ Language = javascript ]
Drop down is about to appear for filter control.
• method getChartType() [ Language = javascript ]
Get the type of the current chart.
• method getCurrentChart() [ Language = javascript ]
Return the current chart, if any.
• method getFirstTableRow(div) [ Language = javascript ]
• method getGridType() [ Language = javascript ]
Get the grid type of the current chart.
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row. This should be implemented in a subclass.
• method getPivot() [ Language = javascript ]
Return the current pivot table.
• method getSelectedTreeValue() [ Language = javascript ]
Get the value and text of the selected item in the tree (as an object).
• method 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.
• method isNamedFilter() [ Language = javascript ]
Test if the current item in the tree is a named filter. If so, return the filter name else return ''.
• method isPivotVariable() [ Language = javascript ]
Test if the current item in the tree is a pivot variable. If so, return the variable name else return ''.
• method loadPivot() [ Language = javascript ]
Launch the open saved pivot finder dialog.
• method mailPivot() [ Language = javascript ]
email this pivot.
• method newPivot() [ Language = javascript ]
Create a new saved pivot.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onlogoutHandler() [ Language = javascript ]
Ensure that auto-logout is not blocked by onunloadHandler checking for unsaved changes
• method onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
• method pivot() [ Language = javascript ]
pivot
• method pivotTreeChange(tree) [ Language = javascript ]
User has selected a new element in the pivot tree control.
• method pivotTreeDoubleClick(tree) [ Language = javascript ]
User has double-clicked on an element in the pivot tree control.
• method pivotVariableChangeHandler(ctrl, varName, varType) [ Language = javascript ]
User has changed a pivot variable control value.
• method positionResizeHandles(initial) [ Language = javascript ]
• method previewModeChange() [ Language = javascript ]
Change of preview mode checkbox.
• method restorePivot() [ Language = javascript ]
WAL053
• method savePivot(showDialog) [ Language = javascript ]
Launch the save pivot dialog.
• method sendMail(url, title) [ Language = javascript ]
Launch the send email dialog. Copy of method in %DeepSee.UserPortal.standardPage.
• method setChartOptions(type, grid, textSize, title, min, max) [ Language = javascript ]
Apply the chart dialog options to the current chart.
• method setDim(dim, val) [ Language = javascript ]
• method setPreviewMode(setChecked) [ Language = javascript ]
Set the state of preview mode checkbox.
• method setViewModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
• method showBreakdown() [ Language = javascript ]
Launch the pivot analysis dialog.
• method showChartOptions() [ Language = javascript ]
Launch the chart options dialog.
• method showDimensionTree(flag) [ Language = javascript ]
• method showFormatOptions() [ Language = javascript ]
Launch the cell format options dialog.
• method showPDFOptions() [ Language = javascript ]
Launch the pdf options dialog.
• method showPivotOptions() [ Language = javascript ]
Launch the pivot options dialog.
• method showQuery() [ Language = javascript ]
Launch the show query dialog.
• method startDrag(engine, wrapper) [ Language = javascript ]
Callback to initiate window resize event
• method toggleAutoExecute() [ Language = javascript ]
Toggle autoexec mode.
• method 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.
• method treeChange(tree) [ Language = javascript ]
User has selected a new element in the tree control.
• method treeDoubleClick(tree) [ Language = javascript ]
User has double-clicked on an element in the tree control.
• method updateListingsTree() [ Language = javascript ]
Update the contents of the listings tree.
• method updateMemberTree() [ Language = javascript ]
Update the contents of the member tree.
• method updatePivotTree() [ Language = javascript ]
Update the contents of the pivot tree.
• method updateQMSRTree() [ Language = javascript ]
Update the contents of the qmsr tree.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.