Skip to main content

%DeepSee.Component.pivotController

Class %DeepSee.Component.pivotController Extends %ZEN.Component.component [ System = 3 ]

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

Parameters

NAMESPACE

Parameter NAMESPACE = "http://www.intersystems.com/deepsee";

DOMAIN

Parameter DOMAIN = "%DeepSee";

Set this to the correct domain.

Properties

pivotTableId

Property pivotTableId As %ZEN.Datatype.id(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.

miniAnalyzer

Property miniAnalyzer As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

selectedColumn

Property selectedColumn As %ZEN.Datatype.string(XMLPROJECTION = "none");

Name of column with selected item.

selectedItem

Property selectedItem As %ZEN.Datatype.string(XMLPROJECTION = "none");

Path (idx1_idx2_idx3) of selected item or ''.

rowsHeight

Property rowsHeight As %ZEN.Datatype.string(XMLPROJECTION = "none") [ InitialExpression = "75px" ];

XDatas

Style

XData Style

defines style sheet used by this component

Methods

%DrawHTML

Method %DrawHTML()

getPivotTable

ClientMethod getPivotTable() [ Language = javascript ]

Return the pivotTable this controller is currently connected to.

renderContents

ClientMethod renderContents() [ Language = javascript ]

Client-side method to render this control.

getFieldsHTML

ClientMethod getFieldsHTML() [ Internal, Language = javascript ]

Get html for the fields column.

getRowsHTML

ClientMethod getRowsHTML() [ Internal, Language = javascript ]

Get html for the rows column.

getColumnsHTML

ClientMethod getColumnsHTML() [ Internal, Language = javascript ]

Get html for the columns column.

getMeasuresHTML

ClientMethod getMeasuresHTML() [ Internal, Language = javascript ]

Get html for the measures column.

getFiltersHTML

ClientMethod getFiltersHTML() [ Internal, Language = javascript ]

Get html for the filters column.

getIconHTML

ClientMethod getIconHTML(id, enabled, imgId, help, click) [ Internal, Language = javascript ]

Get html to create an icon.

getDropdownIconHTML

ClientMethod getDropdownIconHTML(id, enabled, imgId, help, options) [ Internal, Language = javascript ]

Get html to create an icon with a dropdown menu.

getHeaderHTML

ClientMethod getHeaderHTML() [ Internal, Language = javascript ]

Fill an array of HTML with the contents of the header area.

drillThrough

ClientMethod drillThrough() [ Internal, Language = javascript ]

Toggle the drillThrough mode of the table.

getDrillLevelHTML

ClientMethod getDrillLevelHTML() [ Internal, Language = javascript ]

Get drill level HTML.

getLevelHTML

ClientMethod getLevelHTML(which, dropMsg, array, drillLevel, depth, parent) [ Internal, Language = javascript ]

Fill an array of HTML with the contents of the given level list.

setProperty

ClientMethod setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

updateState

ClientMethod updateState(which) [ Internal, Language = javascript ]

Called by the associated pivotTable when it changes state.

updateIcon

ClientMethod updateIcon(id, enabled, image, hlp) [ Internal, Language = javascript ]

Update a toolbar icon.

updateToolbar

ClientMethod updateToolbar() [ Internal, Language = javascript ]

Update state of buttons in toolbar.

addLevel

ClientMethod addLevel(which) [ Language = javascript ]

Click handler for add button.

removeLevel

ClientMethod removeLevel(which, key) [ Language = javascript ]

Click handler for remove level button.

setAxisOptions

ClientMethod setAxisOptions(which) [ Language = javascript ]

Click handler for axis options button.

setFilterOptions

ClientMethod setFilterOptions(idx) [ Language = javascript ]

Click handler for filter options button.

setLevelOptions

ClientMethod setLevelOptions(which, key) [ Language = javascript ]

Click handler for level options button.

onPopupAction

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this component fires an action.

gotoDrillLevel

ClientMethod gotoDrillLevel(idx) [ Language = javascript ]

Click handler for drill level.

removeDrillLevel

ClientMethod removeDrillLevel(idx) [ Language = javascript ]

Click handler for drill level remove.

clearLevels

ClientMethod clearLevels(which) [ Language = javascript ]

Click handler for clear button.

addBlankLevel

ClientMethod addBlankLevel(which) [ Language = javascript ]

Click handler for add selected item button. If nothing selected, adds a space.

isValidFilter

ClientMethod isValidFilter(dimName, value) [ Language = javascript ]

Test if a spec can be used as a filter. Return '' if ok else return an error message.

onloadHandler

ClientMethod onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

dropStartHandler

ClientMethod dropStartHandler(dragData) [ Language = javascript ]

Drop handler. This is called when an item is dropped onto the controller.

hideMessage

ClientMethod hideMessage() [ Language = javascript ]

Hide the message box.

showMessage

ClientMethod showMessage(pivot, msg, pct, listing, units) [ Language = javascript ]

Display the pivot status message box.

selectItem

ClientMethod selectItem(which, item) [ Language = javascript ]

Select the given item.

enableItem

ClientMethod enableItem(evt, which, item) [ Language = javascript ]

Enable the given item.

moveItemUp

ClientMethod moveItemUp(which) [ Language = javascript ]

Move the current item up.

moveItemDown

ClientMethod moveItemDown(which) [ Language = javascript ]

Move the current item down.

itemCanMoveUp

ClientMethod itemCanMoveUp(which, key) [ Language = javascript ]

Test if an item can move up.

itemCanMoveDown

ClientMethod itemCanMoveDown(which, key) [ Language = javascript ]

Test if an item can move down.

copyItem

ClientMethod copyItem() [ Language = javascript ]

Copy pivot level item.

pasteItem

ClientMethod pasteItem(where) [ Language = javascript ]

Paste pivot level item.

resetTable

ClientMethod resetTable() [ Language = javascript ]

Reset the pivot table.

buildIconList

ClientMethod buildIconList() [ Language = javascript ]

Build the list of icons used by this component.

getIcon

ClientMethod getIcon(id) [ Language = javascript ]

Return the url of the icon with the given id.

swapRows

ClientMethod swapRows() [ Internal, Language = javascript ]

User pressed on the swap button.

addChildToElement

ClientMethod addChildToElement(which, key) [ Internal, Language = javascript ]

User click on "join" arrow.