Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Component.pivotController
Private  Storage   

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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 5 45


Summary


Properties
%condition %import %includeFiles %page
%resource align aux composite
containerStyle dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle miniAnalyzer name onafterdrag
onbeforedrag ondrag ondrop onhide
onrefresh onshow onupdate parent
pivotTableId rowsHeight selectedColumn selectedItem
showLabel slice title tuple
valign visible width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addBlankLevel addLevel buildIconList
clearLevels copyItem dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableItem exposeComponent findElement fireOnUpdateEvent
getEnclosingDiv getHidden getHintElement getIcon
getLabelElement getPivotTable getProperty getSettings
getType gotoDrillLevel hideMessage invokeSuper
isOfType isValidFilter itemCanMoveDown itemCanMoveUp
makeId moveItemDown moveItemUp onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onStartModalHandler onloadHandler
onunloadHandler onupdateHandler pasteItem refreshContents
removeDrillLevel removeLevel render renderContents
renderSVG resetTable selectItem setAxisOptions
setFilterOptions setHidden setLevelOptions setOverlayMode
setProperty showMessage startProgressBar stopProgressBar


Parameters


• parameter DOMAIN = "%DeepSee";
Set this to the correct domain.
• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties


• property miniAnalyzer as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• 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.
• property rowsHeight as %ZEN.Datatype.string(XMLPROJECTION="none") [ InitialExpression = "75px" ];
• property selectedColumn as %ZEN.Datatype.string(XMLPROJECTION="none");
Name of column with selected item.
• property selectedItem as %ZEN.Datatype.string(XMLPROJECTION="none");
Path (idx1_idx2_idx3) of selected item or ''.

Methods


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