Skip to main content

%DeepSee.Dashboard.PivotLevel

Class %DeepSee.Dashboard.PivotLevel Extends (%SerialObject, %XML.Adaptor) [ System = 4 ]

This class defines a level within a DeepSee saved pivot.
This is used to fill in the values of a pivotLevel within a DeepSee pivot table.

Parameters​

NAMESPACE​

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

XMLNAME​

Parameter XMLNAME = "pivot";

XMLIGNORENULL​

Parameter XMLIGNORENULL = 1;

Properties​

spec​

Property spec As %ZEN.Datatype.string(MAXLEN = "", XMLPROJECTION = "attribute");

This specifies the dimension level displayed for this level of the pivot table.
For example, "[Product]" or "[Time].[Year]"

key​

Property key As %ZEN.Datatype.string(MAXLEN = "", XMLPROJECTION = "attribute");

Key value of the current dimension level.
This can be a comma-delimited list of keys: "14,25"

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(MAXLEN = "", XMLPROJECTION = "attribute");

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(MAXLEN = "", XMLPROJECTION = "attribute");

Optional display name for this level. This is the text displayed by the pivot table when a level is used a filter, for example.

childLevels​

Property childLevels As list Of PivotLevel(XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT");

Children of this level.

headEnabled​

Property headEnabled As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

If true, apply the HEAD function to this level.

headCount​

Property headCount As %ZEN.Datatype.integer(XMLPROJECTION = "attribute");

Count argument for HEAD function.

filterEnabled​

Property filterEnabled As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

If true, apply the FILTER function to this level.

filterExpression​

Property filterExpression As %ZEN.Datatype.string(MAXLEN = "", XMLPROJECTION = "attribute");

Filter expression for FILTER function.

orderEnabled​

Property orderEnabled As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

If true, apply the ORDER function to this level.

orderExpression​

Property orderExpression As %ZEN.Datatype.string(MAXLEN = "", XMLPROJECTION = "attribute");

Sort expression for ORDER function.

orderDirection​

Property orderDirection As %ZEN.Datatype.string(XMLPROJECTION = "attribute") [ InitialExpression = "BDESC" ];

Direction argument for ORDER function.

aggEnabled​

Property aggEnabled As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

If true, apply the Aggregate function to this level.

aggFunction​

Property aggFunction As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Aggregate function.

aggFunctionParm​

Property aggFunctionParm As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Aggregate function parameter.

levelCaption​

Property levelCaption As %ZEN.Datatype.string(MAXLEN = "", XMLPROJECTION = "attribute");

Optional caption to apply to this element.

levelFormat​

Property levelFormat As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Optional format to apply to this element.

levelSummary​

Property levelSummary As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Optional summary to apply to this element.

levelType​

Property levelType As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Type of member to use for this element.

drillLevel​

Property drillLevel As %ZEN.Datatype.integer(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

Drill-level at which this level was defined.

advanced​

Property advanced As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

If true, this is an advanced filter.

levelStyle​

Property levelStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");

Optional style to apply to this element.

levelHeaderStyle​

Property levelHeaderStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");

Optional style to apply to this element's header.

suppress8020​

Property suppress8020 As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

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

drilldownSpec​

Property drilldownSpec As %ZEN.Datatype.string(MAXLEN = "", XMLPROJECTION = "attribute");

If defined, this is a ^-delimited list of MDX expressions to use when drilling (double-clicking) on a member defined by this level.

enabled​

Property enabled As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

If true, this level is enabled. Only applies to filters at this time.

Methods​

%CopyToComponent​

Method %CopyToComponent(pLevel As %DeepSee.Component.pivotLevel) As %Status [ Internal ]

Copy the contents of this pivot level definition to pivot table level pLevel.

%CopyFromComponent​

Method %CopyFromComponent(pLevel As %DeepSee.Component.pivotLevel) As %Status [ Internal ]

Set the contents of this pivot level definition from pivot table level pLevel.

%CopyToDao​

Method %CopyToDao(Output pLevelJSON As %DynamicObject) As %Status [ Internal ]

Copy the contents of this pivot level definition to an Dao.