|
IRISLIB database
|
|
|
IRISLIB database
|
|
A version of the JSON provider that can use an MDX query or the full name of a stored pivot table to supply data that is served to the client in JSON format. More...
Public Member Functions | |
| _.Library.Status | OnNew (_.Library.RawString initvalue) |
| Constructor for Zen objects. More... | |
 Public Member Functions inherited from altJSONProvider | |
| getContentObject () | |
| Return the client-side JSON data as an object or null. | |
| getContentType () | |
| Return the type of the data supplied by this provider: "object" or "array". | |
| getData (d1, d2, d3) | |
| dataSet API More... | |
| getDataAsArrays () | |
| This is a specialized variant of <method>getData</method>() that. More... | |
| getDataSourceCaption (which, text) | |
| Return a title to display for this data source. More... | |
| getDimSize (dim) | |
| Return the number of items in the specified dimension. More... | |
| getError () | |
| Get the current value of the <property>error</property> property. More... | |
| getLabel (n, dim) | |
| Get the label at position n (0-based) in the given. More... | |
| getPropertyName (n) | |
| Given a 0-based index, return the corresponding property name. | |
| hasData () | |
| Return true if this controller currently contains data. | |
| onloadHandler () | |
| This client event, if present, is fired when the page is loaded. | |
| refreshContent () | |
| Deprecated: use <method>reloadContents</method>(). | |
| reloadContents () | |
| Reload the contents of the provider with data from the server. More... | |
| reloadContentsAsynch (notify, time) | |
| Reload the contents of the json provider asynchronously;. More... | |
| save () | |
| Save data from this dataController back to the DataModel on the server. More... | |
| setContentObject (obj) | |
| Make obj the new target object for this provider. | |
| setContentText (json) | |
| Set the content for this provider using the string json. More... | |
| setContentType (type) | |
| Set the type of the data supplied by this provider: "object" or "array". | |
| submitContent (command, targetClass, notify, time) | |
| Send the current target object for this provider to the server. More... | |
| Public Member Functions inherited from abstractController | |
| createNewObject () | |
| Ask our associated dataModel to create a new (unsaved) instance. | |
| deleteId (id) | |
| Ask our associated dataModel to delete the item with the given id. More... | |
| getDataAsObject (series) | |
| This is a specialized variant of <method>getData</method> that. More... | |
| getDataByName (property, series) | |
| dataBag API More... | |
| getDimensions () | |
| dataSet API More... | |
| getModelId () | |
| Return the current model id associated with this dataController. | |
| getTypeByName (property) | |
| Get the type code for a property given its name. | |
| invokeAction (action, data) | |
| Invoke a named action on our associated dataModel. More... | |
| isModelReadOnly () | |
| Test if the current data model is read-only. | |
| isPropertyValid (property, value) | |
| Test if a given value for a property is valid. | |
| onDelete () | |
| This client method, if present, is called when this component is. More... | |
| raiseDataChange () | |
| Send notification to listeners that the data associated with this dataController has. More... | |
| sendEventToViews (reason, source, data1, data2, data3) | |
| Send an event to all listeners (dataViews) connected to this dataController. More... | |
| setData (value, d1, d2, d3) | |
| dataSet API More... | |
| setDataByName (property, value, series) | |
| dataBag API More... | |
| setModelId (id) | |
| Set the value of the <property>modelId</property> property for this controller. More... | |
| setProperty (property, value, value2) | |
| Set the value of a named property. | |
| update () | |
| Reload the data in the dataController from the server. | |
| Public Member Functions inherited from component | |
| 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... | |
| dropHandler () | |
| This is called by the layout manager when a drag-and-drop operation. More... | |
| exposeComponent () | |
| This manages the ondisplay event callback handling. 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... | |
| onRefreshContents () | |
| This client callback is called just from refreshContents. 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... | |
| setOverlayMode (mode) | |
| Expirimental: do not use. 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 | |
| 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... | |
| onSerialize () | |
| This client event, if present, is fired before a component. More... | |
| 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 | 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 pivotTable | |
| _.Library.String | DeleteLastResult () |
| Deletes the previous session data from the local cache. More... | |
| _.Library.String | SynthesizeMDX (_.Library.Status pSC, _.DeepSee.ResultSet pRS, pParms, pFilterInfo, pAdvancedFilters, _.Library.String pQueryText, pAxes, _.Library.Boolean pDataReady, _.Library.Boolean pComplexQuery, _.Library.Boolean pExecuteBaseQuery, _.Library.Boolean pShowAll) |
| Build the current MDX query text from the current contents of this component. | |
| adjustTableLayout () | |
| Adjust size and position of the layout divs that contain the table. More... | |
| allClick (evt) | |
| Click on all check box (in detail listing). | |
| allClickPivot (evt) | |
| Click on all check box (in pivot). | |
| callFormatValue (value, formattedValue, rowItem, columnItem) | |
| Used to provide label related info when required. | |
| callGetItemSpec (labelInfo, rowItem, columnItem) | |
| Used to provide label related info when required. | |
| callbackExportRStoPDF (dc) | |
| This method is designed to be used as a callback from the DeepSeeDataController. More... | |
| callbackRSPending (dc) | |
| This method is designed to be used as a callback from the DeepSeeDataController. More... | |
| canDrillThrough () | |
| Test if this pivot supports drill through. | |
| canGoBack () | |
| Indicate if we can go back to a prior state. | |
| canGoForward () | |
| Indicate if we can go forward to a visited state. | |
| cancelQuery () | |
| Cancel the current query for this pivot table and. More... | |
| cbClick (evt, currCb) | |
| Click on checkbox. | |
| cbClickPivot (evt, currCb) | |
| Click on checkbox in pivot. | |
| cellClickHandler (evt, row, col) | |
| Notification that a cell is clicked. More... | |
| cellDblClickHandler (evt, row, col) | |
| Notification that a cell is double-clicked. More... | |
| cellMouseDownHandler (evt) | |
| Mouse down within a cell. More... | |
| cellScrollHz () | |
| Horizontal Scroll handler. More... | |
| cellScrollVt () | |
| Vertical Scroll handler. | |
| columnClickHandler (evt, col) | |
| Notification that a column header is clicked. More... | |
| columnDblClickHandler (evt, col) | |
| Notification that a column header is double-clicked. More... | |
| computeTotals () | |
| Compute row and columns totals, as needed. | |
| dateFromHorolog (val) | |
| Convert a $H to yyyy-mm-dd date. | |
| dragFinishHandler (dragData) | |
| This is called when a drag operation started within this component is completed. More... | |
| dragStartHandler (dragData) | |
| Built-in drag handler for pivot table component. More... | |
| drillThrough () | |
| Toggle drill through state of this pivot. More... | |
| dropStartHandler (dragData) | |
| Drop handler. More... | |
| executeListing () | |
| Execute a drill through for the current selected cell. | |
| executeQuery (force) | |
| Execute the current query for this pivot table and. More... | |
| exportToPDF (parms) | |
| This entry point triggers an execution and printing of the current table in SVG format. | |
| filterLabelClick (evt, filterValue) | |
| Click on an item label within the filter dropdown. | |
| firstPage () | |
| For multi-page display, go to the first page. | |
| getColumnDescriptors () | |
| Return an array of column descriptors for use by a dataGrid connected to this pivot. | |
| getData (d1, d2, d3) | |
| dataSet API More... | |
| getDataAsArrays () | |
| This is a specialized variant of <method>getData</method> that. More... | |
| getDataSourceCaption (which, title) | |
| Return a title to display for this data source. More... | |
| getDimName (dim) | |
| Return a name for the given dimension (1,2, or 3). More... | |
| getDimSize (dim) | |
| Return the number of items in the specified dimension. More... | |
| getDrillLevel () | |
| Return current drill level for this pivot. | |
| getFilterForCells (r1, c1, r2, c2, allRows, allCols) | |
| Return the filter spec for the given cell range. | |
| getFilterInfo (fnames, fvalues, flabels) | |
| Return information on current filters. More... | |
| getLabel (n, dim, noformat) | |
| Get the label at position n (0-based) in the given. More... | |
| getListingPageCount () | |
| For multi-page listing display, calculate the number of pages. | |
| getPageCount () | |
| For multi-page display, calculate the number of pages. | |
| getPivotVariableInfo (pnames, pvalues) | |
| Return information on current pivot variables. More... | |
| getPivotVariablesValues (pnames, pvalues) | |
| Return names and values of current pivot variables. More... | |
| getPropertyDim () | |
| Return the ordinal number of the dimension supplying property names for this controller. | |
| getPropertyName (n) | |
| Given a 0-based index, return the corresponding property name. | |
| getRowDescriptors () | |
| Return an array of row descriptors for use by a dataGrid connected to this pivot. | |
| getSelectedItems () | |
| Return an array of the values of the selected items in the pivot table. More... | |
| getSelectedRange () | |
| Return the range of selected cells or null if nothing selected. More... | |
| getValueName () | |
| Return a label for the values returned by the data source. More... | |
| goBack (notify) | |
| Go back to the previous state. | |
| goForward () | |
| Go forward to the next state (if there is one). | |
| gotoDrillLevel (idx) | |
| Go to the given drill level. | |
| gotoPage (page) | |
| For multi-page display, go to specified page (1 is first page), if possible. | |
| hasFormatRules () | |
| Indicate if there are any formatting rules in play. | |
| hideMessage () | |
| Hide the message box. | |
| ieLayout () | |
| Work-around for ie8! | |
| lastPage () | |
| For multi-page display, go to the last page. | |
| listingHeaderDblClickHandler (evt, col) | |
| Notification that a listing header is double-clicked. More... | |
| newDataHandler () | |
| Notification that new data is available. | |
| nextPage () | |
| For multi-page display, go to next page, if possible. | |
| onloadHandler () | |
| This client event, if present, is fired when the page is loaded. | |
| onunloadHandler () | |
| Delete the latest query from local cache in asynchronous mode before unloading. | |
| onupdateHandler () | |
| This client method, if present, is fired when the object is updated from the server. More... | |
| previousPage () | |
| For multi-page display, go to previous page, if possible. | |
| raiseDataChange () | |
| Send notification to listeners that the data associated with this pivotTable has changed. More... | |
| removeAllDrillLevels () | |
| Clear all current drill levels and reset the table back to its resting state. | |
| removeDrillLevel (idx, evt) | |
| Remove a drill level. More... | |
| resetTable () | |
| Reset this table to default settings. | |
| rowClickHandler (evt, row) | |
| Notification that a row header is clicked. More... | |
| rowDblClickHandler (evt, level, row) | |
| Notification that a row header is double clicked. More... | |
| selectCellRange (startRow, startCol, endRow, endCol, allRows, allCols, selectOnly) | |
| Set the selected cell range. More... | |
| sendEventToViews (reason, source, data1, data2, data3) | |
| Send an event to all listeners (dataViews) connected to this dataController. More... | |
| setDrillThrough (flag, force) | |
| Set the drill through state of this pivot to flag. More... | |
| setListing (listing, type) | |
| Set the name of the listing (and listing type) to show for this pivot. | |
| setPivotDisabled (setDisabled) | |
| This prevents a user from interacting with the pivot by using the cover pane. | |
| setProperty (property, value, value2) | |
| Set the value of a named property. More... | |
| showAllRows () | |
| Notification that a listing header is double-clicked. More... | |
| showMDXQuery () | |
| Toggle display of the current query. | |
| showMessage (msg, pct, listing) | |
| Display the message box. More... | |
| showPendingMsg (flag, msg) | |
| Show (or hide) the "computing..." message. | |
| startQueryTimer (needsRefresh) | |
| Start the timer used to update during query calculation. | |
| stopQueryTimer () | |
| Stop the query timer. | |
| swapRowsAndColumns () | |
| Swap the row and column definitions for this table and refresh it. | |
| wheelHandler (evt) | |
| Mouse wheel handler. | |
Public Attributes | |
| OnCreateResultSet | |
| (optional) Name of Server-side callback method to call to create More... | |
| OnExecuteResultSet | |
| (optional) Name of Server-side callback method to call to execute the More... | |
| OnGetMDX | |
| This specifies a callback method that returns an MDX query (string) that will drive this. More... | |
| cubeKey | |
| If defined along with <property>queryKey</property>, the provider can prepare a. More... | |
| mdxQuery | |
| If defined, the provider can generate JSON results from MDX query text. More... | |
| pivotTable | |
| If defined, the provider can generate JSON results from a stored pivot definition. More... | |
| queryKey | |
| If defined along with <property>cubeKey</property>, the provider can prepare a. More... | |
| recordCount | |
| If the provider is using server-side data paging, this is the total number of records. More... | |
| Public Attributes inherited from altJSONProvider | |
| OnGetArray | |
| Supply data for the JSON provider as a server-side array. More... | |
| OnGetTargetObject | |
| Supply data for the JSON provider as a set of server objects. More... | |
| OnRenderJSON | |
| Optional. More... | |
| OnSubmitContent | |
| This callback method is invoked when the client submits an object to the. More... | |
| documentId | |
| Optional. More... | |
| error | |
| Run-time value. More... | |
| parameters | |
| User-defined set of parameters. More... | |
| propertyList | |
| Optional. More... | |
| seriesNameProperty | |
| Optional. More... | |
| targetClass | |
| Class name of the target object expected to be served by this component. More... | |
| Public Attributes inherited from abstractController | |
| alertOnError | |
| @qualifier final If true (the default), then the dataController will display an alert More... | |
| autoRefresh | |
| @qualifier final Setting this to a non-zero value will turn on autoRefresh mode More... | |
| defaultSeries | |
| @qualifier final Optional. More... | |
| modelError | |
| @qualifier final Most recent error message reported by the DataModel object this More... | |
| modelId | |
| @qualifier final ID value passed to the DataModel class. More... | |
| oncreate | |
| @qualifier final oncreate event handler: More... | |
| ondelete | |
| @qualifier final ondelete event handler: More... | |
| onerror | |
| @qualifier final onerror event handler: More... | |
| onnotifyController | |
| @qualifier final onnotifyController event handler: More... | |
| onsave | |
| @qualifier final onsave event handler: More... | |
| readOnly | |
| @qualifier final If true, this data controller is read only regardless of whether its 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 pivotTable | |
| LastCube | |
| Saves the cube name of the latest executed query for clean-up of local cache. More... | |
| LastQueryKey | |
| Saves the query key of the latest executed query for clean-up of local cache. More... | |
| LastSessionKey | |
| Saves the session key of the latest executed query for access and clean-up of local cache. More... | |
| absolutePositioning | |
| More... | |
| allowPreviewInteraction | |
| Allow the user to interact with the pivot even in preview mode. More... | |
| analyzerMode | |
| Special flag to indicate use of pivot within the Analyzer. More... | |
| autoExecute | |
| If true then automatically execute queries when filters, rows, or columns are changed. More... | |
| backgroundImage | |
| Optional image to show in background of pivot table. More... | |
| backgroundOpacity | |
| Opacity (0 to 1) of pivot table background image. More... | |
| borderBottomCell | |
| More... | |
| borderBottomCol | |
| More... | |
| borderBottomRow | |
| More... | |
| borderLeftCell | |
| Table borders. More... | |
| borderLeftCol | |
| More... | |
| borderLeftRow | |
| More... | |
| borderRightCell | |
| More... | |
| borderRightCol | |
| More... | |
| borderRightRow | |
| More... | |
| borderTopCell | |
| More... | |
| borderTopCol | |
| More... | |
| borderTopRow | |
| More... | |
| calculatedMembers | |
| This contains any local calculated members for the table. More... | |
| caption | |
| Caption to display. More... | |
| cellHeight | |
| This is the height (in pixels) used for all cells within the table. More... | |
| cellStyle | |
| Optional style to apply to cells. More... | |
| cellWidth | |
| This is the minimum width (in pixels) used for all cells within the table. More... | |
| changesPending | |
| If autoExecute is off, then this tracks that a refresh is needed. More... | |
| colorScale | |
| If set, this is the name of the color-scaling scheme to apply. More... | |
| columnAxisOptions | |
| This is used to define functions to apply to the entire column axis. More... | |
| columnCount | |
| If present, this is the number of columns returned by the current. More... | |
| columnHeaderStyle | |
| Optional style to apply to column headers. More... | |
| columnLabelSpan | |
| This specifies how parent column labels with multiple child labels are displayed. More... | |
| columnLevels | |
| This contains the definition of the column dimensions for this pivot table. More... | |
| columnList | |
| If defined, then this is a list of columns to display when displaying a KPI-based pivot. More... | |
| contextFilterSpec | |
| Externally applied filter spec. More... | |
| crossJoinRowLimit | |
| Maximum number of rows to display for a CROSSJOIN. More... | |
| cubeName | |
| Name of the cube that will provide data for this pivot table. More... | |
| currListingPage | |
| This is the number (1-based) of the "page" within the listing that is currently displayed. More... | |
| currPage | |
| This is the number (1-based) of the "page" within the query. More... | |
| currentQueryText | |
| Text of most recently executed query. More... | |
| dataSource | |
| Specifies how this pivot table gets data from a DeepSee source. More... | |
| defaultListing | |
| Name of listing to use for the default detail listing. More... | |
| drillLevels | |
| This contains the current set of "drill into" levels for this pivot table. More... | |
| drillRowNumbers | |
| More... | |
| evenRowStyle | |
| Optional style to apply to even rows in zebra stripe mode. More... | |
| filterTableCaptionStyle | |
| filterTableCaptionStyle; More... | |
| filterTableItemStyle | |
| filterTableItemStyle; More... | |
| filterTableStyle | |
| filterTableStyle More... | |
| filters | |
| This contains the definition of the filters for this pivot table. More... | |
| fontFamilyCell | |
| More... | |
| fontFamilyCol | |
| More... | |
| fontFamilyRow | |
| More... | |
| fontSizeCell | |
| More... | |
| fontSizeCol | |
| More... | |
| fontSizeRow | |
| More... | |
| formatRules | |
| This contains any conditional formatting rules for the table. More... | |
| headFunctionAdded | |
| Flag to indicate a HEAD function has been added to an axis by the Analyzer. More... | |
| hiddenMeasureText | |
| More... | |
| hideMeasures | |
| Indicates if and how measures should be displayed. More... | |
| initialExecute | |
| If true, then automatically execute queries when this pivot is first displayed. More... | |
| isDrillThrough | |
| When set true, the current query is executed as a DRILLTHROUGH. More... | |
| jsonRows | |
| Maximum number of data rows emitted as JSON to drive charts. More... | |
| kpi | |
| If defined, then this is the name of the DeepSee KPI class used to provide. More... | |
| listing | |
| Name of listing to use for the current detail listing. More... | |
| listingEnabled | |
| If true, then listings are enabled for this pivot. More... | |
| listingFontSize | |
| Font fize used in listing. More... | |
| listingPageSize | |
| Number of rows to display within one page of a detail listing. More... | |
| listingRowCount | |
| If present, this is the total number of rows returned by the current listing. More... | |
| listingRows | |
| Maximum number of total rows to display within a detail listing. More... | |
| listingSelect | |
| Specifies the select mode for a detail listing: none, "single", or "multi". More... | |
| listingSortColumn | |
| If not 0, then sort the listing table by the values within this column. More... | |
| listingSortDir | |
| If listing column sorting is on, then this is the sort direction. More... | |
| maxChartSize | |
| Certain chart types may have different maximum sizes that make sense. More... | |
| maxRows | |
| Max rows exported to PDF. More... | |
| mdx | |
| If defined and <property>dataSource</property> is set to "manual", then. More... | |
| measureLocation | |
| When there are multiple measures in the measures list, speficies where to. More... | |
| measures | |
| This contains the default measure(s) (e.g., "[Measures].[Sales]") to show for this pivot table. More... | |
| nowDisplayFormat | |
| nowDisplayFormat More... | |
| oncellClick | |
| oncellClick event handler: More... | |
| oncellDblClick | |
| oncellDblClick event handler: More... | |
| ondrill | |
| ondrill event handler: More... | |
| onlistingSelect | |
| onlistingSelect event handler: More... | |
| overrideColumnSpec | |
| Externally applied COLUMNS spec. More... | |
| overrideColumnText | |
| Text value associated with overrideColumnSpec. More... | |
| overrideRowSpec | |
| Externally applied ROWS spec. More... | |
| overrideRowText | |
| Text value associated with overrideRowSpec. More... | |
| pageSize | |
| Number of pivot result rows to show at one time. More... | |
| parameters | |
| User-defined set of parameters. More... | |
| pivotSelect | |
| Specifies the select mode for the pivot table: none, "single", or "multi". More... | |
| previewMode | |
| Initial value of previewMode setting for the Analyzer. More... | |
| previewRowCount | |
| The row limit used to truncate while in SAMPLE mode. More... | |
| printCellWidth | |
| Width of data cells when the pivot is printed. More... | |
| printLabelWidth | |
| Width of row labels when the pivot is printed. More... | |
| printMarginBottom | |
| Page bottom margin when pivot is printed. More... | |
| printMarginLeft | |
| Page left margin when pivot is printed. More... | |
| printMarginRight | |
| Page right margin when pivot is printed. More... | |
| printMarginTop | |
| Page top margin when pivot is printed. More... | |
| printOrientation | |
| Orientation when pivot is printed: "portrait" or "landscape". More... | |
| printPageSize | |
| Page size when pivot is printed. More... | |
| printSubtitle | |
| Subtitle to display when pivot is printed. More... | |
| printSubtitleOn | |
| Display the subtitle when exporting to PDF. More... | |
| printTitle | |
| Title to display when pivot is printed. More... | |
| progressMessage | |
| If set this will contain the current message for display in the progress indicator. More... | |
| reinitialized | |
| More... | |
| resolvedQueryText | |
| Resolved text of most recently executed query. More... | |
| rowAxisOptions | |
| This is used to define functions to apply to the entire row axis. More... | |
| rowCaptionList | |
| More... | |
| rowCount | |
| If present, this is the number of rows returned by the current. More... | |
| rowHeaderStyle | |
| Optional style to apply to row headers. More... | |
| rowLabelSpan | |
| This specifies how parent row labels with multiple child labels are displayed. More... | |
| rowLevels | |
| This contains the definition of the row dimensions for this pivot table. More... | |
| rowsTruncated | |
| This flag is set when the resultset has seen its rows truncated by a HEAD function. More... | |
| selectedCellBackground | |
| Background color applied to the selected cell range. More... | |
| selectedCellColor | |
| Color applied to the selected cell range. More... | |
| selectedRange | |
| This specifies the current selected range of cells as a. More... | |
| showDate | |
| showDate - on, off More... | |
| showEmptyColumns | |
| If true, display columns containing only empty values. More... | |
| showEmptyRows | |
| If true, display rows containing only empty values. More... | |
| showFilters | |
| showFilters - byTable, byTitle, off More... | |
| showListingFilters | |
| showListingFilters - on, off More... | |
| showPivot | |
| If true, then write out HTML for this pivot. More... | |
| showPivotStats | |
| If true, show pivot cell count and total in status area along the bottom of the table. More... | |
| showPlan | |
| If true, execute a show plan for the query. More... | |
| showQuery | |
| If true, show the query used to get results for this table. More... | |
| showRowCaption | |
| If true, show a caption above the row headers. More... | |
| showStatus | |
| If true, show status area along the bottom of the table. More... | |
| showUser | |
| Display the user when exporting to PDF. More... | |
| showZebra | |
| If true, show zebra striping. More... | |
| showZebraStripes | |
| showZebraStripes - on, off More... | |
| singleTable | |
| More... | |
| sortColumn | |
| If not 0, then sort the results by the values within this column. More... | |
| sortDir | |
| If column sorting is on, then this is the sort direction. More... | |
| sqlRestriction | |
| This contains an SQL restriction that should be applied to this pivot table. More... | |
| staleCache | |
| More... | |
| tableStyle | |
| Optional style to apply to entire table. More... | |
| userMDX | |
| If defined, then this holds the user-supplied MDX statement used to. More... | |
| valueColumn | |
| If defined, then this is the name of the column that provides the value for. More... | |
Private Member Functions | |
| _.Library.DynamicArray | ConstructNewDynamicArray () |
| Constructor for a dynamic array. | |
| _.Library.DynamicObject | ConstructNewDynamicObject () |
| Constructor for a dynamic object. | |
| _.Library.Status | Execute () |
| Execute the MDX query or pre-defined pivot table. | |
| _.Library.Status | OnCreateResultSet (_.DeepSee.ResultSet pRS, pParms) |
| This callback is invoked when a provider is about to. More... | |
| _.Library.Boolean | OnExecuteResultSet (_.DeepSee.ResultSet pRS, _.Library.Status tSC, pParms) |
| Internal method. More... | |
Static Private Member Functions | |
| _.Library.Status | ObjectToJSON (_.Library.RegisteredObject pObject, pVisited, _.Library.Integer pLevel, _.Library.String pFormat) |
| Override this method for this provider to override the format and suppress. More... | |
| _.Library.RegisteredObject | StatusToDynamicObject (_.Library.Status pStatus) |
| Convert a Status object into an object that can be emitted as JSON. | |
| _.Library.String | WriteJSONFromMDX (_.Library.String pVar, _.Library.String pMDX, _.Library.Boolean pReturnStatus, _.ZEN.Auxiliary.jsonMDXProvider tProvider) |
| Utility method to allow direct use of JSON from a non-ZEN context (such as a CSP page). More... | |
| _.Library.String | WriteJSONFromPivot (_.Library.String pVar, _.Library.String pPivot, _.Library.Boolean pReturnStatus, _.ZEN.Auxiliary.jsonMDXProvider tProvider) |
| Utility method to allow direct use of JSON from a non-ZEN context (such as a CSP page). More... | |
| _.Library.Status | WriteJSONStreamFromMDX (_.Stream.Object pStream, _.Library.String pMDX, _.Library.Boolean pRewindStream, _.ZEN.Auxiliary.jsonMDXProvider tProvider) |
| Utility method to allow JSON output generated by the MDX query defined in pMDX More... | |
| _.Library.Status | WriteJSONStreamFromPivot (_.Stream.Object pStream, _.Library.String pPivot, _.Library.Boolean pRewindStream, _.ZEN.Auxiliary.jsonMDXProvider tProvider) |
| Utility method to allow JSON output generated by the stored pivot table defined in pPivot More... | |
Additional Inherited Members | |
| 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 pivotTable | |
| _.Library.String | GetItemCaption (_.Library.String pCubeName, _.Library.String pSpec) |
| Return the caption associate with given cube element. | |
| _.Library.Boolean | GetItemSpec (_.ZEN.proxyObject pSpec, _.Library.String pCubeName, _.Library.String pQueryKey, _.Library.String pSortDir, _.Library.String pSortColumn, _.Library.String pAxisName, _.Library.Integer pItemNo, _.Library.Boolean pItemNoSorted) |
| Get the tuple spec for the given item within the query result and place it into the proxy object. More... | |
| _.ZEN.proxyObject | GetPivotVariableData (pCubeName, pVariableName, pValue) |
| Retrieves the meta data about the pivot variable and can convert the logical value. More... | |
| _.Library.Boolean | GetQueryStatus (_.ZEN.proxyObject pObject, _.Library.String pCubeName, _.Library.String pQueryKey, _.Library.String pKPI) |
| Check on the status of the given query. More... | |
| _.Library.String | GetQueryText (_.Library.String pCubeName, _.Library.String pQueryKey, _.Library.Boolean pEncrypt) |
| Get the MDX text for the current query. | |
| _.Library.Boolean | GetSlicerSpecForCells (_.ZEN.proxyObject pSpec, _.Library.String pCubeName, _.Library.String pQueryKey, _.Library.Integer pStartRow, _.Library.Integer pStartCol, _.Library.Integer pEndRow, _.Library.Integer pEndCol, _.Library.Boolean pAllRows, _.Library.Boolean pAllCols, _.Library.Integer pSortCol, _.Library.String pSortDir) |
| Get the slicer spec for the given cell within the query result and place it into the proxy object. More... | |
| _.Library.Boolean | KillQuery (_.Library.String pCubeName, _.Library.String pQueryKey, _.Library.String pNonce) |
| Cancel the query specified by pCubeName and pQueryKey. More... | |
| _.Library.String | ParseMDXExpression (pExpression, pCubeName) |
| Parse an MDX clause representing a collection of cell addresses into a $C(10)-delimited list that can be pssed back to the client. More... | |
| Static Public Attributes inherited from altJSONProvider | |
| DEFAULTVISIBLE = None | |
| This component is not visible. | |
| Static Public Attributes inherited from abstractController | |
| DEFAULTVISIBLE = None | |
| This component is not visible. | |
| 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 pivotTable | |
| DOMAIN = None | |
| Localization domain. | |
| JSINCLUDES = None | |
| Pick up formula code. | |
A version of the JSON provider that can use an MDX query or the full name of a stored pivot table to supply data that is served to the client in JSON format.
This can be used in the same manner as the <class>jsonProvider</class> component.
For example, placing this within your page definition:
<jsonMDXProvider id="mdxProvider" mdxQuery="SELECT FROM HOLEFOODS">
would cause the given MDX statement to execute when the page is requested and the results of the query to be written to the page in JSON format:
o.content = { "AxesInfo": { }, "Info": { "ColCount":0, "Cube":"HOLEFOODS", "CubeKey":"HOLEFOODS", "Error": { "ErrorCode":"", "ErrorMessage":"" }, "ListingSource":"", "MDXText":"SELECT FROM HOLEFOODS", "QueryKey":"en558256763", "QueryType":"SELECT", "ResultsComplete":1, "RowCount":0, "TimeStamp":"2015-05-12 13:23:58" }, "Result": { "Axes":[ ], "CellData":[ { "%ID":"Cell_1", "Format":"", "ValueFormatted":"1,000", "ValueLogical":1000 } ] } };
The JSON content object will contain three major branches AxesInfo, Info, and Result, each of which contain an array of objects that correspond to query structure, metadata, and actual results as returned by the MDX statement.
If you need more control over the MDX query, you can use the <property>OnGetMDX</property> callback method.
This component ignores all of the data source callback methods inherited from the <class>jsonProvider</class> class.
|
staticprivate |
Override this method for this provider to override the format and suppress.
the default inclusion of the class in the JSON output.
Reimplemented from altJSONProvider.
|
private |
This callback is invoked when a provider is about to.
create a result set.
If the callback creates a <class>DeepSee.ResultSet</class> object and returns it via pRS, then the pivot table will use this result set to display results.
|
private |
Internal method.
Subclasses can override this to execute the <class>ResultSet</class> object used to by this component.
Return true (1) if the result set has been executed.
The default implementation is to call the page method specified by the <property>onExecuteResultSet</property> property, if defined.
| _.Library.Status OnNew | ( | _.Library.RawString | initvalue | ) |
Constructor for Zen objects.
If subclasses override OnNew, they should make sure to invoke this using #super.
Reimplemented from pivotTable.
|
staticprivate |
Utility method to allow direct use of JSON from a non-ZEN context (such as a CSP page).
The JSON notation is written out to the current device. pVar is the optional name of the client-side javascript variable that refers to the JSON notation.
pMDX is the MDX statement that is executed and provides the JSON content. Supported query types are SELECT, DRILLTHOUGH, DRILLFACTS.
From a CSP page, you could invoke the method as follows:
#(##class(ZEN.Auxiliary.jsonMDXProvider).WriteJSONFromMDX("json","SELECT NON EMPTY [Channel].[H1].[Channel Name].Members ON 0 FROM [HOLEFOODS]"))#
pReturnStatus controls whether the method will return the execution status. By default this is set to 0 to quit an empty string for compatibility with the #()# syntax.
tProvider allows parameters to be passed in by creating an instance of the jsonMDXProvider and passing it into the method. The value of pMDX will be ignored in this case.
|
staticprivate |
Utility method to allow direct use of JSON from a non-ZEN context (such as a CSP page).
The JSON notation is written out to the current device. pVar is the optional name of the client-side javascript variable that refers to the JSON notation.
pPivot is the full name of a stored pivot that is executed and provides the JSON content.
From a CSP page, you could invoke the method as follows:
#(##class(ZEN.Auxiliary.jsonMDXProvider).WriteJSONFromPivot(,"Use In Dashboards/ProductInfo"))#
pReturnStatus controls whether the method will return the execution status. By default this is set to 0 to quit an empty string for compatibility with the #()# syntax.
tProvider allows parameters to be passed in by creating an instance of the jsonMDXProvider and passing it into the method. The value of pPivot will be ignored in this case.
|
staticprivate |
Utility method to allow JSON output generated by the MDX query defined in pMDX
to be written to the stream supplied in pStream from a general non-ZEN context. Note that pStream will be created if not supplied, hence the ByRef designation.
pRewindStream controls whether the stream should be rewound after the data is written to it.
tProvider allows parameters to be passed in by creating an instance of the jsonMDXProvider and passing it into the method. The value of pMDX will be ignored in this case.
|
staticprivate |
Utility method to allow JSON output generated by the stored pivot table defined in pPivot
to be written to the stream supplied in pStream from a general non-ZEN context. Note that pStream will be created if not supplied, hence the ByRef designation.
pRewindStream controls whether the stream should be rewound after the data is written to it.
tProvider allows parameters to be passed in by creating an instance of the jsonMDXProvider and passing it into the method. The value of pPivot will be ignored in this case.
| OnCreateResultSet |
(optional) Name of Server-side callback method to call to create
a <class>DeepSee.ResultSet</class> object.
This must be the name of a server-only method in the page class that contains this component.
| OnExecuteResultSet |
(optional) Name of Server-side callback method to call to execute the
<class>DeepSee.ResultSet</class> object.
This must be the name of a server-only method in the page class that contains this table pane.
| OnGetMDX |
This specifies a callback method that returns an MDX query (string) that will drive this.
provider. This is identical in behavior to (and replaces) the <property>mdx</property> property. The method can make it easier to create queries based on parameter values or search criteria passed via the <property>criteria</property> property.
| cubeKey |
If defined along with <property>queryKey</property>, the provider can prepare a.
resultset of a query already in progress.
| mdxQuery |
If defined, the provider can generate JSON results from MDX query text.
| pivotTable |
If defined, the provider can generate JSON results from a stored pivot definition.
| queryKey |
If defined along with <property>cubeKey</property>, the provider can prepare a.
resultset of a query already in progress.
| recordCount |
If the provider is using server-side data paging, this is the total number of records.
1.9.1