Class Reference
%DeepSee.Component.pivotTable
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%DeepSee] >  [Component] >  [pivotTable]
Private  Storage

class %DeepSee.Component.pivotTable extends %ZEN.Component.component

Pivot table component.
This component gives users the ability to view and interact with a DeepSee cube or subject area.
The data displayed by the pivot table can be supplied in various ways. This is specified using the dataSource:

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 100 122


Summary

Properties
%condition %import %includeFiles %page
%resource align autoExecute aux
calculatedMembers caption cellHeight cellStyle
cellWidth changesPending colorScale columnAxisOptions
columnCount columnHeaderStyle columnLabelSpan columnLevels
columnList composite containerStyle contextFilterSpec
cubeName currListingPage currPage currentQueryText
dataSource dragEnabled drillLevels dropEnabled
enclosingClass enclosingStyle error evenRowStyle
filters formatRules height hidden
hint hintClass hintStyle id
index initialExecute isDrillThrough kpi
label labelClass labelDisabledClass labelStyle
listing listingEnabled listingPageSize listingRowCount
listingRows listingSelect listingSortColumn listingSortDir
mdx measures name onafterdrag
onbeforedrag oncellClick oncellDblClick ondrag
ondrill ondrop onhide onlistingSelect
onrefresh onshow onupdate pageSize
parameters parent pivotSelect printCellWidth
printLabelWidth printMarginBottom printMarginLeft printMarginRight
printMarginTop printOrientation printPageSize printSubtitle
printTitle rowAxisOptions rowCount rowHeaderStyle
rowLabelSpan rowLevels selectedCellBackground selectedCellColor
selectedRange showEmptyColumns showEmptyRows showLabel
showPivotStats showPlan showQuery showRowCaption
showStatus showZebra slice sortColumn
sortDir title tuple userMDX
valign valueColumn visible width
window

Methods
%%OIDGet %AddToSaveSet %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %CreateResultSet
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawComponentHTML
%DrawDataTable %DrawEmptyTable %DrawHTML %DrawJSStrings
%DrawKPITable %DrawTable %EnclosingDivId %Eval
%Extends %ForceClientRender %GetEventHandlers %GetParameter
%GetSummaryFromCSS %GetXMLName %IsA %IsModified
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnCreateResultSet %OnDrawEnclosingDiv
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ShowPlan %ShowPlanItem %ValidateObject
GetCurrentQueryText GetItemCaption GetItemSpec GetQueryStatus
GetQueryText GetSlicerSpecForCells KillQuery XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType adjustTableLayout
allClick allClickPivot canDrillThrough canGoBack
canGoForward cancelQuery cbClick cbClickPivot
cellClickHandler cellDblClickHandler cellScrollHz cellScrollVt
columnClickHandler columnDblClickHandler computeTotals dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler drillThrough
dropHandler dropStartHandler executeListing executeQuery
exposeComponent filterLabelClick findElement fireOnUpdateEvent
firstPage getData getDataAsArrays getDataByName
getDataSourceCaption getDimName getDimSize getDrillLevel
getEnclosingDiv getFilterForCells getFilterInfo getHidden
getHintElement getLabel getLabelElement getListingPageCount
getPageCount getProperty getPropertyName getSelectedItems
getSelectedRange getSettings getType getValueName
goBack goForward gotoDrillLevel gotoPage
hasFormatRules hideMessage invokeSuper isOfType
lastPage listingHeaderDblClickHandler makeId newDataHandler
nextPage onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onStartModalHandler onloadHandler onunloadHandler onupdateHandler
previousPage raiseDataChange refreshContents removeDrillLevel
render renderContents renderSVG resetTable
rowClickHandler rowDblClickHandler selectCellRange sendEventToViews
setDrillThrough setHidden setListing setOverlayMode
setProperty showIKnowMeasureValue showMDXQuery showMessage
showPendingMsg startProgressBar startQueryTimer stopProgressBar
stopQueryTimer swapRowsAndColumns wheelHandler


Parameters

• parameter DEFAULTENCLOSINGCLASS = "dsPivotEnclosingDiv";
Subclasses can set this to change default enclosingClass used for this component.
• parameter DOMAIN = "%DeepSee";
Localization domain
• parameter MAXCOLUMNS = 100;
• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties

• property autoExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true then automatically execute queries when filters, rows, or columns are changed.
• property calculatedMembers as list of calculatedMember(XMLNAME="calculatedMember",XMLPROJECTION="ELEMENT");
This contains any local calculated members for the table.
• property caption as %ZEN.Datatype.string;
Caption to display. If not specified, the caption for the cube will be used.
• property cellHeight as %ZEN.Datatype.integer [ InitialExpression = 22 ];
This is the height (in pixels) used for all cells within the table. The default is 22.
• property cellStyle as %ZEN.Datatype.style;
Optional style to apply to cells.
• property cellWidth as %ZEN.Datatype.integer [ InitialExpression = 120 ];
This is the width (in pixels) used for all cells within the table. The default is 120.
• property changesPending as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
If autoExecute is off, then this tracks that a refresh is needed.
• property colorScale as %ZEN.Datatype.string;
If set, this is the name of the color-scaling scheme to apply. red-to-black,green-to-black,blue-to-black,salmon-to-black,purple-to-black,gray-to-black or "custom:r1,g1,b1:r2,g2,b2".
• property columnAxisOptions as pivotLevel;
This is used to define functions to apply to the entire column axis.
• property columnCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
If present, this is the number of columns returned by the current query. This is calculated in both user query and automatic query modes.
• property columnHeaderStyle as %ZEN.Datatype.style;
Optional style to apply to column headers.
• property columnLabelSpan as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
This specifies how parent column labels with multiple child labels are displayed.
If true, then one parent label is displayed for each set of children. If false, then the parent row label is repeated for each child.
• property columnLevels as list of pivotLevel(XMLNAME="columnLevel",XMLPROJECTION="ELEMENT");
This contains the definition of the column dimensions for this pivot table.
• property columnList as %ZEN.Datatype.csv;
If defined, then this is a list of columns to display when displaying a KPI-based pivot. Each item in the list can also define a caption: "property:caption,..." as well as a format: "property:caption:format,..."
"," and ":" can be escaped with "\," and "\:"
• property contextFilterSpec as %ZEN.Datatype.string(XMLPROJECTION="NONE");
Externally applied filter spec. This should contain a valid %FILTER clause.
• property cubeName as %ZEN.Datatype.className(ZENEXPRESSION=1);
Name of the cube that will provide data for this pivot table.
• property currListingPage as %ZEN.Datatype.integer [ InitialExpression = 1 ];
This is the number (1-based) of the "page" within the listing that is currently displayed.
• property currPage as %ZEN.Datatype.integer [ InitialExpression = 1 ];
This is the number (1-based) of the "page" within the query results that is currently displayed.
• property currentQueryText as %ZEN.Datatype.string(XMLPROJECTION="none",ZENENCRYPT=1,ZENSETTING=0);
Text of most recently executed query.
• property dataSource as %ZEN.Datatype.string(VALUELIST=",manual,automatic") [ InitialExpression = "automatic" ];
Specifies how this pivot table gets data from a DeepSee source.
• property drillLevels as list of pivotLevel(XMLNAME="drillLevel",XMLPROJECTION="ELEMENT");
This contains the current set of "drill into" levels for this pivot table.
• property evenRowStyle as %ZEN.Datatype.style;
Optional style to apply to even rows in zebra stripe mode.
• property filters as list of pivotLevel(XMLNAME="filter",XMLPROJECTION="ELEMENT");
This contains the definition of the filters for this pivot table.
• property formatRules as list of pivotCondition(XMLNAME="formatRule",XMLPROJECTION="ELEMENT");
This contains any conditional formatting rules for the table.
• property initialExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then automatically execute queries when this pivot is first displayed.
• property isDrillThrough as %ZEN.Datatype.boolean(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
When set true, the current query is executed as a DRILLTHROUGH.
If the current data source is a KPI, then execute a listing provided by the KPI (if available).
• property kpi as %ZEN.Datatype.string;
If defined, then this is the name of the DeepSee KPI class used to provide the contents of the pivot table.
• property listing as %ZEN.Datatype.string;
Name of listing to use for detail listing. If empty, the default listing is used.
• property listingEnabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then listings are enabled for this pivot.
• property listingPageSize as %ZEN.Datatype.integer [ InitialExpression = 1000 ];
Number of rows to display within one page of a detail listing. If empty, the default value (1000) is used.
• property listingRowCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
If present, this is the number of rows returned by the current listing.
• property listingRows as %ZEN.Datatype.integer;
Maximum number of rows to display within a detail listing. If empty, the default value (1000) is used.
• property listingSelect as %ZEN.Datatype.string(VALUELIST=",single,multi");
Specifies the select mode for a detail listing: none, "single", or "multi".
• property listingSortColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If not 0, then sort the listing table by the values within this column.
• property listingSortDir as %ZEN.Datatype.string(VALUELIST="ASC,DESC") [ InitialExpression = "ASC" ];
If listing column sorting is on, then this is the sort direction.
• property mdx as %ZEN.Datatype.string(ZENENCRYPT=1,ZENSETTING=0);
If defined and dataSource is set to "manual", then this is the MDX statement used to provide the contents of the pivot table.
• property measures as list of pivotLevel(XMLNAME="measure",XMLPROJECTION="ELEMENT");
This contains the default measure(s) (e.g., "[Measures].[Sales]") to show for this pivot table.
• property oncellClick as %ZEN.Datatype.eventHandler;
oncellClick event handler: This event handler is called by the pivot when the user clicks the mouse on a cell within the pivot table.
The event handler is passed an argument, pivot, that is this pivot table object.
• property oncellDblClick as %ZEN.Datatype.eventHandler;
oncellDblClick event handler: This event handler is called by the pivot when the user double clicks the mouse on a cell within the pivot table.
The event handler is passed an argument, pivot, that is this pivot table object.
• property ondrill as %ZEN.Datatype.eventHandler;
ondrill event handler: This event handler is called by the pivot whenever the drill down state of the pivot is changed.
The event handler is passed an argument, pivot, that is this pivot table object.
• property onlistingSelect as %ZEN.Datatype.eventHandler;
onlistingSelect event handler: This event handler is called by the pivot when the user selects or unselected an item within a pivot listing.
The event handler is passed an argument, pivot, that is this pivot table object.
• property pageSize as %ZEN.Datatype.integer [ InitialExpression = 100 ];
Number of pivot result rows to show at one time.
• property parameters as array of %ZEN.Auxiliary.parameter(XMLKEYNAME="paramName",XMLNAME="parameter",XMLPROJECTION="ELEMENT");
User-defined set of parameters. These values are passed on to the user callback functions that provides the contents of this table. Typically this is used to hold search parameters.
• property pivotSelect as %ZEN.Datatype.string(VALUELIST=",single,multi");
Specifies the select mode for the pivot table: none, "single", or "multi". Turning this on displays check boxes for each row in the pivot table. This is different from the built-in cell range selection mechanism.
This only applies to KPI-based pivots.
• property printCellWidth as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Width of data cells when the pivot is printed. This is in the same units as the page size.
• property printLabelWidth as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Width of row labels when the pivot is printed. This is in the same units as the page size.
• property printMarginBottom as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page bottom margin when pivot is printed. This is in the same units as the page size.
• property printMarginLeft as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page left margin when pivot is printed. This is in the same units as the page size.
• property printMarginRight as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page right margin when pivot is printed. This is in the same units as the page size.
• property printMarginTop as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page top margin when pivot is printed. This is in the same units as the page size.
• property printOrientation as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Orientation when pivot is printed: "portrait" or "landscape".
• property printPageSize as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Page size when pivot is printed. This takes the form "8.5x11 in" (w x h).
• property printSubtitle as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Subtitle to display when pivot is printed.
• property printTitle as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Title to display when pivot is printed.
• property rowAxisOptions as pivotLevel;
This is used to define functions to apply to the entire row axis.
• property rowCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
If present, this is the number of rows returned by the current query. This is calculated in both user query and automatic query modes.
• property rowHeaderStyle as %ZEN.Datatype.style;
Optional style to apply to row headers.
• property rowLabelSpan as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
This specifies how parent row labels with multiple child labels are displayed.
If true, then one parent label is displayed for each set of children. If false, then the parent row label is repeated for each child.
• property rowLevels as list of pivotLevel(XMLNAME="rowLevel",XMLPROJECTION="ELEMENT");
This contains the definition of the row dimensions for this pivot table.
• property selectedCellBackground as %ZEN.Datatype.style [ InitialExpression = "rgb(47,98,128)" ];
Background color applied to the selected cell range.
• property selectedCellColor as %ZEN.Datatype.style [ InitialExpression = "white" ];
Color applied to the selected cell range.
• property selectedRange as %ZEN.Datatype.csv;
This specifies the current selected range of cells as a comma-separated list of integers. The list is of the form:
startRow,startCol,endRow,endCol,allRows,allCols
All cells numbers are 1-based.
If allRows is 1, then all rows for indicated columns are selected.
If allCols is 1, then all columns for indicated rows are selected.
If the range is equal to "", then no cells are selected.
• property showEmptyColumns as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display columns containing only empty values.
If mdx is specified, this is ignored.
• property showEmptyRows as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display rows containing only empty values.
If mdx is specified, this is ignored.
• property showPivotStats as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show pivot cell count and total in status area along the bottom of the table.
• property showPlan as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, execute a show plan for the query.
• property showQuery as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show the query used to get results for this table.
This is a intended for use as a troubleshooting aid.
• property showRowCaption as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show a caption about the row headers.
• property showStatus as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show status area along the bottom of the table.
• property showZebra as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show zebra striping.
• property sortColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If not 0, then sort the results by the values within this column.
• property sortDir as %ZEN.Datatype.string(VALUELIST="ASC,DESC") [ InitialExpression = "ASC" ];
If column sorting is on, then this is the sort direction.
• property userMDX as %ZEN.Datatype.string(ZENSETTING=0);
If defined, then this holds the user-supplied MDX statement used to provide the contents of the pivot table.
• property valueColumn as %ZEN.Datatype.string;
If defined, then this is the name of the column that provides the value for a row within this pivot. This value is used when a row is selected, and a dashboard *action* is invoked on the pivot.
This only applies to KPI-based pivots. If not provided, then the first column is used.

Methods

• method %CreateResultSet(Output pSC As %Status, ByRef pParms, ByRef pFilterInfo, ByRef pAdvancedFilters, Output pQueryText As %String, Output pAxes, Output pDataReady As %Boolean) as %DeepSee.ResultSet
Create the DeepSee ResultSet needed to get data for this table.
Does not execute the query.
pSC is a status code.
pParms is an array of input parameter values.
pFilterInfo is an array of filter details.
pAdvancedFilters is an array of advanced filter details.
pAxes is an array of top nodes for each axis.
pDataReady is true if the query results are in the cache.
pQueryText is the text of the query.
• method %DrawDataTable(pAxisCount As %Integer, pColRoot As %Integer, pRowRoot As %Integer, pStartRow As %Integer, pEndRow As %Integer, pColumnTotals As %Boolean = 0, pRowTotals As %Boolean = 0, pUseSort As %Boolean = 0, pMaxCols As %Boolean = 1000) as %Status
Draw the table containing the data cells.
pColRoot is node number for top node along the column axis.
pRowRoot is node number for top node along the row axis.
pStartRow is the ordinal number of the first row to display.
pEndRow is the ordinal number of the last row to display.
• method %DrawEmptyTable(pMessage As %String) as %Status
Draw a one-cell data table with the given message.
• method %DrawHTML()
Draw HTML for this component.
• method %DrawKPITable() as %Status
Draw table using KPI class as a source.
• method %DrawTable(pAxisCount As %Integer, pColAxis As %Integer, pRowAxis As %Integer, ByRef pFilterInfo, pUseSort As %Boolean = 0) as %Status
Draw the tables that make up this component.
pAxisCount is the number of axes within the result.
pColAxis specifies which axis should be used for columns.
pRowAxis specifies which axis should be used for rows.
pFilterInfo is an array of filter information.
pUseSort indicates that row sorting is in play.
• classmethod %GetSummaryFromCSS(pStyle As %String, Output pAgg As %String) as %String
Parse a CSS style directive and remove any "summary:val" directives within it.
• method %OnCreateResultSet(Output pRS As %DeepSee.ResultSet, ByRef pParms) as %Status
This callback is invoked when the pivot table is about to create a result set.
If the callback creates a %DeepSee.ResultSet object and returns it via pRS, then the pivot table will use this result set to display results.
• method %ShowPlan(pRS As %DeepSee.ResultSet) as %Status
Show execution plane for the query
• method %ShowPlanItem(ByRef pPlan, pNodeNo As %Integer, pLevel As %Integer = 0) as %Status
Show one item in a query plan.
• method GetCurrentQueryText() as %String [ ZenMethod ]
Get the original MDX text for the current query.
• classmethod GetItemCaption(pCubeName As %String, pSpec As %String) as %String [ ZenMethod ]
Get the tuple spec for the given item within the query result and place it into the proxy object. pAxisName is "row" or "col".
Return the caption associate with given cube element.
• classmethod GetItemSpec(pSpec As %ZEN.proxyObject, pCubeName As %String, pQueryKey As %String, pAxisName As %String, pItemNo As %Integer) as %Boolean [ ZenMethod ]
Get the tuple spec for the given item within the query result and place it into the proxy object. pAxisName is "row" or "col".
Return true, if ok.
• classmethod GetQueryStatus(pObject As %ZEN.proxyObject, pCubeName As %String, pQueryKey As %String, pKPI As %String = "") as %Boolean [ ZenMethod ]
Check on the status of the given query. Return true, if ok.
• classmethod GetQueryText(pCubeName As %String, pQueryKey As %String, pEncrypt As %Boolean = 0) as %String [ ZenMethod ]
Get the MDX text for the current query.
• classmethod GetSlicerSpecForCells(pSpec As %ZEN.proxyObject, pCubeName As %String, pQueryKey As %String, pStartRow As %Integer, pStartCol As %Integer, pEndRow As %Integer = "", pEndCol As %Integer = "") as %Boolean [ ZenMethod ]
Get the slicer spec for the given cell within the query result and place it into the proxy object. Return true, if ok.
• classmethod KillQuery(pCubeName As %String, pQueryKey As %String, pNonce As %String) as %Boolean [ ZenMethod ]
Cancel the query specified by pCubeName and pQueryKey. Return true, if ok.
• method adjustTableLayout() [ Language = javascript ]
Adjust size and position of the layout divs that contain the table as well as the cells and headers in the table.
• method allClick() [ Language = javascript ]
Click on all check box (in detail listing).
• method allClickPivot() [ Language = javascript ]
Click on all check box (in pivot).
• method canDrillThrough() [ Language = javascript ]
Test if this pivot supports drill through.
• method canGoBack() [ Language = javascript ]
Indicate if we can go back to a prior state.
• method canGoForward() [ Language = javascript ]
Indicate if we can go forward to a visited state.
• method cancelQuery() [ Language = javascript ]
Cancel the current query for this pivot table and update the display.
• method cbClick(currCb) [ Language = javascript ]
Click on checkbox.
• method cbClickPivot(currCb) [ Language = javascript ]
Click on checkbox in pivot.
• method cellClickHandler(evt, row, col) [ Language = javascript ]
Notification that a cell is clicked.
row and col give the ordinal position of the cell.
• method cellDblClickHandler(evt, row, col) [ Language = javascript ]
Notification that a cell is double-clicked.
row and col give the ordinal position of the cell.
• method cellScrollHz() [ Language = javascript ]
Horizontal Scroll handler..
• method cellScrollVt() [ Language = javascript ]
Vertical Scroll handler.
• method columnClickHandler(evt, col) [ Language = javascript ]
Notification that a column header is clicked.
• method columnDblClickHandler(evt, col) [ Language = javascript ]
Notification that a column header is double-clicked.
• method computeTotals() [ Language = javascript ]
Compute row and columns totals, as needed.
• method dragFinishHandler(dragData) [ Language = javascript ]
This is called when a drag operation started within this component is completed.
• method dragStartHandler(dragData) [ Language = javascript ]
Built-in drag handler for pivot table component. Let the user drag the selected node.
• method drillThrough() [ Language = javascript ]
Toggle drill through state of this pivot. If not in drill through mode, execute a drill through: show a listing for the current selected range of cells. else restore normal view. Return true if the operation took place.
• method dropStartHandler(dragData) [ Language = javascript ]
Drop handler. This is called when an item is dropped onto the table.
• method executeListing() [ Language = javascript ]
Execute a drill through for the current selected cell.
• method executeQuery(force) [ Language = javascript ]
Execute the current query for this pivot table and update the display.
If force is true, then force the query to be prepared.
• method filterLabelClick(evt, filterValue) [ Language = javascript ]
Click on an item label within the filter dropdown.
• method firstPage() [ Language = javascript ]
For multi-page display, go to the first page.
• method getData(d1, d2, d3) [ Language = javascript ]
dataSet API Return the data contained in the specified location. Location is 0-based;
• final method getDataAsArrays() [ Language = javascript ]
This is a specialized variant of getData that return the data in this controller as an array of arrays (used by charts).
• method getDataByName(property, series) [ Language = javascript ]
• final method getDataSourceCaption() [ Language = javascript ]
Return a title to display for this data source. This provides the title for a chart.
• final method getDimName(dim) [ Language = javascript ]
Return a name for the given dimension (1,2, or 3). This provides the axis label for a chart.
• final method getDimSize(dim) [ Language = javascript ]
Return the number of items in the specified dimension (dim is 1,2, or 3).
• method getDrillLevel() [ Language = javascript ]
Return current drill level for this pivot.
• method getFilterForCells(r1, c1, r2, c2) [ Language = javascript ]
Return the filter spec for the given cell range.
• final method getFilterInfo(fnames, fvalues) [ Language = javascript ]
Return information on current filters.
fnames is an array in which the filter names will be placed.
fvalues is an array in which the filter values will be placed.
• final method getLabel(n, dim) [ Language = javascript ]
Get the label at position n (0-based) in the given dimension (1,2, or 3).
• method getListingPageCount() [ Language = javascript ]
For multi-page listing display, calculate the number of pages.
• method getPageCount() [ Language = javascript ]
For multi-page display, calculate the number of pages.
• method getPropertyName(n) [ Language = javascript ]
Given a 0-based index, return the corresponding property name.
• method getSelectedItems() [ Language = javascript ]
Return an array of the values of the selected items in the pivot table. For listing mode, this is the set of ids for the selected rows. For pivot mode, this is the values of the value column for each selected row.
• method getSelectedRange() [ Language = javascript ]
Return the range of selected cells or null if nothing selected.
The range is returned as an array of startRow,startCol,endRow,endCol,allRows,allCols.
• final method getValueName() [ Language = javascript ]
Return a label for the values returned by the data source. This provides the axis label for a chart.
• method goBack(notify) [ Language = javascript ]
Go back to the previous state.
• method goForward() [ Language = javascript ]
Go forward to the next state (if there is one).
• method gotoDrillLevel(idx) [ Language = javascript ]
Go to the given drill level.
• method gotoPage(page) [ Language = javascript ]
For multi-page display, go to specified page (1 is first page), if possible.
• method hasFormatRules() [ Language = javascript ]
Indicate if there are any formatting rules in play.
• method hideMessage() [ Language = javascript ]
Hide the message box.
• method lastPage() [ Language = javascript ]
For multi-page display, go to the last page.
• method listingHeaderDblClickHandler(evt, col) [ Language = javascript ]
Notification that a listing header is double-clicked.
• method newDataHandler() [ Language = javascript ]
Notification that new data is available.
• method nextPage() [ Language = javascript ]
For multi-page display, go to next page, if possible.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onupdateHandler() [ Language = javascript ]
This client method, if present, is fired when the object is updated from the server. This is called *after* changes have been synched.
• method previousPage() [ Language = javascript ]
For multi-page display, go to previous page, if possible.
• final method raiseDataChange() [ Language = javascript ]
Send notification to listeners that the data associated with this pivotTable has changed.
• method removeDrillLevel(idx) [ Language = javascript ]
Remove a drill level.
• method resetTable() [ Language = javascript ]
Reset this table to default settings.
• method rowClickHandler(evt, row) [ Language = javascript ]
Notification that a row header is clicked.
• method rowDblClickHandler(evt, level, row) [ Language = javascript ]
Notification that a row header is double clicked.
• method selectCellRange(startRow, startCol, endRow, endCol, allRows, allCols, selectOnly) [ Language = javascript ]
Set the selected cell range. Addresses are 1-based.
• method sendEventToViews(reason, source, data1, data2, data3) [ Language = javascript ]
Send an event to all listeners (dataViews) connected to this dataController. reason is the name of the event.
source, if not null, if the dataView that raised the event.
data1,data2, and data3 contain event-specific data passed along with the event.
• method setDrillThrough(flag, force) [ Language = javascript ]
Set the drill through state of this pivot to flag.
If true, execute a drill through: show a listing for the current selected range of cells. else restore normal view. Return true if the operation took place.
• method setListing(listing, type) [ Language = javascript ]
Set the name of the listing (and listing type) to show for this pivot.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method showIKnowMeasureValue(cubeName, measure, objId) [ Language = javascript ]
• method showMDXQuery() [ Language = javascript ]
Toggle display of the current query.
• method showMessage(msg, pct, listing) [ Language = javascript ]
Display the message box. (or display message within pivot controller, if present).
• method showPendingMsg(flag, msg) [ Language = javascript ]
Show (or hide) the "computing..." message.
• method startQueryTimer() [ Language = javascript ]
Start the timer used to update during query calculation.
• method stopQueryTimer() [ Language = javascript ]
Stop the query timer.
• method swapRowsAndColumns() [ Language = javascript ]
Swap the row and column definitions for this table and refresh it.
• method wheelHandler(evt) [ Language = javascript ]
Mouse wheel handler.