IRISLIB database
Analyzer Class Reference

DeepSee Analyzer page. More...

Inheritance diagram for Analyzer:
Collaboration diagram for Analyzer:

Public Member Functions

_.Library.String DeletePivotTable ()
 Delete the pivot table.
 
_.Library.Status DrawCubeName (_.Library.String pSeed)
 Draw cube name above member tree.
 
_.Library.Status OnDrawRibbon ()
 Draw additional stuff in the ribbon bar.
 
_.Library.Status OnGetRibbonInfo (_.Library.Boolean pDisplay, _.Library.List pViewIcons, _.Library.List pSortOptions, _.Library.Boolean pSearchBox, _.Library.String pRibbonTitle, _.Library.List pCommands)
 Get information to display in the ribbon bar.
 
_.Library.String SavePivotTable (_.Library.String pPivotName)
 Save the pivot table. More...
 
_.Library.String SaveTempTables ()
 Save and manage a temp version of this table and a "Last" copy for autosave.
 
 actionHandler (ctrl)
 User chose an action.
 
 addCalculatedMember ()
 Launch the calculated member dialog. More...
 
 addNamedFilter ()
 Launch the add named filter dialog. More...
 
 addPivotVariable ()
 Launch the add pivot variable dialog.
 
 adjustSizes (load)
 Adjust sizes of components on the page.
 
 autoExecChange ()
 Change of auto-exec checkbox.
 
 canUserModify ()
 Test if the user has write privilege.
 
 changeSubjectArea ()
 Launch the subject area finder dialog.
 
 changeTreeMode (mode)
 Change display mode for dimension tree.
 
 chartElementClick (chart)
 User has clicked on a chart element.
 
 collectPrintParameters ()
 Collect the print parameters for this pivot container. More...
 
 constrainDragX (engine, wrapper, intendedX)
 Callback to limit horizontal resizing.
 
 constrainDragY (engine, wrapper, intendedY)
 Callback to limit vertical resizing.
 
 createChartsForSeries ()
 Create additional charts, one per data series.
 
 deleteCalculatedMember (force)
 Delete the selected Calculated Member, named filter, or pivot variable.
 
 deleteLastPivotResult ()
 Helper function to make <class>DeepSee.Component.pivotTable</class>.DeleteLastResult() server call in asynchronous mode.
 
 deletePivot ()
 Delete the pivot table.
 
 endDrag (engine, wrapper)
 Callback to wrap up window resize event.
 
 exportCSV (simple)
 Export current query to a CSV file.
 
 exportExcel ()
 Export current query to excel.
 
 exportPDF ()
 Export current query to PDF.
 
 filterChangeHandler (ctrl, filterNo)
 User has changed a filter control value.
 
 filterDropDown (ctrl)
 Drop down is about to appear for filter control.
 
 getChartType ()
 Get the type of the current chart.
 
 getCurrentChart ()
 Return the current chart, if any.
 
 getGridType ()
 Get the grid type of the current chart.
 
_.Library.String getPageTitle ()
 Get the title string to add to the locator row. More...
 
 getPivot ()
 Return the current pivot table.
 
 getSelectedTreeValue ()
 Get the value and text of the selected item in the tree (as an object).
 
 isCalculatedMember ()
 Test if the current item in the tree is a calculated member. More...
 
 isNamedFilter ()
 Test if the current item in the tree is a named filter. More...
 
 isPivotVariable ()
 Test if the current item in the tree is a pivot variable. More...
 
 loadPivot ()
 Launch the open saved pivot finder dialog.
 
 logout ()
 Override the superclass logout function to delete the last pivotTable query from the local cache before exiting.
 
 mailPivot ()
 email this pivot.
 
 newPivot ()
 Create a new saved pivot.
 
 onPopupAction (popupName, action, value)
 This client event is fired when a popup page launched from this page fires an action.
 
 onlayoutHandler (load)
 Adjust sizes of components on the page.
 
 onlogoutHandler ()
 Ensure that auto-logout is not blocked by onunloadHandler checking for unsaved changes.
 
 onunloadHandler ()
 Check if user really wants to exit if they have not saved changes.
 
 pivot ()
 pivot
 
 pivotTreeChange (tree)
 User has selected a new element in the pivot tree control.
 
 pivotTreeDoubleClick (tree)
 User has double-clicked on an element in the pivot tree control.
 
 pivotVariableChangeHandler (ctrl, varName, varType)
 User has changed a pivot variable control value.
 
 previewModeChange ()
 Change of preview mode checkbox.
 
 restorePivot ()
 WAL053.
 
 runAutosave ()
 Perform an autosave of the current pivot, filed under the current user. More...
 
 savePivot (showDialog)
 Launch the save pivot dialog.
 
 sendMail (url, title)
 Launch the send email dialog. More...
 
 setChartOptions (type, grid, textSize, title, min, max)
 Apply the chart dialog options to the current chart.
 
 setPreviewMode (setChecked)
 Set the state of preview mode checkbox.
 
 setViewModeHandler (mode)
 Do the actual work of updating the view to match the current view mode.
 
 showBreakdown ()
 Launch the pivot analysis dialog.
 
 showChartOptions ()
 Launch the chart options dialog.
 
 showFormatOptions ()
 Launch the cell format options dialog.
 
 showPDFOptions ()
 Launch the pdf options dialog.
 
 showPivotOptions ()
 Launch the pivot options dialog.
 
 showQuery ()
 Launch the show query dialog.
 
 startDrag (engine, wrapper)
 Callback to initiate window resize event.
 
 toggleAutoExecute ()
 Toggle autoexec mode.
 
 togglePreviewMode (id)
 Toggle preview mode. More...
 
 treeChange (tree)
 User has selected a new element in the tree control.
 
 treeDoubleClick (tree)
 User has double-clicked on an element in the tree control.
 
 updateListingsTree ()
 Update the contents of the listings tree.
 
 updateMemberTree ()
 Update the contents of the member tree.
 
 updatePivotTree ()
 Update the contents of the pivot tree.
 
 updateQMSRTree ()
 Update the contents of the qmsr tree.
 
- Public Member Functions inherited from standardPage
 getPageMeta ()
 Clientside fetch of information the client needs to send REST calls to the server, returned as an array.
 
 onloadHandler ()
 This client event, if present, is fired when the page is loaded.
 
 setModified (flag)
 Set the modified flag for the page.
 
 showHelp ()
 Override.
 
_.Library.String switchNamespace ()
 Show dialog to switch namespace.
 
- Public Member Functions inherited from standardPage
_.Library.Status BuildMenu ()
 This method rebuilds context menu on the top left corner.
 
_.Library.Status DrawLocator (_.Library.String pSeed)
 Draw additional content in the locator bar.
 
_.Library.Status DrawRibbon (_.Library.String pSeed)
 Draw the contents of the tool ribbon. More...
 
_.Library.Status DrawTitle (_.Library.String pSeed)
 Draw the contents of the title area. More...
 
_.Library.String changePassword ()
 Show dialog to change password.
 
 getTitleAreaHeight ()
 Return the height of the title area (titleBar plus locator).
 
 goHome ()
 Go to the home page.
 
 goMenu (link)
 Go to the menu link.
 
 gotoNamespace (url)
 Navigate to a new namespace in the portal.
 
 navigate (url)
 Navigate to a new page in the portal.
 
 onServerMethodError (err, errObject)
 Custom handler for hyperEvent handlers to be (optionally) less. More...
 
 searchBlur (evt)
 Blur event in search box.
 
 searchBoxHandler (searchKey)
 Change in search box value. More...
 
 searchFocus (evt)
 Blur event in search box.
 
 searchKeyDown (evt)
 Key down in search box.
 
 searchKeyPress (evt)
 Key press in search box.
 
 setPageTitle (name)
 Set the document name for the page.
 
 setSortMode (mode)
 Change the current sort mode for the page.
 
 setSortModeHandler (mode)
 Do the actual work of updating the view to match the current sort mode.
 
 setViewMode (mode)
 Change the current display mode for this page. More...
 
 setViewModeHandler (mode, oldmode)
 Do the actual work of updating the view to match the current view mode.
 
 showAbout ()
 Go to the about page.
 
 showContact ()
 Go to the about page.
 
- Public Member Functions inherited from page
_.Library.Status DrawJSResources ()
 Local override.
 
_.Library.Status GetJSResources (_.Library.String pResources)
 Local override.
 
 LayoutChildren (_.Library.Integer pTuple)
 Does the actual work of laying out the children of this group. More...
 
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local)
 Local override.
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Local override.
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Local override.
 
- Public Member Functions inherited from abstractPage
_.Library.Boolean DrawFrameSet ()
 If defined, draw out a frameset definition instead of the normal body tags.
 
_.Library.Status OnGetJSResources (_.Library.String pResources)
 Pages can implement this callback method in order to define a set of. More...
 
_.Library.Status OnNew ()
 Note: This is marked as Final. More...
 
 cancelPopup ()
 This client method will cancel a popup page (i.e. More...
 
 correctIELayering (div)
 Correct for an embedded object layering bug that has persisted in IE since the invention. More...
 
 createComponent (name)
 Client-side method to create a Zen component on the client. More...
 
 createComponentNS (ns, name, parent, div)
 Client-side method to create a Zen component on the client. More...
 
 deleteComponent (comp, refresh, sync)
 Client-side method to remove a Zen component from a page on the client. More...
 
 endModal ()
 End the current modal component; restore previous modal item. More...
 
 fireOnResizeEvent ()
 Client-side method: fire onresize event for page component.
 
 fireOnUnloadEvent ()
 Client-side method: fire onunload event for every component that defines one. More...
 
 firePopupAction (action, value, close)
 This client method will notify the parent window of this popup that. More...
 
 getComponent (index)
 Client-side method to find component by component index. More...
 
 getComponentById (id, tuple)
 Client-side method to find a component by user-assigned id value. More...
 
 getOpener ()
 Helper method to get a reference to the window that launched this window. More...
 
 gotoPage (url)
 Set the location of the browser to a new url. More...
 
 launchPopupWindow (url, pageName, features, parms, parent)
 Open a popup window with given url url and page name pageName. More...
 
 onServerMethodCall (method)
 If implemented, this method is called just. More...
 
 onServerMethodReturn (method)
 If implemented, this method is called just. More...
 
 onhandleAutoLogoutWarn ()
 Handle client page modifications while the session is still valid before the page is reloaded. More...
 
 onkeydownHandler (evt)
 This client event, if present, is fired when a keydown event occurs on the page.
 
 onkeyupHandler (evt)
 This client event, if present, is fired when a keyup event occurs on the page.
 
 onoverlayHandler (index)
 This client event, if present, is fired when a component with. More...
 
 onresizeHandler ()
 This client event, if present, is fired when the page is resized.
 
 popupActionHandler (parent, name, action, value)
 Internal method. More...
 
 setComponentId (obj, id)
 Change id of given component.
 
 setTraceOption (name, flag)
 This client method lets you turn the various client-side. More...
 
 startModal (component)
 Make the given component modal; That is all events outside of this. More...
 
- Public Member Functions inherited from group
 setProperty (property, value, value2)
 Set the value of a named property. More...
 
- Public Member Functions inherited from abstractGroup
 addChild (component, refresh)
 Client-side method. More...
 
 addChildAfter (component, sibling, refresh)
 Client-side method. More...
 
 addChildBefore (component, sibling, refresh)
 Client-side method. More...
 
 childrenMutated ()
 Notification to subclasses that a child has been added or removed. More...
 
 exposeComponent ()
 This manages the ondisplay event callback handling. More...
 
 getChildIndex (child)
 Look for the given child object within this group's set of. More...
 
 onRefreshContents ()
 This client event, if present, is fired when the page is loaded.
 
 ondisabledHandler ()
 Client-side method that is called when a group's disabled. More...
 
 removeChild (component)
 Client-side method. More...
 
 setOverlayMode (mode)
 Set overlay mode for each child of this group.
 
 setPropertyAll (property, value, value2)
 Apply the given value to the specified property for. More...
 
- Public Member Functions inherited from component
 dragFinishHandler (dragData)
 This is called when a drag operation started within this component. More...
 
 dragHandler ()
 This is called by the layout manager when a drag-and-drop operation. More...
 
 dragNotifyHandler (dragData)
 This is called by the layout manager when a drag operation. More...
 
 dragStartHandler (dragData)
 This is called when a drag operation is started within this component. More...
 
 dropHandler ()
 This is called by the layout manager when a drag-and-drop operation. More...
 
 dropStartHandler (dragData)
 This is called when a data drop operation is started within this component. More...
 
 getEnclosingDiv ()
 Client-side method returns the div element that encloses. More...
 
_.Library.String getHidden ()
 Return whether this component is hidden.
 
 getHintElement ()
 Client-side method returns the HTML element that displays. More...
 
 getLabelElement ()
 Client-side method returns the HTML element that displays. More...
 
 onDisplayHandler ()
 This client callback is called from exposeComponent after. More...
 
 onEndModalHandler (zindex)
 Notification that this component is about to stop being modal.
 
 onStartModalHandler (zindex)
 Notification that this component is about to become modal. More...
 
 refreshContents (sync)
 This method, called from a client page, invokes this component's. More...
 
 setHidden (flag)
 If flag is true, hide this component. More...
 
 startProgressBar (div)
 Start the display of a progress bar within display. More...
 
 stopProgressBar ()
 Stop the timer used by the Progress bar.
 
- Public Member Functions inherited from object
_.Library.Status OnNew (_.Library.RawString initvalue)
 Constructor for Zen objects. More...
 
 findElement (subid)
 Client-side utility method that finds an HTML element with a. More...
 
 fireOnUpdateEvent ()
 This is called when an object is updated from the server. More...
 
_.Library.String getProperty (property, key)
 Return the value of a named property (i.e. More...
 
 getSettings (settings)
 Client-side method that returns a list of this component's. More...
 
 getType ()
 Returns the component type of this object. More...
 
 invokeSuper (method, args)
 Invoke the superclass method method of the current. More...
 
 isOfType (type)
 Returns true if this object is of the given component type. More...
 
 makeId (subid)
 client-side utility method that constructs a component-specific id More...
 
 onCreate ()
 This client method, if present, is called when this component is. More...
 
 onDelete ()
 This client method, if present, is called when this component is. More...
 
 onSerialize ()
 This client event, if present, is fired before a component. More...
 
 onupdateHandler ()
 This client method, if present, is fired when the object is updated from the server.
 
 render ()
 This causes a component that draws its contents dynamically. More...
 
 renderContents ()
 This method, if present, is called when this component. More...
 
 renderSVG (document, parent)
 This method is only needed for SVG components. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Public Member Functions inherited from Utils
 disableCommandButton (buttonName)
 This method can be called to disable a button in the ribbon bar or a button with id starting with "command_". More...
 
 enableCommandButton (buttonName)
 This method can be called to enable a button in the ribbon bar.
 
 hideCommandButton (buttonName)
 This method can be called to hide a button in the ribbon bar. More...
 
 showCommandButton (buttonName)
 This method can be called to show a button in the ribbon bar.
 

Static Public Member Functions

_.Library.String DeleteNamedFilter (_.Library.String pCubeName, _.Library.String pFilterName)
 Called from client to delete a named filter.
 
_.Library.String DeletePivotVariable (_.Library.String pCubeName, _.Library.String pVariableName)
 Called from client to delete a pivot variable.
 
_.Library.String DeleteSharedCalcMember (pCubeName, pCalcMbrName, pDimension)
 Called from client to delete a shared calculated member.
 
_.Library.Status GetContextLinks (pLinks)
 Define any context links for the context menu in the header.
 
_.Library.Status GetDimensionInfo (_.Library.String pRoot, pTree, pParms)
 Provide contents of the dimension tree.
 
_.Library.Status GetListingFieldsInfo (_.Library.String pRoot, pTree, pParms)
 Provide contents of the listing fields dimension tree.
 
_.Library.Status GetPivotInfo (_.Library.String pRoot, pTree, pParms)
 Provide contents of the saved pivot dimension tree.
 
_.Library.Status GetQMSRInfo (_.Library.String pRoot, pTree, pParms)
 Provide contents of the quality measures dimension tree.
 
_.Library.String UpdateFilterControls (_.Library.String pCubeName, _.ZEN.Component.group pGroup, _.DeepSee.Component.pivotTable pPivotTable)
 Called from client to update list of filters.
 
- Static Public Member Functions inherited from standardPage
_.Library.Status CheckContextLinks (pLinks)
 Helper method to ensure that the user has sufficient privileges to access the links. More...
 
_.Library.String GetCSPURL (_.Library.String link)
 Tranforms the link specified by link into a URL and returns it as a string.
 
_.Library.String GetDocURL (_.Library.String pHelpAddress)
 Given a HelpAddress, this method finds the DocBook Link and constructs the proper URL for the Doc page and return to the client to be displayed.
 
_.Library.String GetNewURL (_.Library.String pNS, _.Library.String pPage)
 Given new namespace, return new URL with new $NAMESPACE. More...
 
_.Library.Status GetQuickLinks (pLinks)
 Define any quick links for the page.
 
- Static Public Member Functions inherited from page
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Local override.
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Local override.
 
- Static Public Member Functions inherited from abstractPage
_.Library.Boolean JavaInstalled ()
 Wrapper method for ZEN.Utils. More...
 
_.Library.Status OnPage ()
 Render the contents of this Zen page.
 
 OnPostHTTP ()
 PostHTTP handler for all Zen pages. More...
 
_.Library.Status OnPostHyperEvent ()
 Event handler which is invoked after a hyperevent method is called on this page.
 
_.Library.Status OnPreHyperEvent (_.Library.String class, _.Library.String method)
 Event handler which is invoked before a hyperevent method is called on all Zen pages. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Member Functions inherited from Page
_.Library.Status ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
 You pass this the <parameter>url</parameter> of the page you are going to and a. More...
 
_.Library.Binary Decrypt (_.Library.String data)
 Decrypts the input string using the session.Key value that is unique to. More...
 
_.Library.String Encrypt (_.Library.Binary data)
 Encrypts the input string using the session.Key value that is unique to this. More...
 
_.Library.String EscapeHTML (in)
 This method converts input HTML text into Escaped HTML text.
 
_.Library.String EscapeURL (_.Library.String in, _.Library.String charset)
 This method converts the in input URL string into Escaped URL string. More...
 
_.Library.String HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
 This method returns the string that needs to be written to the current. More...
 
_.Library.String HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
 This method returns the string that needs to be written to the current. More...
 
 Include (_.Library.String url)
 Include another csp page or file in the output at this point. More...
 
_.Library.String InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
 Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...
 
_.Library.String InsertHiddenFields (_.Library.String url, _.Library.String query)
 Return the string containing the hidden form tags. More...
 
_.Library.Boolean IsPrivate ()
 Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).
 
_.Library.Status OnHTTPHeader (_.Library.Boolean OutputBody)
 Event handler for PAGE event: this is invoked in order to
More...
 
 OnPageError (_.Library.Status sc)
 Event handler for any error that occurs on the page. More...
 
_.Library.Status OnPostHyperEvent (_.Library.String class, _.Library.String method)
 Event handler which is invoked after a hyperevent method is called on this page.
 
_.Library.Status Page (_.Library.Boolean skipheader)
 Process a request to serve a CSPPage. More...
 
_.Library.String QuoteJS (in)
 This method converts input string into quoted JavaScript literal.
 
_.Library.String RewriteURL (_.Library.String url)
 This method will rewrite a URL to use #url()# if needed.
 
 ShowError (_.Library.Status sc)
 Display a <class>Status</class> error code to the CSP Page.
 
 StartTimer (_.Library.String name)
 Used to get performance information on your CSP pages. More...
 
 StopTimer (_.Library.String name)
 Used to time performance information on your CSP pages. More...
 
 ThrowError (_.Library.Status sc)
 Passed a <class>Status</class> code this goes to the error page passing this status code.
 
_.Library.String UnescapeHTML (in)
 This method converts Escaped HTML text into normal HTML text.
 
_.Library.String UnescapeURL (_.Library.String in, _.Library.String charset)
 This method converts the in Escaped URL string back to its original form. More...
 

Public Attributes

 actionCaptions
 List of captions for any actions for the current cube. More...
 
 actionNames
 List of names for any actions for the current cube. More...
 
 analyzerURL
 URL for Analyzer. More...
 
 autoExec
 Initial value of autoexec setting for pivot table. More...
 
 autosave
 Token to load unsaved pivot state. More...
 
 autosaveOverride
 Token to load unsaved pivot state. More...
 
 canWrite
 If true, user can modify (non-read-only) pivots. More...
 
 chartSeriesColors
 Chart series color list. More...
 
 chartSeriesScheme
 Chart series color scheme. More...
 
 cubeFullName
 Name of Cube (with extension). More...
 
 cubeName
 Name of cube to explore. More...
 
 cubeSupportsSqlRestrict
 Flag to indicate whether or not the cube can use the special SQLRESTRICT dimension. More...
 
 hasAnalysis
 If true, use the new analysis dialog. More...
 
 hasPDF
 If true, show the print/pdf option. More...
 
 isEmbedded
 Convenience property. More...
 
 lastLeftWidth
 Token to load unsaved pivot state. More...
 
 multiChart
 If true, show one chart for each data series. More...
 
 noTitle
 If true, then do not display the title area of this page. More...
 
 pivotCategory
 Category of the saved pivot. More...
 
 pivotDescription
 Description of the saved pivot (if any). More...
 
 pivotKeywords
 Keywords of the saved pivot (if any). More...
 
 pivotLocked
 Locked state of the saved pivot. More...
 
 pivotName
 Name of saved pivotTable to view (overrides CUBE if present). More...
 
 pivotOwner
 Owner of the saved pivot (if any). More...
 
 pivotPublic
 Public state of the saved pivot. More...
 
 pivotResource
 Resource of the saved pivot (if any). More...
 
 previewMode
 Initial value of previewMode setting for the Analyzer. More...
 
 readOnly
 If true, user cannot modify the current pivot. More...
 
 sessionCookie
 Current CSP session. More...
 
 showDimensions
 If true, show the dimensions tree. More...
 
 tempStorageRoot
 Location of the autosave items. More...
 
 treeMode
 What to show in the dimensions tree. More...
 
 useClientEmail
 If true, send e-mail using client-side mailto application. More...
 
 warnUser
 Flag to indicate whether to warn user of unsaved changes on page unload. More...
 
- Public Attributes inherited from standardPage
 docbookId
   More...
 
 metaData
   More...
 
- Public Attributes inherited from standardPage
 StdTitle
 Define the title that will be displayed within subclasses. More...
 
 aboutPage
 About page URL. More...
 
 contactPage
   More...
 
 currSortMode
 Current sort mode for this page (if applicable). More...
 
 currStep
 For pages with steps, this is the current step (1-based). More...
 
 currViewMode
 If this page has "views", this is the current view type. More...
 
 homePage
 Product home page URL. More...
 
 limitPopups
 Set to true to suppress hyperevent error pop-ups in. More...
 
 pageModified
 True if the contents of this page need to be saved. More...
 
 searchKey
 Current search key value (if applicable). More...
 
- Public Attributes inherited from abstractPage
 backgroundTimerInterval
 This is the interval, in milliseconds, at which timer events are fired in order. More...
 
 cssLevel
 This property specifies what level of CSS support is used by this page. More...
 
 dragAndDrop
 If true, then drag and drop supported is enabled for this page. More...
 
 title
 Title of this page. More...
 
 useSVG
 If true, then the various JavaScript include files for SVG component are included for this page. More...
 
 useSoftModals
 This property specifies whether modal dialogs launched using zenLaunchPopupWindow() should. More...
 
 zenPersistentPopup
 This flag indicates whether the current Zen page should not sever its connection to its. More...
 
- Public Attributes inherited from group
 cellAlign
 Specifies horizontal alignment of cells layed out within this group. More...
 
 cellSize
 Specifies how the size of cells within this group should be calculated (along layout direction). More...
 
 cellStyle
 Specifies additional style for cells layed out within this group. More...
 
 cellVAlign
 Specifies vertical alignment of cells layed out within this group. More...
 
 groupClass
 Optional CSS class used for table displayed by this group. More...
 
 groupStyle
 Optional style used for table displayed by this group. More...
 
 labelPosition
 Specifies where labels should be displayed for components within this group. More...
 
 layout
 Specifies how components within this group should be layed out. More...
 
 onclick
 onclick event handler: More...
 
- Public Attributes inherited from abstractGroup
 children
 Set of components within this group. More...
 
 disabled
 If true, this group and its children are disabled. More...
 
- Public Attributes inherited from component
 align
 Specifies how this component should be horizontally aligned within its layout cell. More...
 
 containerStyle
 CSS style applied to the td element used to contain this child component within. More...
 
 dragEnabled
 If this value is true and dragAndDrop is enabled for the page, then. More...
 
 dropEnabled
 If this value is true and dragAndDrop is enabled for the page, then. More...
 
 enclosingClass
 Optional CSS class used for this component's enclosing div. More...
 
 enclosingStyle
 Optional CSS style applied to this component's enclosing div. More...
 
 error
 Run-time value; Set to indicate an error within this component. More...
 
 height
 Specifies the height of this component with respect to its container. More...
 
 hidden
 If true, this component is hidden. More...
 
 hint
 User defined hint text used to display additional hint text for this component. More...
 
 hintClass
 Optional CSS class used for the component hint. More...
 
 hintStyle
 User defined style used for the component hint. More...
 
 label
 User defined label used to label this component. More...
 
 labelClass
 Optional CSS class used for the component label. More...
 
 labelDisabledClass
 Optional CSS class used for the component label when disabled. More...
 
 labelStyle
 User defined style used for the component label. More...
 
 onafterdrag
 onafterdrag event handler: More...
 
 onbeforedrag
 onbeforedrag event handler: More...
 
 ondrag
 ondrag event handler: More...
 
 ondrop
 ondrop event handler: More...
 
 onhide
 onhide event handler: More...
 
 onrefresh
 onrefresh event handler: More...
 
 onshow
 onshow event handler: More...
 
 showLabel
 Controls whether a label is displayed for this component. More...
 
 slice
 User-defined number of units of relative space this. More...
 
 title
 Help text (tool tip) displayed when mouse hovers over this component (or its label). More...
 
 valign
 Specifies how this component should be vertically aligned within its layout cell. More...
 
 width
 Specifies the width of this component with respect to its container. More...
 
- Public Attributes inherited from object
 aux
 @qualifier final This is an auxiliary property that is provided More...
 
 composite
 @qualifier final For components that are created as part of a composite component, More...
 
 id
 @qualifier final This is a unique identifier that is used to distinguish this object More...
 
 index
 @qualifier final System-assigned index number used internally to identify this component. More...
 
 name
 @qualifier final Name of this object. More...
 
 onupdate
 onupdate event handler: More...
 
 parent
 @qualifier final Link to the component that contains this object More...
 
 tuple
 @qualifier final Special property indicating which tuple of a More...
 
 visible
 This property indicates whether a component is visible and thus layed out. More...
 
 window
 @qualifier final This is a client-only property that refers to the JavaScript More...
 
- Public Attributes inherited from abstractRefreshable
 enableAutoRefresh
 True if pages in the management portal are permitted to use auto-refresh behaviour. More...
 

Static Public Attributes

 ANALYZERURL = None
 URL for Analyzer.
 
 DEFAULTVIEWMODE = None
 If this page has multiple views, this is its initial display mode.
 
 USERMODE = None
 If true, we are launched from the USER portal.
 
- Static Public Attributes inherited from standardPage
 DOCBOOKID = None
 Docbook ID for this page.
 
 FAVORITEICON = None
 favorite icon.
 
 RESOURCE = None
 All Analytics pages require DeepSee_Portal USE.
 
- Static Public Attributes inherited from standardPage
 APPLICATION = None
 Set this to the appropriate application class.
 
 AUTONS = None
 If true, auto-switch namespace to whatever $NAMESPACE is passed in.
 
 DEFAULTSORTMODE = None
 If this page has sort options, this is its initial sort mode.
 
 DEFAULTVIEWMODE = None
 If this page has multiple views, this is its initial display mode.
 
 DOMAIN = None
 Set this to the correct domain.
 
 FAVORITEICON = None
 SMP favorite icon.
 
 HOMEPAGE = None
 URL of home page (used in links by many pages via <property>homePage</property>.)
 
 IFRAMEALLOWED = None
 Allow pages to have iframes by not setting x-frame-options: same origin. More...
 
 PAGENAME = None
 Name of this page.
 
 RECENT = None
 If true, register visits to this page in the recent list.
 
 SHOWNAMESPACE = None
 If true, show the Namespace dropdown.
 
- Static Public Attributes inherited from page
 POSTCOMPILEACTIONS = None
 Internal parameter. More...
 
 VALIDATEXML = None
 Validate user pages.
 
 XMLINCLUDEINGROUP = None
 User pages do not have an XML representation.
 
 XMLNAME = None
 Reset XMLNAME parameter.
 
- Static Public Attributes inherited from abstractPage
 APPLICATION = None
 This is the class name of this application this page belongs to. More...
 
 AUTOLOGOUT = None
 If true, then attempt to refresh this page when its session timeout period has expired. More...
 
 AUTONS = None
 If true, auto-switch namespace to whatever $NAMESPACE is passed in.
 
 CHECKMODIFIEDBEFORELOGOUT = None
 If true and AUTOLOGOUT is true then call onhandleAutoLogout 30 seconds. More...
 
 CLIENTCACHE = None
 If false (the default) disable browser caching of pages.
 
 CSS3INCLUDES = None
 Comma-separated list of additional CSS3 include files for the page. More...
 
 CSSINCLUDES = None
 Comma-separated list of additional CSS include files for the page. More...
 
 DOMAIN = None
 Localization domain.
 
 ERRORDIVID = None
 The id of the <div> element used to display errors encountered in the page definition. More...
 
 FAVORITEICON = None
 If defined, this is the url of the "favorite" (or shortcut) icon to display for this page. More...
 
 HTMLATTRS = None
 If defined, this string will be written as attributes within the html element at. More...
 
 HTMLDOCTYPE = None
 If HTMLDTD is true we will look here for the DOCTYPE declaration. More...
 
 HTMLDTD = None
 If true, draw an HTML Document Type Declaration at the start of this page.
 
 IFRAMEALLOWED = None
 Allow pages to have iframes by not setting x-frame-options: same origin. More...
 
 INLINESVG = None
 Experimental parameter. More...
 
 JSINCLUDES = None
 Comma-separated list of additional JS include files for the page.
 
 PAGENAME = None
 Optional. More...
 
 PAGETITLE = None
 Optional. More...
 
 RESOURCE = None
 This is a comma-delimited list of system Resources and associated. More...
 
 SHOWSTATS = None
 If true, then display server statistics (within a comment) at the end of this page.
 
 SYSTEMMODULES = None
 Comma-separated list of Zen library modules whose HTML class. More...
 
 USERPACKAGES = None
 Comma-separated list of User class packages whose HTML class. More...
 
 USERSVGPACKAGES = None
 Comma-separated list of User class packages whose SVG class. More...
 
 VALIDATEXML = None
 If true, validate XML Contents using the Zen schema.
 
- Static Public Attributes inherited from group
 DEFAULTCELLALIGN = None
 Subclasses can set this to change default cellAlign for a group.
 
 DEFAULTCELLSIZE = None
 Subclasses can set this to change default cellSize for a group.
 
 DEFAULTCELLSTYLE = None
 Subclasses can set this to change default cellStyle for a group.
 
 DEFAULTCELLVALIGN = None
 Subclasses can set this to change default cellVAlign for a group.
 
 DEFAULTGROUPCLASS = None
 Subclasses can set this to change default css class for a group.
 
 DEFAULTGROUPSTYLE = None
 Subclasses can set this to change default groupStyle for a group.
 
 DEFAULTLABELPOSITION = None
 Subclasses can set this to change default labelPosition for a group.
 
 DEFAULTLAYOUT = None
 Subclasses can set this to change default layout for a group.
 
- Static Public Attributes inherited from abstractGroup
 DEFAULTGROUPCLASS = None
 Subclasses can set this to change default css class for a group.
 
- Static Public Attributes inherited from component
 DEFAULTENCLOSINGCLASS = None
 Subclasses can set this to change default enclosingClass used for this. More...
 
 DEFAULTHEIGHT = None
 Subclasses can set this to change default height for a component.
 
 DEFAULTHIDDEN = None
 Subclasses can set this to change default hidden property for a component.
 
 DEFAULTHINTCLASS = None
 Subclasses can set this to change default css class used for hints.
 
 DEFAULTLABELCLASS = None
 Subclasses can set this to change default css class used for labels.
 
 DEFAULTLABELDISABLEDCLASS = None
 Subclasses can set this to change default css class used for disabled labels.
 
 DEFAULTVISIBLE = None
 Subclasses can set this to change default visibilty for a component.
 
 DEFAULTWIDTH = None
 Subclasses can set this to change default width for a component.
 
- Static Public Attributes inherited from object
 DEFAULTVISIBLE = None
 Subclasses can set this to change default visibilty for a component.
 
 INCLUDEFILES = None
 CSV list of additional include files (either .js or .css) that. More...
 
 MODULE = None
 If set, this indicates that this system component should be. More...
 
 NAMESPACE = None
 This is the XML namespace used for library components.
 
 POSTCOMPILEACTIONS = None
 This is a comma-delimited list of which post-compile actions this component. More...
 
 USECOMMONDIRECTORY = None
 If true, then the include files generated for this component, are placed in the. More...
 
 XMLFORMAT = None
 If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 
- Static Public Attributes inherited from Page
 CHARSET = None
 The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...
 
 CONTENTTYPE = None
 Specifies the default content type for the page. More...
 
 CONVERTINPUTSTREAM = None
 Specifies if input request.Content or request.MimeData values are converted from their. More...
 
 CSPFILE = None
 If this page was compiled from a .csp file, then this parameter contains the. More...
 
 CSPSTRICT = None
 The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...
 
 CSPURL = None
 This parameter is used to make sure that if multiple. More...
 
 CSPXHTML = None
 The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...
 
 DOMAIN = None
 The default domain for csp:text, span and div tags. More...
 
 ENCODED = None
 Controls how the query parameters for this page are passed, it can. More...
 
 ERRORPAGE = None
 Specify a custom error page to call if there are any problems with generating this page. More...
 
 EXPIRES = None
 Specified the default value for the response.Expires. More...
 
 NOCHARSETCONVERT = None
 Specifies if we wish to turn off charset conversion for this page. More...
 
 PAGETIMING = None
 If this parameter is true then we automatically record timing statistics of how long it takes to. More...
 
 PRIVATE = None
 Controls the access to the page, it can be set to one of the following:
More...
 
 SECURITYRESOURCE = None
 This is a comma-delimited list of system Resources and associated. More...
 
 TIMINGSLOTS = None
 Used by the timing to decide how many slots a day should be divided up into. More...
 
 UseSession = None
 This parameter controls the CSP session support. More...
 

Private Member Functions

_.Library.Status GetLocatorLinks (pLink)
 Return the array of links to show in the locator bar. More...
 
_.Library.Status OnAfterCreatePage ()
 This class method callback is called just before the server-side page. More...
 
_.Library.Status OnDrawHTMLHead ()
 Add include files to support color schemes.
 
_.Library.String OnGetPageName ()
 Get the name for the page.
 
_.Library.String OnGetProductName ()
 Get the product name for the page.
 
_.Library.String OnGetTitle ()
 Get the (localized) title string for the page.
 

Static Private Member Functions

_.Library.Status CreateFilterControls (_.Library.String pCubeName, _.ZEN.Component.abstractGroup pGroup, _.DeepSee.Component.pivotTable pPivot)
 Create the set of filter controls along the top of the pivot table. More...
 
_.Library.Status FindPivotVariables (_.Collection.AbstractList pList, pVariables)
 Get list of pivot variables within the given collection.
 
_.Library.Boolean OnPreHTTP ()
 Zen page notification of an HTTP request. More...
 

Detailed Description

Member Function Documentation

◆ CreateFilterControls()

_.Library.Status CreateFilterControls ( _.Library.String  pCubeName,
_.ZEN.Component.abstractGroup  pGroup,
_.DeepSee.Component.pivotTable  pPivot 
)
staticprivate

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.

◆ GetLocatorLinks()

_.Library.Status GetLocatorLinks (   pLink)
private

Return the array of links to show in the locator bar.


pLink(n)=$LB(caption,link)

Reimplemented from standardPage.

◆ OnAfterCreatePage()

_.Library.Status OnAfterCreatePage ( )
private

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

object is created.

Reimplemented from standardPage.

◆ OnPreHTTP()

_.Library.Boolean OnPreHTTP ( )
staticprivate

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.

Reimplemented from abstractPage.

◆ SavePivotTable()

_.Library.String SavePivotTable ( _.Library.String  pPivotName)

Save the pivot table.

If the optional pPivotTable 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.

◆ addCalculatedMember()

addCalculatedMember ( )

Launch the calculated member dialog.

◆ addNamedFilter()

addNamedFilter ( )

Launch the add named filter dialog.

◆ collectPrintParameters()

collectPrintParameters ( )

Collect the print parameters for this pivot container.

This includes both URL parameters (ALL CAPS) and parameters specific to the

SVG printing utility.

◆ getPageTitle()

_.Library.String getPageTitle ( )

Get the title string to add to the locator row.

This should be implemented in a subclass.

Reimplemented from standardPage.

◆ isCalculatedMember()

isCalculatedMember ( )

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()

isNamedFilter ( )

Test if the current item in the tree is a named filter.

If so, return the filter name else return ''.

◆ isPivotVariable()

isPivotVariable ( )

Test if the current item in the tree is a pivot variable.

If so, return the variable name else return ''.

◆ runAutosave()

runAutosave ( )

Perform an autosave of the current pivot, filed under the current user.

This method cotnains only asynchronous calls

◆ sendMail()

sendMail (   url,
  title 
)

Launch the send email dialog.

Copy of method in DeepSee.UserPortal.standardPage.

◆ togglePreviewMode()

togglePreviewMode (   id)

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.

Member Data Documentation

◆ actionCaptions

actionCaptions

List of captions for any actions for the current cube.

 

◆ actionNames

actionNames

List of names for any actions for the current cube.

 

◆ analyzerURL

analyzerURL

URL for Analyzer.

 

◆ autoExec

autoExec

Initial value of autoexec setting for pivot table.

 

◆ autosave

autosave

Token to load unsaved pivot state.

 

◆ autosaveOverride

autosaveOverride

Token to load unsaved pivot state.

 

◆ canWrite

canWrite

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

 

◆ chartSeriesColors

chartSeriesColors

Chart series color list.

 

◆ chartSeriesScheme

chartSeriesScheme

Chart series color scheme.

 

◆ cubeFullName

cubeFullName

Name of Cube (with extension).

 

◆ cubeName

cubeName

Name of cube to explore.

 

◆ cubeSupportsSqlRestrict

cubeSupportsSqlRestrict

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

 

◆ hasAnalysis

hasAnalysis

If true, use the new analysis dialog.

 

◆ hasPDF

hasPDF

If true, show the print/pdf option.

 

◆ isEmbedded

isEmbedded

Convenience property.

Setting this true is equivalent to

NOTITLE=1  

◆ lastLeftWidth

lastLeftWidth

Token to load unsaved pivot state.

 

◆ multiChart

multiChart

If true, show one chart for each data series.

 

◆ noTitle

noTitle

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

 

◆ pivotCategory

pivotCategory

Category of the saved pivot.

 

◆ pivotDescription

pivotDescription

Description of the saved pivot (if any).

 

◆ pivotKeywords

pivotKeywords

Keywords of the saved pivot (if any).

 

◆ pivotLocked

pivotLocked

Locked state of the saved pivot.

 

◆ pivotName

pivotName

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

 

◆ pivotOwner

pivotOwner

Owner of the saved pivot (if any).

 

◆ pivotPublic

pivotPublic

Public state of the saved pivot.

 

◆ pivotResource

pivotResource

Resource of the saved pivot (if any).

 

◆ previewMode

previewMode

Initial value of previewMode setting for the Analyzer.

 

◆ readOnly

readOnly

If true, user cannot modify the current pivot.

 

◆ sessionCookie

sessionCookie

Current CSP session.

 

◆ showDimensions

showDimensions

If true, show the dimensions tree.

 

◆ tempStorageRoot

tempStorageRoot

Location of the autosave items.

 

◆ treeMode

treeMode

What to show in the dimensions tree.

 

◆ useClientEmail

useClientEmail

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

 

◆ warnUser

warnUser

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