DocBook|Search
Class Reference
%DeepSee.UI.Analyzer
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%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 25 63


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
aux backgroundTimerInterval canWrite cellAlign
cellSize cellStyle cellVAlign chartSeriesColors
chartSeriesScheme children composite containerStyle
cssLevel cubeFullName cubeName currSortMode
currStep currViewMode disabled docbookId
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
hasAnalysis hasPDF height hidden
hint hintClass hintStyle homePage
id index isEmbedded isModified
label labelClass labelDisabledClass labelPosition
labelStyle layout multiChart name
noTitle onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
pivotDescription pivotKeywords pivotLocked pivotName
pivotOwner pivotPublic pivotResource readOnly
searchKey sessionCookie showDimensions showLabel
slice title tuple useClientEmail
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%%OIDGet %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
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %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 ConvertParameter Decrypt
DeleteNamedFilter DeletePivotTable DoLogout DrawCubeName
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL GetCSPURL GetContextLinks
GetDimensionInfo GetDocPage GetNewURL GetQuickLinks
HyperEventBody HyperEventCall HyperEventFrame HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
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 adjustSizes
autoExecChange canUserModify cancelPopup changePassword
changeSubjectArea chartElementClick childrenMutated correctIELayering
createChartsForSeries createComponent createComponentNS deleteCalculatedMember
deleteComponent deletePivot dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exportExcel exportPDF exposeComponent
filterChangeHandler filterDropDown findElement fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChartType getChildIndex getComponent getComponentById
getCurrentChart getEnclosingDiv getGridType getHidden
getHintElement getLabelElement getOpener getPivot
getProperty getSelectedTreeValue getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage invokeSuper isCalculatedMember isNamedFilter
isOfType 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 popupActionHandler refreshContents
removeChild render renderContents renderSVG
savePivot searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress sendMail setChartOptions
setComponentId setDim setHidden setModified
setOverlayMode setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showBreakdown showChartOptions showDimensionTree
showFormatOptions showHelp showPDFOptions showPivotOptions
showQuery startModal startProgressBar stopProgressBar
switchNamespace toggleAutoExecute treeChange treeDoubleClick
updateMemberTree

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 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 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 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 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 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 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.
• 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.
• 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.
• 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.
• 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 adjustSizes() [ 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 chartElementClick(chart) [ Language = javascript ]
User has clicked on a chart element.
• method createChartsForSeries() [ Language = javascript ]
Create additional charts, one per data series.
• method deleteCalculatedMember() [ Language = javascript ]
Delete the selected Calculated Member or named filter.
• method deletePivot() [ Language = javascript ]
Delete the pivot table.
• 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 getGridType() [ Language = javascript ]
Get the grid type of the current chart.
• 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 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 pivot() [ Language = javascript ]
pivot
• 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 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 toggleAutoExecute() [ Language = javascript ]
Toggle autoexec mode.
• 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 updateMemberTree() [ Language = javascript ]
Update the contents of the member tree.