Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Component] >  [pivotLevel]
Private  Storage   

class %DeepSee.Component.pivotLevel extends %ZEN.Component.object

Defines an axis, measure, or filter level within a %DeepSee.Component.pivotTable component.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 32


Summary

Properties
%condition %import %includeFiles %page
%resource advanced aggEnabled aggFunction
aggFunctionParm aux caption childLevels
composite drillLevel drilldownSpec enabled
filterEnabled filterExpression headCount headEnabled
id index key levelCaption
levelFormat levelHeaderStyle levelStyle levelSummary
levelType name onupdate orderDirection
orderEnabled orderExpression parent spec
suppress8020 text transient tuple
value visible window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawHTML %DrawJSStrings %Eval
%EvalC %Extends %ForceClientRender %GetEventHandlers
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType findElement fireOnUpdateEvent
getProperty getSettings getType invokeSuper
isOfType makeId onCreate onDelete
onSerialize onloadHandler onunloadHandler onupdateHandler
render renderContents renderSVG setProperty


Parameters

• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties

• property advanced as %ZEN.Datatype.boolean;
If true, then spec contains an "advanced" specification (such as an advanced filter).
• property aggEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the Aggregate function to this level.
• property aggFunction as %ZEN.Datatype.string;
Aggregate function.
• property aggFunctionParm as %ZEN.Datatype.string;
Parameter for aggregate function (if any)
• property caption as %ZEN.Datatype.caption;
Optional caption for this level. This is used to hold the level caption when this level is used a filter.
• property childLevels as list of pivotLevel(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",ZENSETTING=0);
Children of this level.
• property drillLevel as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Drill-level at which this level was defined.
• property drilldownSpec as %ZEN.Datatype.string;
Drilldown spec.
• property enabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
For filters, indicates if a filter is enabled.
• property filterEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the FILTER function to this level.
• property filterExpression as %ZEN.Datatype.string;
Filter expression for FILTER function.
• property headCount as %ZEN.Datatype.integer;
Count argument for HEAD function.
• property headEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the HEAD function to this level.
• property key as %ZEN.Datatype.string;
Key value of the current dimension level.
This can be a comma-delimited list of keys:
"14,25"
If there are multiple keys, they may be encoded as an MDX set. "{A,B}"
• property levelCaption as %ZEN.Datatype.string;
Optional caption to apply to this element.
• property levelFormat as %ZEN.Datatype.string;
Optional format to apply to this element.
• property levelHeaderStyle as %ZEN.Datatype.style;
Optional CSS style to apply to header's for this element.
• property levelStyle as %ZEN.Datatype.style;
Optional CSS style to apply to this element.
• property levelSummary as %ZEN.Datatype.string;
Optional pivot table summary to use for this element. If the pivotTable displays rowTotals or columnTotals, then this will override the summary aggregate used.
The value can be sum,min,max,count,avg,pct.
• property levelType as %ZEN.Datatype.string(VALUELIST=",value,space,mdx");
For row/column options, indicates the type of member defined.
• property orderDirection as %ZEN.Datatype.string [ InitialExpression = "BDESC" ];
Direction argument for ORDER function.
• property orderEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the ORDER function to this level.
• property orderExpression as %ZEN.Datatype.string;
Sort expression for ORDER function.
• property spec as %ZEN.Datatype.string;
This specifies the dimension level displayed for this level of the pivot table.
For example, "[Product]" or "[Time].[Year]"
• property suppress8020 as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the 80/20 suppression to this level.
• property text as %ZEN.Datatype.caption;
Optional display name for this level. This is the text displayed by the pivot table when a level is used a filter.
• property transient as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, then is a filter that was passed in from a widget and should not be saved as part of the pivot state.
• property value as %ZEN.Datatype.string;
Name value of the current dimension level.
This can be a comma-delimited list of delimited values: "[2005],[2006]"


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.