This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.Component.pivotController


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

Pivot table controller.
This component is linked to a pivotTable and displays a set of lists that can be used to specify the data that is to be plotted by the pivotTable (such as rows and columns).

Property Inventory

Method Inventory


parameter DOMAIN = %DeepSee;
Set this to the correct domain.
parameter NAMESPACE =;
Inherited description: This is the XML namespace used for library components.


property miniAnalyzer as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: miniAnalyzerDisplayToLogical(), miniAnalyzerGet(), miniAnalyzerIsValid(), miniAnalyzerLogicalToDisplay(), miniAnalyzerLogicalToOdbc(), miniAnalyzerLogicalToXSD(), miniAnalyzerNormalize(), miniAnalyzerSet(), miniAnalyzerXSDToLogical()
property pivotTableId as (COMPONENTTYPE = "pivotTable");
id of %DeepSee.Component.pivotTable component this controller is associated with.
Note: if this component is placed within a composite element, then the pivotTable must be within the same composite element.
Property methods: pivotTableIdDisplayToLogical(), pivotTableIdGet(), pivotTableIdIsValid(), pivotTableIdLogicalToDisplay(), pivotTableIdLogicalToOdbc(), pivotTableIdNormalize(), pivotTableIdSet()
property rowsHeight as %ZEN.Datatype.string (XMLPROJECTION = "none") [ InitialExpression = "75px" ];
Property methods: rowsHeightDisplayToLogical(), rowsHeightGet(), rowsHeightIsValid(), rowsHeightLogicalToDisplay(), rowsHeightLogicalToOdbc(), rowsHeightNormalize(), rowsHeightSet()
property selectedColumn as %ZEN.Datatype.string (XMLPROJECTION = "none");
Name of column with selected item.
Property methods: selectedColumnDisplayToLogical(), selectedColumnGet(), selectedColumnIsValid(), selectedColumnLogicalToDisplay(), selectedColumnLogicalToOdbc(), selectedColumnNormalize(), selectedColumnSet()
property selectedItem as %ZEN.Datatype.string (XMLPROJECTION = "none");
Path (idx1_idx2_idx3) of selected item or ''.
Property methods: selectedItemDisplayToLogical(), selectedItemGet(), selectedItemIsValid(), selectedItemLogicalToDisplay(), selectedItemLogicalToOdbc(), selectedItemNormalize(), selectedItemSet()


method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod addBlankLevel(which) [ Language = javascript ]
Click handler for add selected item button. If nothing selected, adds a space.
clientmethod addLevel(which) [ Language = javascript ]
Click handler for add button.
clientmethod buildIconList() [ Language = javascript ]
Build the list of icons used by this component.
clientmethod clearLevels(which) [ Language = javascript ]
Click handler for clear button.
clientmethod copyItem() [ Language = javascript ]
Copy pivot level item.
clientmethod dropStartHandler(dragData) [ Language = javascript ]
Drop handler. This is called when an item is dropped onto the controller.
clientmethod enableItem(evt, which, item) [ Language = javascript ]
Enable the given item.
clientmethod getIcon(id) [ Language = javascript ]
Return the url of the icon with the given id.
clientmethod getPivotTable() [ Language = javascript ]
Return the pivotTable this controller is currently connected to.
clientmethod gotoDrillLevel(idx) [ Language = javascript ]
Click handler for drill level.
clientmethod hideMessage() [ Language = javascript ]
Hide the message box.
clientmethod isValidFilter(dimName, value) [ Language = javascript ]
Test if a spec can be used as a filter. Return '' if ok else return an error message.
clientmethod itemCanMoveDown(which, key) [ Language = javascript ]
Test if an item can move down.
clientmethod itemCanMoveUp(which, key) [ Language = javascript ]
Test if an item can move up.
clientmethod moveItemDown(which) [ Language = javascript ]
Move the current item down.
clientmethod moveItemUp(which) [ Language = javascript ]
Move the current item up.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this component fires an action.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod pasteItem(where) [ Language = javascript ]
Paste pivot level item.
clientmethod removeDrillLevel(idx) [ Language = javascript ]
Click handler for drill level remove.
clientmethod removeLevel(which, key) [ Language = javascript ]
Click handler for remove level button.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render this control.
clientmethod resetTable() [ Language = javascript ]
Reset the pivot table.
clientmethod selectItem(which, item) [ Language = javascript ]
Select the given item.
clientmethod setAxisOptions(which) [ Language = javascript ]
Click handler for axis options button.
clientmethod setFilterOptions(idx) [ Language = javascript ]
Click handler for filter options button.
clientmethod setLevelOptions(which, key) [ Language = javascript ]
Click handler for level options button.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod showMessage(pivot, msg, pct, listing, units) [ Language = javascript ]
Display the pivot status message box.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window