Skip to main content

%DeepSee.Component.pivotLevel

Class %DeepSee.Component.pivotLevel Extends %ZEN.Component.object [ System = 3 ]

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

Parameters​

NAMESPACE​

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

Properties​

spec​

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]"

enabled​

Property enabled As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

For filters, indicates if a filter is enabled.

advanced​

Property advanced As %ZEN.Datatype.boolean;

If true, then spec contains an "advanced" specification (such as an advanced filter).

transient​

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.

key​

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}"

drillLevel​

Property drillLevel As %ZEN.Datatype.integer [ InitialExpression = 0 ];

Drill-level at which this level was defined.

position​

Property position As %ZEN.Datatype.integer(XMLPROJECTION = "none") [ Internal ];

Internal property used to track order in which filters are displayed.

filterDim​

Property filterDim As %ZEN.Datatype.integer(XMLPROJECTION = "none") [ Internal ];

Used to track the dimension number for a filter.

filterHier​

Property filterHier As %ZEN.Datatype.integer(XMLPROJECTION = "none") [ Internal ];

Used to track the hierarchy number for a filter.

value​

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]"

text​

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.

caption​

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.

baseSpec​

Property baseSpec As %ZEN.Datatype.string(XMLPROJECTION = "none") [ Internal ];

Original spec for a filter (used to find caption).

childLevels​

Property childLevels As list Of pivotLevel(XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", ZENSETTING = 0);

Children of this level.

suppress8020​

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

If true, apply the 80/20 suppression to this level.

headEnabled​

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

If true, apply the HEAD function to this level.

headCount​

Property headCount As %ZEN.Datatype.integer;

Count argument for HEAD function.

filterEnabled​

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

If true, apply the FILTER function to this level.

filterExpression​

Property filterExpression As %ZEN.Datatype.string;

Filter expression for FILTER function.

orderEnabled​

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

If true, apply the ORDER function to this level.

orderExpression​

Property orderExpression As %ZEN.Datatype.string;

Sort expression for ORDER function.

orderDirection​

Property orderDirection As %ZEN.Datatype.string [ InitialExpression = "BDESC" ];

Direction argument for ORDER function.

aggEnabled​

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

If true, apply the Aggregate function to this level.

aggFunction​

Property aggFunction As %ZEN.Datatype.string;

Aggregate function.

aggFunctionParm​

Property aggFunctionParm As %ZEN.Datatype.string;

Parameter for aggregate function (if any)

levelCaption​

Property levelCaption As %ZEN.Datatype.string;

Optional caption to apply to this element.

levelFormat​

Property levelFormat As %ZEN.Datatype.string;

Optional format to apply to this element.

levelType​

Property levelType As %ZEN.Datatype.string(VALUELIST = ",value,space,mdx");

For row/column options, indicates the type of member defined.

levelStyle​

Property levelStyle As %ZEN.Datatype.style;

Optional CSS style to apply to this element.

levelHeaderStyle​

Property levelHeaderStyle As %ZEN.Datatype.style;

Optional CSS style to apply to header's for this element.

levelSummary​

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.

drilldownSpec​

Property drilldownSpec As %ZEN.Datatype.string;

Drilldown spec.

Methods​

clone​

ClientMethod clone(ascomp) [ Internal, Language = javascript ]

Create a clone of this object.