Home > Class Reference > ENSLIB namespace > %DeepSee.Dashboard.PivotLevel


serial class %DeepSee.Dashboard.PivotLevel extends %Library.SerialObject, %XML.Adaptor

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.

Property Inventory


parameter NAMESPACE = http://www.intersystems.com/deepsee/library;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. if NAMESPACE - "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
parameter XMLNAME = pivot;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property advanced as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, this is an advanced filter.
Property methods: advancedDisplayToLogical(), advancedGet(), advancedIsValid(), advancedLogicalToDisplay(), advancedLogicalToOdbc(), advancedLogicalToXSD(), advancedNormalize(), advancedSet(), advancedXSDToLogical()
property aggEnabled as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, apply the Aggregate function to this level.
Property methods: aggEnabledDisplayToLogical(), aggEnabledGet(), aggEnabledIsValid(), aggEnabledLogicalToDisplay(), aggEnabledLogicalToOdbc(), aggEnabledLogicalToXSD(), aggEnabledNormalize(), aggEnabledSet(), aggEnabledXSDToLogical()
property aggFunction as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Aggregate function.
Property methods: aggFunctionDisplayToLogical(), aggFunctionGet(), aggFunctionIsValid(), aggFunctionLogicalToDisplay(), aggFunctionLogicalToOdbc(), aggFunctionNormalize(), aggFunctionParmDisplayToLogical(), aggFunctionParmGet(), aggFunctionParmIsValid(), aggFunctionParmLogicalToDisplay(), aggFunctionParmLogicalToOdbc(), aggFunctionParmNormalize(), aggFunctionParmSet(), aggFunctionSet()
property aggFunctionParm as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Aggregate function parameter.
Property methods: aggFunctionParmDisplayToLogical(), aggFunctionParmGet(), aggFunctionParmIsValid(), aggFunctionParmLogicalToDisplay(), aggFunctionParmLogicalToOdbc(), aggFunctionParmNormalize(), aggFunctionParmSet()
property childLevels as list of PivotLevel (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT");
Children of this level.
Property methods: childLevelsBuildValueArray(), childLevelsCollectionToDisplay(), childLevelsCollectionToOdbc(), childLevelsDisplayToCollection(), childLevelsGet(), childLevelsGetObject(), childLevelsGetObjectId(), childLevelsGetSwizzled(), childLevelsIsValid(), childLevelsOdbcToCollection(), childLevelsSet(), childLevelsSetObject(), childLevelsSetObjectId()
property drillLevel as %ZEN.Datatype.integer (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
Drill-level at which this level was defined.
Property methods: drillLevelDisplayToLogical(), drillLevelGet(), drillLevelIsValid(), drillLevelLogicalToDisplay(), drillLevelLogicalToOdbc(), drillLevelNormalize(), drillLevelSet()
property drilldownSpec as %ZEN.Datatype.string);
If defined, this is a ^-delimited list of MDX expressions to use when drilling (double-clicking) on a member defined by this level.
Property methods: drilldownSpecDisplayToLogical(), drilldownSpecGet(), drilldownSpecIsValid(), drilldownSpecLogicalToDisplay(), drilldownSpecLogicalToOdbc(), drilldownSpecNormalize(), drilldownSpecSet()
property enabled as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
If true, this level is enabled. Only applies to filters at this time.
Property methods: enabledDisplayToLogical(), enabledGet(), enabledIsValid(), enabledLogicalToDisplay(), enabledLogicalToOdbc(), enabledLogicalToXSD(), enabledNormalize(), enabledSet(), enabledXSDToLogical()
property filterEnabled as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, apply the FILTER function to this level.
Property methods: filterEnabledDisplayToLogical(), filterEnabledGet(), filterEnabledIsValid(), filterEnabledLogicalToDisplay(), filterEnabledLogicalToOdbc(), filterEnabledLogicalToXSD(), filterEnabledNormalize(), filterEnabledSet(), filterEnabledXSDToLogical()
property filterExpression as %ZEN.Datatype.string);
Filter expression for FILTER function.
Property methods: filterExpressionDisplayToLogical(), filterExpressionGet(), filterExpressionIsValid(), filterExpressionLogicalToDisplay(), filterExpressionLogicalToOdbc(), filterExpressionNormalize(), filterExpressionSet()
property headCount as %ZEN.Datatype.integer (XMLPROJECTION = "attribute");
Count argument for HEAD function.
Property methods: headCountDisplayToLogical(), headCountGet(), headCountIsValid(), headCountLogicalToDisplay(), headCountLogicalToOdbc(), headCountNormalize(), headCountSet()
property headEnabled as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, apply the HEAD function to this level.
Property methods: headEnabledDisplayToLogical(), headEnabledGet(), headEnabledIsValid(), headEnabledLogicalToDisplay(), headEnabledLogicalToOdbc(), headEnabledLogicalToXSD(), headEnabledNormalize(), headEnabledSet(), headEnabledXSDToLogical()
property key as %ZEN.Datatype.string);
Key value of the current dimension level.
This can be a comma-delimited list of keys: "14,25"
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyLogicalToOdbc(), keyNormalize(), keySet()
property levelCaption as %ZEN.Datatype.string);
Optional caption to apply to this element.
Property methods: levelCaptionDisplayToLogical(), levelCaptionGet(), levelCaptionIsValid(), levelCaptionLogicalToDisplay(), levelCaptionLogicalToOdbc(), levelCaptionNormalize(), levelCaptionSet()
property levelFormat as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Optional format to apply to this element.
Property methods: levelFormatDisplayToLogical(), levelFormatGet(), levelFormatIsValid(), levelFormatLogicalToDisplay(), levelFormatLogicalToOdbc(), levelFormatNormalize(), levelFormatSet()
property levelHeaderStyle as %ZEN.Datatype.style (XMLPROJECTION = "attribute");
Optional style to apply to this element's header.
Property methods: levelHeaderStyleDisplayToLogical(), levelHeaderStyleGet(), levelHeaderStyleIsValid(), levelHeaderStyleLogicalToDisplay(), levelHeaderStyleLogicalToOdbc(), levelHeaderStyleNormalize(), levelHeaderStyleSet()
property levelStyle as %ZEN.Datatype.style (XMLPROJECTION = "attribute");
Optional style to apply to this element.
Property methods: levelStyleDisplayToLogical(), levelStyleGet(), levelStyleIsValid(), levelStyleLogicalToDisplay(), levelStyleLogicalToOdbc(), levelStyleNormalize(), levelStyleSet()
property levelSummary as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Optional summary to apply to this element.
Property methods: levelSummaryDisplayToLogical(), levelSummaryGet(), levelSummaryIsValid(), levelSummaryLogicalToDisplay(), levelSummaryLogicalToOdbc(), levelSummaryNormalize(), levelSummarySet()
property levelType as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Type of member to use for this element.
Property methods: levelTypeDisplayToLogical(), levelTypeGet(), levelTypeIsValid(), levelTypeLogicalToDisplay(), levelTypeLogicalToOdbc(), levelTypeNormalize(), levelTypeSet()
property orderDirection as %ZEN.Datatype.string (XMLPROJECTION = "attribute") [ InitialExpression = "BDESC" ];
Direction argument for ORDER function.
Property methods: orderDirectionDisplayToLogical(), orderDirectionGet(), orderDirectionIsValid(), orderDirectionLogicalToDisplay(), orderDirectionLogicalToOdbc(), orderDirectionNormalize(), orderDirectionSet()
property orderEnabled as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, apply the ORDER function to this level.
Property methods: orderEnabledDisplayToLogical(), orderEnabledGet(), orderEnabledIsValid(), orderEnabledLogicalToDisplay(), orderEnabledLogicalToOdbc(), orderEnabledLogicalToXSD(), orderEnabledNormalize(), orderEnabledSet(), orderEnabledXSDToLogical()
property orderExpression as %ZEN.Datatype.string);
Sort expression for ORDER function.
Property methods: orderExpressionDisplayToLogical(), orderExpressionGet(), orderExpressionIsValid(), orderExpressionLogicalToDisplay(), orderExpressionLogicalToOdbc(), orderExpressionNormalize(), orderExpressionSet()
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 methods: specDisplayToLogical(), specGet(), specIsValid(), specLogicalToDisplay(), specLogicalToOdbc(), specNormalize(), specSet()
property suppress8020 as %ZEN.Datatype.boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, apply the 80/20 suppression to this level.
Property methods: suppress8020DisplayToLogical(), suppress8020Get(), suppress8020IsValid(), suppress8020LogicalToDisplay(), suppress8020LogicalToOdbc(), suppress8020LogicalToXSD(), suppress8020Normalize(), suppress8020Set(), suppress8020XSDToLogical()
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, for example.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
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]"
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Inherited Members

Inherited Methods