This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%DeepSee.UI.Analyzer

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

DeepSee Analyzer page.

Property Inventory (Including Private)

Method Inventory (Including Private)

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;
Inherited description: Docbook ID for this page.
parameter PAGENAME = Analyzer;
Inherited description: 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 methods: actionCaptionsBuildValueArray(), actionCaptionsCollectionToDisplay(), actionCaptionsCollectionToOdbc(), actionCaptionsDisplayToCollection(), actionCaptionsDisplayToLogical(), actionCaptionsGet(), actionCaptionsGetObject(), actionCaptionsGetObjectId(), actionCaptionsGetSwizzled(), actionCaptionsIsValid(), actionCaptionsLogicalToDisplay(), actionCaptionsLogicalToOdbc(), actionCaptionsNormalize(), actionCaptionsOdbcToCollection(), actionCaptionsSet(), actionCaptionsSetObject(), actionCaptionsSetObjectId()
property actionNames as list of %ZEN.Datatype.string;
List of names for any actions for the current cube.
Property methods: actionNamesBuildValueArray(), actionNamesCollectionToDisplay(), actionNamesCollectionToOdbc(), actionNamesDisplayToCollection(), actionNamesDisplayToLogical(), actionNamesGet(), actionNamesGetObject(), actionNamesGetObjectId(), actionNamesGetSwizzled(), actionNamesIsValid(), actionNamesLogicalToDisplay(), actionNamesLogicalToOdbc(), actionNamesNormalize(), actionNamesOdbcToCollection(), actionNamesSet(), actionNamesSetObject(), actionNamesSetObjectId()
property analyzerURL as %ZEN.Datatype.string [ InitialExpression = ..#ANALYZERURL ];
URL for Analyzer.
Property methods: analyzerURLDisplayToLogical(), analyzerURLGet(), analyzerURLIsValid(), analyzerURLLogicalToDisplay(), analyzerURLLogicalToOdbc(), analyzerURLNormalize(), analyzerURLSet()
property autoExec as %ZEN.Datatype.boolean (ZENURL = "EXEC") [ InitialExpression = 1 ];
Initial value of autoexec setting for pivot table.
Property methods: autoExecChange(), autoExecDisplayToLogical(), autoExecGet(), autoExecIsValid(), autoExecLogicalToDisplay(), autoExecLogicalToOdbc(), autoExecLogicalToXSD(), autoExecNormalize(), autoExecSet(), autoExecXSDToLogical()
property autosave as %ZEN.Datatype.string (ZENURL = "AUTOSAVE");
Token to load unsaved pivot state.
Property methods: autosaveDisplayToLogical(), autosaveGet(), autosaveIsValid(), autosaveLogicalToDisplay(), autosaveLogicalToOdbc(), autosaveNormalize(), autosaveOverrideDisplayToLogical(), autosaveOverrideGet(), autosaveOverrideIsValid(), autosaveOverrideLogicalToDisplay(), autosaveOverrideLogicalToOdbc(), autosaveOverrideNormalize(), autosaveOverrideSet(), autosaveSet()
property autosaveOverride as %ZEN.Datatype.string (ZENURL = "AUTOSAVEOVERRIDE");
Token to load unsaved pivot state.
Property methods: autosaveOverrideDisplayToLogical(), autosaveOverrideGet(), autosaveOverrideIsValid(), autosaveOverrideLogicalToDisplay(), autosaveOverrideLogicalToOdbc(), autosaveOverrideNormalize(), autosaveOverrideSet()
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) pivots.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWriteSet(), canWriteXSDToLogical()
property chartSeriesColors as %ZEN.Datatype.string;
Chart series color list.
Property methods: chartSeriesColorsDisplayToLogical(), chartSeriesColorsGet(), chartSeriesColorsIsValid(), chartSeriesColorsLogicalToDisplay(), chartSeriesColorsLogicalToOdbc(), chartSeriesColorsNormalize(), chartSeriesColorsSet()
property chartSeriesScheme as %ZEN.Datatype.string;
Chart series color scheme.
Property methods: chartSeriesSchemeDisplayToLogical(), chartSeriesSchemeGet(), chartSeriesSchemeIsValid(), chartSeriesSchemeLogicalToDisplay(), chartSeriesSchemeLogicalToOdbc(), chartSeriesSchemeNormalize(), chartSeriesSchemeSet()
property cubeFullName as %ZEN.Datatype.string (ZENURL = "CUBE");
Name of Cube (with extension).
Property methods: cubeFullNameDisplayToLogical(), cubeFullNameGet(), cubeFullNameIsValid(), cubeFullNameLogicalToDisplay(), cubeFullNameLogicalToOdbc(), cubeFullNameNormalize(), cubeFullNameSet()
property cubeName as %ZEN.Datatype.string;
Name of cube to explore.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property hasAnalysis as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, use the new analysis dialog.
Property methods: hasAnalysisDisplayToLogical(), hasAnalysisGet(), hasAnalysisIsValid(), hasAnalysisLogicalToDisplay(), hasAnalysisLogicalToOdbc(), hasAnalysisLogicalToXSD(), hasAnalysisNormalize(), hasAnalysisSet(), hasAnalysisXSDToLogical()
property hasPDF as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show the print/pdf option.
Property methods: hasPDFDisplayToLogical(), hasPDFGet(), hasPDFIsValid(), hasPDFLogicalToDisplay(), hasPDFLogicalToOdbc(), hasPDFLogicalToXSD(), hasPDFNormalize(), hasPDFSet(), hasPDFXSDToLogical()
property isEmbedded as %ZEN.Datatype.boolean (ZENURL = "EMBED");
Convenience property. Setting this true is equivalent to NOTITLE=1
Property methods: isEmbeddedDisplayToLogical(), isEmbeddedGet(), isEmbeddedIsValid(), isEmbeddedLogicalToDisplay(), isEmbeddedLogicalToOdbc(), isEmbeddedLogicalToXSD(), isEmbeddedNormalize(), isEmbeddedSet(), isEmbeddedXSDToLogical()
property lastLeftWidth as %ZEN.Datatype.integer [ InitialExpression = 300 ];
Token to load unsaved pivot state.
Property methods: lastLeftWidthDisplayToLogical(), lastLeftWidthGet(), lastLeftWidthIsValid(), lastLeftWidthLogicalToDisplay(), lastLeftWidthLogicalToOdbc(), lastLeftWidthNormalize(), lastLeftWidthSet()
property multiChart as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show one chart for each data series.
Property methods: multiChartDisplayToLogical(), multiChartGet(), multiChartIsValid(), multiChartLogicalToDisplay(), multiChartLogicalToOdbc(), multiChartLogicalToXSD(), multiChartNormalize(), multiChartSet(), multiChartXSDToLogical()
property noTitle as %ZEN.Datatype.boolean (ZENURL = "NOTITLE");
If true, then do not display the title area of this page.
Property methods: noTitleDisplayToLogical(), noTitleGet(), noTitleIsValid(), noTitleLogicalToDisplay(), noTitleLogicalToOdbc(), noTitleLogicalToXSD(), noTitleNormalize(), noTitleSet(), noTitleXSDToLogical()
property pivotCategory as %ZEN.Datatype.string;
Category of the saved pivot.
Property methods: pivotCategoryDisplayToLogical(), pivotCategoryGet(), pivotCategoryIsValid(), pivotCategoryLogicalToDisplay(), pivotCategoryLogicalToOdbc(), pivotCategoryNormalize(), pivotCategorySet()
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 pivotLocked as %ZEN.Datatype.boolean;
Locked state of the saved pivot.
Property methods: pivotLockedDisplayToLogical(), pivotLockedGet(), pivotLockedIsValid(), pivotLockedLogicalToDisplay(), pivotLockedLogicalToOdbc(), pivotLockedLogicalToXSD(), pivotLockedNormalize(), pivotLockedSet(), pivotLockedXSDToLogical()
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 pivotOwner as %ZEN.Datatype.string;
Owner of the saved pivot (if any).
Property methods: pivotOwnerDisplayToLogical(), pivotOwnerGet(), pivotOwnerIsValid(), pivotOwnerLogicalToDisplay(), pivotOwnerLogicalToOdbc(), pivotOwnerNormalize(), pivotOwnerSet()
property pivotPublic as %ZEN.Datatype.boolean;
Public state of the saved pivot.
Property methods: pivotPublicDisplayToLogical(), pivotPublicGet(), pivotPublicIsValid(), pivotPublicLogicalToDisplay(), pivotPublicLogicalToOdbc(), pivotPublicLogicalToXSD(), pivotPublicNormalize(), pivotPublicSet(), pivotPublicXSDToLogical()
property pivotResource as %ZEN.Datatype.string;
Resource of the saved pivot (if any).
Property methods: pivotResourceDisplayToLogical(), pivotResourceGet(), pivotResourceIsValid(), pivotResourceLogicalToDisplay(), pivotResourceLogicalToOdbc(), pivotResourceNormalize(), pivotResourceSet()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify the current pivot.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property sessionCookie as %ZEN.Datatype.string;
Current CSP session.
Property methods: sessionCookieDisplayToLogical(), sessionCookieGet(), sessionCookieIsValid(), sessionCookieLogicalToDisplay(), sessionCookieLogicalToOdbc(), sessionCookieNormalize(), sessionCookieSet()
property showDimensions as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show the dimensions tree.
Property methods: showDimensionsDisplayToLogical(), showDimensionsGet(), showDimensionsIsValid(), showDimensionsLogicalToDisplay(), showDimensionsLogicalToOdbc(), showDimensionsLogicalToXSD(), showDimensionsNormalize(), showDimensionsSet(), showDimensionsXSDToLogical()
property tempStorageRoot as %ZEN.Datatype.string [ InitialExpression = "$Temp/Analyzer/" ];
Location of the autosave items
Property methods: tempStorageRootDisplayToLogical(), tempStorageRootGet(), tempStorageRootIsValid(), tempStorageRootLogicalToDisplay(), tempStorageRootLogicalToOdbc(), tempStorageRootNormalize(), tempStorageRootSet()
property treeMode as %ZEN.Datatype.string;
What to show in the dimensions tree.
Property methods: treeModeDisplayToLogical(), treeModeGet(), treeModeIsValid(), treeModeLogicalToDisplay(), treeModeLogicalToOdbc(), treeModeNormalize(), treeModeSet()
property useClientEmail as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, send e-mail using client-side mailto application.
Property methods: useClientEmailDisplayToLogical(), useClientEmailGet(), useClientEmailIsValid(), useClientEmailLogicalToDisplay(), useClientEmailLogicalToOdbc(), useClientEmailLogicalToXSD(), useClientEmailNormalize(), useClientEmailSet(), useClientEmailXSDToLogical()

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.
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.
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.
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.
clientmethod actionHandler(ctrl) [ Language = javascript ]
User chose an action.
clientmethod addCalculatedMember() [ Language = javascript ]
Launch the calculated member dialog..
clientmethod addNamedFilter() [ Language = javascript ]
Launch the add named filter dialog..
clientmethod addPivotVariable() [ Language = javascript ]
Launch the add pivot variable dialog.
clientmethod adjustSizes(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod autoExecChange() [ Language = javascript ]
Change of auto-exec checkbox.
clientmethod canUserModify() [ Language = javascript ]
Test if the user has write privilege.
clientmethod changeSubjectArea() [ Language = javascript ]
Launch the subject area finder dialog.
clientmethod changeTreeMode(mode) [ Language = javascript ]
Change display mode for dimension tree.
clientmethod chartElementClick(chart) [ Language = javascript ]
User has clicked on a chart element.
clientmethod constrainDragX(engine, wrapper, intendedX) [ Language = javascript ]
Callback to limit horizontal resizing
clientmethod constrainDragY(engine, wrapper, intendedY) [ Language = javascript ]
Callback to limit vertical resizing
clientmethod createChartsForSeries() [ Language = javascript ]
Create additional charts, one per data series.
clientmethod deleteCalculatedMember(force) [ Language = javascript ]
Delete the selected Calculated Member, named filter, or pivot variable.
clientmethod deletePivot() [ Language = javascript ]
Delete the pivot table.
clientmethod endDrag(engine, wrapper) [ Language = javascript ]
Callback to wrap up window resize event
clientmethod exportExcel() [ Language = javascript ]
Export current query to excel
clientmethod exportPDF() [ Language = javascript ]
Export current query to PDF.
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 getChartType() [ Language = javascript ]
Get the type of the current chart.
clientmethod getCurrentChart() [ Language = javascript ]
Return the current chart, if any.
clientmethod getFirstTableRow(div) [ Language = javascript ]
clientmethod getGridType() [ Language = javascript ]
Get the grid type of the current chart.
clientmethod getPivot() [ Language = javascript ]
Return the current pivot table.
clientmethod getSelectedTreeValue() [ Language = javascript ]
Get the value and text of the selected item in the tree (as an object).
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.
clientmethod isNamedFilter() [ Language = javascript ]
Test if the current item in the tree is a named filter. If so, return the filter name else return ''.
clientmethod isPivotVariable() [ Language = javascript ]
Test if the current item in the tree is a pivot variable. If so, return the variable name else return ''.
clientmethod loadPivot() [ Language = javascript ]
Launch the open saved pivot finder dialog.
clientmethod mailPivot() [ Language = javascript ]
email this pivot.
clientmethod newPivot() [ Language = javascript ]
Create a new saved pivot.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: Check if user really wants to exit if they have not saved changes
clientmethod pivot() [ Language = javascript ]
pivot
clientmethod pivotTreeChange(tree) [ Language = javascript ]
User has selected a new element in the pivot tree control.
clientmethod pivotTreeDoubleClick(tree) [ Language = javascript ]
User has double-clicked on an element in the pivot tree control.
clientmethod pivotVariableChangeHandler(ctrl, varName, varType) [ Language = javascript ]
User has changed a pivot variable control value.
clientmethod positionResizeHandles(initial) [ Language = javascript ]
clientmethod restorePivot() [ Language = javascript ]
WAL053
clientmethod savePivot(showDialog) [ Language = javascript ]
Launch the save pivot dialog.
clientmethod sendMail(url, title) [ Language = javascript ]
Launch the send email dialog. Copy of method in %DeepSee.UserPortal.standardPage.
clientmethod setChartOptions(type, grid, textSize, title, min, max) [ Language = javascript ]
Apply the chart dialog options to the current chart.
clientmethod setDim(dim, val) [ Language = javascript ]
clientmethod setViewModeHandler(mode As %Library.String, oldmode As %Library.String) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
clientmethod showBreakdown() [ Language = javascript ]
Launch the pivot analysis dialog.
clientmethod showChartOptions() [ Language = javascript ]
Launch the chart options dialog.
clientmethod showDimensionTree(flag) [ Language = javascript ]
clientmethod showFormatOptions() [ Language = javascript ]
Launch the cell format options dialog.
clientmethod showPDFOptions() [ Language = javascript ]
Launch the pdf options dialog.
clientmethod showPivotOptions() [ Language = javascript ]
Launch the pivot options dialog.
clientmethod showQuery() [ Language = javascript ]
Launch the show query dialog.
clientmethod startDrag(engine, wrapper) [ Language = javascript ]
Callback to initiate window resize event
clientmethod toggleAutoExecute() [ Language = javascript ]
Toggle autoexec mode.
clientmethod treeChange(tree) [ Language = javascript ]
User has selected a new element in the tree control.
clientmethod treeDoubleClick(tree) [ Language = javascript ]
User has double-clicked on an element in the tree control.
clientmethod updateListingsTree() [ Language = javascript ]
Update the contents of the listings tree.
clientmethod updateMemberTree() [ Language = javascript ]
Update the contents of the member tree.
clientmethod updatePivotTree() [ Language = javascript ]
Update the contents of the pivot tree.
clientmethod updateQMSRTree() [ Language = javascript ]
Update the contents of the qmsr tree.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback