IRISLIB database
pivot Class Reference

A specialized DeepSee Dashboard widget that displays a pivot table (either as a table or a chart). More...

Inheritance diagram for pivot:
Collaboration diagram for pivot:

Public Member Functions

_.Library.Status GenerateXSLFO (pWidgetID, pUrl, pMode, pFileName)
 Create an XSLFO file used for merging many exports into a single report.
 
 adjustContentSize (load, width, height)
 Called when page is loaded or widget is resized.
 
 cellClickHandler (pivot)
 Cell click handler for pivot table.
 
 chartClickHandler (chart)
 Select element handler for pivot chart.
 
 chartRangeChange (final)
 Change of time range selector control.
 
 chartRenderHandler ()
 RenderData handler for pivot chart.
 
 closeExportMenu (menuId)
 Close the Excel/CSV export menu and remove the mouse trap.This does nothing if the target. More...
 
 componentSetDisabled (componentId, flag)
 This is an API that can be called from a timer to perform a delayed disable/enable. More...
 
 drillHandler (pivot)
 Drill state change handler for pivot table.
 
 exportCSV (simple)
 Export current query to a CSV file.
 
 exportExcel ()
 Export current query to excel.
 
 exportPDF (printMultiple, preserveTempFiles, filename)
 Export current query to pdf. More...
 
 getDataController ()
 If this widget contains a data controller, return it.
 
 getOverrides ()
 Return an array of current style overrides for this widget. More...
 
 getPivot ()
 Find the pivot table within this widget.
 
 getSubtypeClass ()
 Return the actual type used for a widget subtype (such as "barChart").
 
 hasOverrides ()
 Test if there are any style overrides for this widget.
 
 listingSelectHandler (pivot)
 Listing select handler for pivot table.
 
 navCloseButtonClick (key)
 Click on close button in navigator.
 
 navDataChange (key, value, final)
 Change of data value in navigator.
 
 navHeaderButtonClick (key)
 Click on header button in navigator.
 
 navPopupAction (key, value)
 Popup action in navigator.
 
 onloadHandler ()
 This client event, if present, is fired when the page is loaded.
 
 realCellClickHandler ()
 Cell click handler for pivot table.
 
 resetOverrides (themeOnly, recreate)
 Reset any style overrides for this widget.
 
 resetPivot ()
 Go back to the previous pivot state.
 
 setProperty (property, value, value2)
 Set the value of a named property.
 
 showBreakdown (analysisClass)
 Launch the pivot analysis dialog.
 
 showDimensions ()
 Perform a showDimensions action, if supported. More...
 
 showGeoListing (listing)
 Perform a showGeoListing action.
 
 showListing (listing)
 Perform a showListing action, if supported.
 
 subtypeIsChart (subtype)
 Test if this pivot widget is a chart.
 
 toggleExportMenu (menuId)
 Toggle the state of the target Excel/CSV export menu dropdown. More...
 
- Public Member Functions inherited from widget
_.Library.String ResolveText (pEncodedText)
 Client-visible wrapper for the <method>ResolveText</method> method to translate title text.
 
 adjustSizes (load)
 Called when page is loaded or widget is resized.
 
 closeWidget ()
 Hide a widget. More...
 
 controlEventHandler (which, action, targetProp, value, text)
 This method is called when a control event is sent to this widget. More...
 
 findComponent (id)
 Find a component within this widget with the given sub id.
 
 getDefinition (key)
 Return the definition object for a given widget, if available. More...
 
 getFilterTableForPrinting (parms)
 Find the filters defined for the current widget and return them in a JSON table. More...
 
 getOverrideSkipList (type)
 Return a list of items that should not be saved in override JSON arrays. More...
 
 initializeHomeRowCol ()
 Stores previous values of homeRow and homeCol (widget coordinates). More...
 
 navDataArrange (key, swap, final)
 Re-arrange of a list in navigator.
 
 navSelectItem (key, value, which)
 Select of item in navigator.
 
 openWidget ()
 Open a closed widget. More...
 
 printSVGContent (svgFrameId, parms, svgContent, filename)
 Print SVG content using the svgImageProvider. More...
 
 processAppMessage (value)
 This is called by dragGroupManager when it is given 'processAppMessage' method.
 
 raiseEventHandler (action)
 This method is called an event on this widget (such as click on a chart series) More...
 
 resize (width, height)
 Resize the active group to the given geometry.
 
 selectWidget (evt)
 Select this widget.
 
 setModifiedIfDragged ()
 Sets the "Modified" flag when a widget is dragged. More...
 
 updateMenuBar ()
 Dynamically update Open/Hidden lists in the menu bar when a widget is closed/reopened.
 
- Public Member Functions inherited from dragGroup
 abortClose ()
 Public utility to abort the a window closure in progress.
 
 adjustChildArea ()
 Utility to adjust the size of the dragChildren area in the. More...
 
 adjustHandleWidth ()
 Utility to adjust the width of the drag header to correctly position. More...
 
 adjustResizeBox ()
 Utility to adjust the location of the resize box to correctly position. More...
 
 close (event)
 Callback to close the subwindow.
 
 compress (event)
 Callback to reduce subwindow to the height of its title bar.
 
 constrainDragX (engine, wrapper, intendedX)
 Callback to limit horizontal resizing.
 
 constrainDragY (engine, wrapper, intendedY)
 Callback to limit vertical resizing.
 
 disableDrag ()
 Disable user drag events for this group.
 
 disableHeaderMaxToggle ()
 Reset the maximize toggle mode set up by enableHeaderMaxToggle.
 
 disableResize ()
 Disable user resize events for this group.
 
 enableDrag ()
 Enable user drag events for this group.
 
 enableHeaderMaxToggle ()
 When rendering static windows, enable a click anywhere on the. More...
 
 enableResize ()
 Enable user resize events for this group.
 
 endDrag (engine, wrapper)
 Callback to wrap up window resize event.
 
 expand (event)
 Callback to restore a compressed pane to it miniture display mode.
 
 getChildDiv ()
 Return the HTML div element that wraps the children of this group.
 
 getCoverplateDiv ()
 Return the HTML div element needed as a cover plate for event management under. More...
 
 getHeaderDiv ()
 Return the HTML div element that wraps the header of this group.
 
 getHeaderUserDiv ()
 Return the HTML div element reserver for user content in the header of this group.
 
 getState ()
 Return a string that captures the current state of the group's layout.
 
 getWindowHeight ()
 Return the internal height of the drag window in pixles.
 
 getWindowWidth ()
 Return the internal width of the drag window in pixles.
 
 isCompressed ()
 Returns true if the drag window is currently rendered in. More...
 
 isMaximized ()
 Returns true if the drag window is currently rendered in. More...
 
 isResizeInProgress ()
 Checks to see if the user is actively in the process of resizing the. More...
 
 maximize (event)
 Callback to switch subwindow into full screen mode.
 
 normalize (event)
 Callback to switch a full screen window back down to it previous. More...
 
 onGrabHandler ()
 Launches a callback (if defined) when the drag group is grabbed by. More...
 
 onRefreshContents ()
 Client-side method to ensure that the controller has an accurate model. More...
 
 onReleaseHandler ()
 Launches a callback (if defined) when the drag group's title bar is released. More...
 
 removeWindowChrome ()
 Remove the header entirely and disable resize.
 
 renderContents ()
 Client-side method to render control.
 
 renderHeader ()
 Render the contents of the header section of this component.
 
 renderResize ()
 Add resize box for this component.
 
 resetWindowChrome ()
 Restore header and resize controls previously remove by removeWindowChrome.
 
 restoreGeometry ()
 Restore key layout information about group in after a radical presentation change.
 
 restoreState (str)
 Given a previously encoded layout string, restore a group to its. More...
 
 saveGeometry ()
 Save key layout information about group in anticipation of a radical presentation change.
 
 setBodyStyle (value)
 Set the CSS styles of the header section of the element. More...
 
 setHeaderStyle (value)
 Set the CSS styles of the header section of the element. More...
 
 startDrag (engine, wrapper)
 Callback to initiate window resize event.
 
 syncObject ()
 If the object has been moved or resized inside a snapGrid, sync the server-side. More...
 
- Public Member Functions inherited from group
 LayoutChildren (_.Library.Integer pTuple)
 Does the actual work of laying out the children of this group. 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...
 
 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.
 
 onPopupAction (popupName, action, value)
 This client event, if present, is fired when a popup page has specified. More...
 
 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...
 
 onunloadHandler ()
 This client event, if present, is fired when the page is unloaded. 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...
 
 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 OnNew ()
 This callback method is invoked by the <METHOD>New</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 ChartContent
 chartCloseButtonClick (navigator, chart, key)
 Button clicked in navigator close button.
 
 chartCreateLength (value, units)
 Take a value and units (auto,%,px) and return a css length.
 
 chartDataArrange (navigator, chart, key, swap, final)
 Implementation of the dataArrange method for charts.
 
 chartDataChange (navigator, svg, chart, key, value, final)
 Implementation of the dataChange method for charts.
 
 chartGetContentForLevel (navigator, chart, level, key, value)
 Implementation of the getContentForLevel method for charts.
 
 chartHeaderButtonClick (navigator, chart, key)
 Button clicked in navigator header.
 
 chartParseColorList (colors)
 Split apart a list of color values.
 
 chartParseLength (length, info)
 Parse a "css" length into value and units.
 
 chartSetChartType (svg, chart, type)
 Set the type of the displayed chart.
 
- Public Member Functions inherited from PivotContent
 pivotTableCloseButtonClick (navigator, pivot, key)
 Button clicked in navigator close button.
 
 pivotTableDataArrange (navigator, pivot, key, swap, final)
 This is called when a list within the navigator is rearranged. More...
 
 pivotTableDataChange (navigator, pivot, key, value, final)
 This is called when a data value within the navigator is changed. More...
 
 pivotTableGetContentForLevel (navigator, pivot, level, key, value)
 Return an object describing what to display for this level.
 
 pivotTableHeaderButtonClick (navigator, pivot, key)
 Button clicked in navigator header.
 

Public Attributes

 chartToggle
 Remember the chartToggle state. More...
 
 labelsVisible
 Remember if chart labels are visible. More...
 
 legendPosition
 Remember the legend position. More...
 
 pivotName
 Hold onto the name of the saved pivot (or KPI) that drives this widget. More...
 
- Public Attributes inherited from widget
 backgroundColor
 color of widget background More...
 
 clickActions
 Names of actions to raise for click events. More...
 
 clickActive
 Names of activeWhen values for click events. More...
 
 clickFilterSpec
 Special filter value applied to this widget in response to a click event. More...
 
 clickTargetProperties
 Names of target properties for click events. More...
 
 clickTargets
 Names of target widgets to send click events to. More...
 
 colorToolbar
 color of toolbar More...
 
 controlIndices
 Array of component indices for controls created by this widget. More...
 
 currFilterSpec
 Filter spec for most recently selected item on this widget, if applicable. More...
 
 currItemNo
 Item number for most recently selected item on this widget, if applicable. More...
 
 currSeriesNo
 Series number for most recently selected item on this widget, if applicable. More...
 
 currValue
 Value of most recently selected item on this widget, if applicable. More...
 
 currValueName
 Value name for most recently selected item on this widget, if applicable. More...
 
 dataSource
 Holder for dataSource. More...
 
 filterDefault
 Array of default values of filters on this widget. More...
 
 filterState
 Array of logical names of filters on this widget and their current values. More...
 
 filterText
 Array of logical names of filters on this widget and their current display value. More...
 
 forceToolbar
 Prevent the user from changing the settings for show toolbar. More...
 
 hasInitialFilters
 If true, then there are filter values that have to be applied. More...
 
 isClosed
 isClosed stores the state of a widget More...
 
 linkWidgetKey
 If this widget is linked, then this is the key of the widget we are linked to. More...
 
 maximized
 If true, then this widget should be maximized when it is initially displayed. More...
 
 opacity
 opacity of widget background More...
 
 opacityToolbar
   More...
 
 prevHomeCol
 homeCol value before a widget is dragged More...
 
 prevHomeRow
 homeRow value before a widget is dragged More...
 
 previewMode
 If true, then render in preview mode. More...
 
 sessionCookie
 Current CSP session. More...
 
 settings
 Settings applied to this widget. More...
 
 showSidebar
 Specify whether to display a sidebar. More...
 
 showToolbar
 Specify whether to display a toolbar. More...
 
 showToolbarBottomBorder
 Specify whether to display the separator between the toolbar and widget content. More...
 
 showToolbarOnlyWhenMaximized
 Specify whether to display a toolbar. More...
 
 sidebarContent
 HTML content of sidebar. More...
 
 sidebarWidth
 Width of sidebar area. More...
 
 subtype
 Specify which specific sub-type of widget to display. More...
 
 widgetKey
 Identifying key for the widget. More...
 
 widgetLayout
 A string containing the layout state for this widget: More...
 
- Public Attributes inherited from dragGroup
 centerHeader
 If set, this boolean flag indicates that the title section of the header. More...
 
 colSpan
 If used as a child of a snapGroup, this specifies the (initial static) width of the widget. More...
 
 header
 Title to display in header section for this group. More...
 
 headerLayout
 The header layout pattern determines the order in which control windows are added. More...
 
 homeCol
 If used as a child of a snapGroup, this specifies the (initial static) row hosting the. More...
 
 homeRow
 If used as a child of a snapGroup, this specifies the (initial static) row hosting the. More...
 
 imageAppLogo
 URI of image to display for the close group button. More...
 
 imageAppLogoWidth
 Width (in pixels) of image to display for the close group button. More...
 
 imageClose
 URI of image to display for the close group button. More...
 
 imageCloseHover
 URI of image to display for the close group button when mouse is present. More...
 
 imageCloseWidth
 Width (in pixels) of image to display for the close group button. More...
 
 imageContract
 URI of image to display for the contract group button. More...
 
 imageContractHover
 URI of image to display for the contract group button when mouse is present. More...
 
 imageContractWidth
 Width (in pixels) of image to display for the contract group button. More...
 
 imageExpand
 URI of image to display for the expand group button. More...
 
 imageExpandHover
 URI of image to display for the expand group button when mouse is present. More...
 
 imageExpandWidth
 Width (in pixels) of image to display for the expand group button. More...
 
 imageMaximize
 URI of image to display for the maximize group button. More...
 
 imageMaximizeHover
 URI of image to display for the maximize group button when mouse is present. More...
 
 imageMaximizeWidth
 Width (in pixels) of image to display for the maximize group button. More...
 
 imageMinimize
 URI of image to display for the minimize group button. More...
 
 imageMinimizeHover
 URI of image to display for the minimize group button when mouse is present. More...
 
 imageMinimizeWidth
 Width (in pixels) of image to display for the minimize group button. More...
 
 imageResize
 URI of image to display for the minimize group button. More...
 
 imageResizeSize
 Square area in pixels for the resize icon. More...
 
 minWidth
 This sets the minimum width (in pixels) for a dragGroup during resizing. More...
 
 moveEnabled
 If set, the default, this boolean flag allows the drag group to be repositioned by. More...
 
 onclosepending
 onclosepending event handler: More...
 
 onresize
 onresize event handler: More...
 
 onwindowdrop
 onwindowdrop event handler: More...
 
 onwindowgrab
 onwindowgrab event handler: More...
 
 resizeEnabled
 If set, the default, this boolean flag allows the drag group to be resized by. More...
 
 rowSpan
 If used as a child of a snapGroup, this specifies the (initial static) height of the widget. 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...
 

Private Member Functions

_.Library.String CreateExportDropdown (id, enabled, imgId, help, options)
 A specialized DeepSee Dashboard widget that displays a pivot table (either as a table or a chart). More...
 
_.ZEN.Auxiliary.abstractController GetDataController ()
 If this widget contains a data controller, return it.
 
_.Library.Status OnCreateControls (_.ZEN.Component.group pGroup)
 This callback is called just before controls are added to the top of the widget. More...
 
_.Library.Status OnCreateWidget (_.ZEN.Component.group pGroup)
 This callback is responsible for creating the contents of the widget.
 

Static Private Member Functions

_.Library.Status GetCatalogInfo (_.Library.List pInfo, _.Library.List pSubtypeList)
 Return information used to list this widget within the "widget catalog".
 
_.Library.Status GetWidgetPropertyInfo (_.Library.String pSubtype, _.Library.List pInfo)
 Return information on additional "properties" supported by this widget for the given subtype.
 

Additional Inherited Members

- Static Public Member Functions inherited from widget
_.Library.String GetKpiFilterCaption (pKPIName, pSpec)
 Lookup a filter caption for a KPI.
 
- 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 Attributes inherited from widget
 DEFAULTCLOSEIMAGE = None
 Base class for DeepSee Dashboard widgets. More...
 
 DEFAULTCONTRACTIMAGE = None
 Default image for contract group button.
 
 DEFAULTEXPANDIMAGE = None
 Default image for expand group button.
 
 DEFAULTHEADERLAYOUT = None
 Default header layout pattern. More...
 
 DEFAULTMAXIMAGE = None
 Default image for maximize group button.
 
 DEFAULTMINIMAGE = None
 Default image for minimize group button.
 
 DEFAULTRESIZEICONSIZE = None
 Default resize icon size in pixels.
 
 DEFAULTRESIZEIMAGE = None
 Default image for maximize group button.
 
 PUBLISHED = None
 Set this to false to prevent this widget from being listed.
 
- Static Public Attributes inherited from dragGroup
 DEFAULTCLOSEIMAGE = None
 Default image for close group button.
 
 DEFAULTCONTRACTIMAGE = None
 Default image for contract group button.
 
 DEFAULTENCLOSINGCLASS = None
 Subclasses can set this to change default css class for a group.
 
 DEFAULTEXPANDIMAGE = None
 Default image for expand group button.
 
 DEFAULTHEADERLAYOUT = None
 Default header layout pattern.
 
 DEFAULTLAYOUT = None
 Subclasses can set this to change default layout for a group.
 
 DEFAULTMAXIMAGE = None
 Default image for maximize group button.
 
 DEFAULTMINIMAGE = None
 Default image for minimize group button.
 
 DEFAULTRESIZEICONSIZE = None
 Default resize icon size in pixels.
 
 DEFAULTRESIZEIMAGE = None
 Default image for maximize group button.
 
- 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...
 

Detailed Description

A specialized DeepSee Dashboard widget that displays a pivot table (either as a table or a chart).

Member Function Documentation

◆ CreateExportDropdown()

_.Library.String CreateExportDropdown (   id,
  enabled,
  imgId,
  help,
  options 
)
private

A specialized DeepSee Dashboard widget that displays a pivot table (either as a table or a chart).

Get html to create an icon with an Excel/CSV dropdown menu.

◆ OnCreateControls()

_.Library.Status OnCreateControls ( _.ZEN.Component.group  pGroup)
private

This callback is called just before controls are added to the top of the widget.

pGroup is the header in which new Zen control can be added.

Reimplemented from widget.

◆ closeExportMenu()

closeExportMenu (   menuId)

Close the Excel/CSV export menu and remove the mouse trap.This does nothing if the target.

menu is not open.

◆ componentSetDisabled()

componentSetDisabled (   componentId,
  flag 
)

This is an API that can be called from a timer to perform a delayed disable/enable.

of a prticular component. The target component is referenced by componentId and if that component exists in the DOM, the method will call its
setDisabled(flag)

◆ exportPDF()

exportPDF (   printMultiple,
  preserveTempFiles,
  filename 
)

Export current query to pdf.

If we are in chart mode, export the chart.

◆ getOverrides()

getOverrides ( )

Return an array of current style overrides for this widget.

Used to save to a theme.

Reimplemented from widget.

◆ showDimensions()

showDimensions ( )

Perform a showDimensions action, if supported.

This toggles the visibility

of the dimensions tree control

Reimplemented from widget.

◆ toggleExportMenu()

toggleExportMenu (   menuId)

Toggle the state of the target Excel/CSV export menu dropdown.

When causing the menu

to be displayed, the zenMouseTrap is also activated behind the menu to prevent other interactions.

Member Data Documentation

◆ chartToggle

chartToggle

Remember the chartToggle state.

If "none", show either a chart or a table. If "chart", show the current chart type initially and a button to toggle. If "table", show the table initially and a button to toggle.  

◆ labelsVisible

labelsVisible

Remember if chart labels are visible.

When the widget is too small, we will hide these.  

◆ legendPosition

legendPosition

Remember the legend position.

 

◆ pivotName

pivotName

Hold onto the name of the saved pivot (or KPI) that drives this widget.