CacheHierarchy Class

  • Article

PivotCache Hierarchy.When the object is serialized out as xml, its qualified name is x:cacheHierarchy.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.CacheHierarchy

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(FieldsUsage))> _
<ChildElementInfoAttribute(GetType(GroupLevels))> _
<ChildElementInfoAttribute(GetType(CacheHierarchyExtensionList))> _
Public Class CacheHierarchy _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As CacheHierarchy

[ChildElementInfoAttribute(typeof(FieldsUsage))]
[ChildElementInfoAttribute(typeof(GroupLevels))]
[ChildElementInfoAttribute(typeof(CacheHierarchyExtensionList))]
public class CacheHierarchy : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • FieldsUsage <x:fieldsUsage>

  • GroupLevels <x:groupLevels>

  • CacheHierarchyExtensionList <x:extLst>

[ISO/IEC 29500-1 1st Edition]

18.10.1.6 cacheHierarchy (PivotCache Hierarchy)

Represents an OLAP hierarchy in the PivotCache.

[Example:

<cacheHierarchy uniqueName="[Account].[Account Number]" caption="Account Number"
attribute="1" defaultMemberUniqueName="[Account].[Account Number].[All
Accounts]" allUniqueName="[Account].[Account Number].[All Accounts]"
dimensionUniqueName="[Account]" count="0"/>

end example]

Parent Elements

cacheHierarchies (§18.10.1.5)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

fieldsUsage (Fields Usage)

§18.10.1.31

groupLevels (OLAP Grouping Levels)

§18.10.1.40

Attributes

Description

allCaption (Display Name of 'All')

Specifies the display name of the "all" member of this hierarchy.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

allUniqueName (Unique Name of 'All')

Specifies the unique name of the "all" member of this hierarchy.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

attribute (Attribute Hierarchy)

Specifies a boolean value that indicates whether this hierarchy is an attribute hierarchy. An attribute hierarchy is an OLAP member that is exposed as a flat, single-level hierarchy on the OLAP server.

A value of 1 or true indicates this hierarchy is an attribute hierarchy.

A value of 0 or false indicates this hierarchy is not an attribute hierarchy.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

caption (Hierarchy Display Name)

Specifies the display name of the hierarchy.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

count (Levels Count)

Specifies the number of levels in this hierarchy.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

defaultMemberUniqueName (Default Member Unique Name)

Specifies the unique name of the default member of this hierarchy

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

dimensionUniqueName (Dimension Unique Name)

Specifies the unique name of the dimension to which this hierarchy belongs.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

displayFolder (Display Folder)

Specifies the display folder in which this hierarchy should be displayed.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

hidden (Hidden)

Specifies a boolean value that indicates whether the hierarchy is hidden.

A value of 1 or true indicates this hierarchy is hidden.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

iconSet (KPI Icon Set)

Specifies the icon set to use to visualize a KPI trend or status expression. PivotTables use the icon sets available for conditional formatting in SpreadsheetML. See associated simple type definition for details. The following values are used by PivotTables:

  • no value:  default iconset. For status KPI this corresponds to 3 traffic lights. For trend KPI this corresponds to 3-arrows.

  • 1:  Variance Arrow - 3 arrow.

  • 2:  3 arrows

  • 3:  Status Arrow Ascending - 5 arrows.

  • 4:  Status Arrow Descending - 5 arrows

  • 5:  Standard Arrow - 5 arrows gray.

  • 6:  Traffic Light Single - 3 traffic lights 1.

  • 7:  Traffic Light, Traffic Light Multiple - 3 traffic lights 2.

  • 8:  Gauge Ascending - 5 quarters.

  • 9:  Gauge Descending - 5 quarters.

  • 10: Thermometer, Cylinder, Smiley Face - 3 signs.

  • 11:  Road Signs - 3 symbols.

The possible values for this attribute are defined by the W3C XML Schema int datatype.

keyAttribute (Key Attribute Hierarchy)

Specifies a boolean value that indicates whether this hierarchy is the key attribute hierarchy in an OLAP dimension.

A value of 1 or true indicates this hierarchy is the key attribute hierarchy in an OLAP dimension.

A value of 0 or false indicates this hierarchy is not a key attribute hierarchy.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

measure (Measure Hierarchy)

Specifies a boolean value that indicates whether this hierarchy is a measure.

A value of 1 or true indicates this hierarchy is a measure.

A value of 0 or false indicates this hierarchy is not a measure.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

measureGroup (Measure Group Name)

Specifies the name of the measure group to which this hierarchy belongs.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

measures (Measures)

Specifies a boolean value that indicates whether this hierarchy contains all the measures.

A value of 1 or true indicates this hierarchy contains all the measures.

A value of 0 or false indicates this hierarchy does not contain all the measures.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

memberValueDatatype (Member Value Data Type)

Specifies the data type of the member value. This attribute stores an OLEDB data type.

[Note: Data connectivity can use a number of different technologies. One example of potential values stored in this attribute can be found at: https://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/oledbtype_indicators.asp end note]

memberValueDataType is stored for key attribute hierarchies in order to tell when the application will offer date filtering instead of label filtering in OLAP PivotTables. Date filtering is only offered when the data type is Date/Time. memberValueDatatype="7" indicates a date/time data type.

The possible values for this attribute are defined by the W3C XML Schema unsignedShort datatype.

oneField (One Field)

Specifies a boolean value that indicates whether this hierarchy is associated with only one field due to its position in the view.

A value of 1 or true indicates this hierarchy is associated with only one field.

A value of 0 or false indicates this field is not restricted to only one association due to its position in the user interface.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

parentSet (Parent Set)

Specifies the parent hierarchy of the set. If the attribute is missing it means that the parent hierarchy is unknown or doesn't exist in the cache.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

set (Set)

Specifies a boolean value that indicates whether this hierarchy is a set.

A value of 1 or true indicates this hierarchy is a set.

A value of 0 or false indicates this hierarchy is not a set.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

time (Time)

Specifies a boolean value that indicates whether this hierarchy is of type time.

A value of 1 or true indicates this hierarchy is of type time.

A value of 0 or false indicates is of a different type.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

unbalanced (Unbalanced)

Specifies a boolean value that indicates whether this hierarchy is an unbalanced hierarchy. If value is not written, then this attribute either cannot be determined or does not apply to the current hierarchy.

A value of 1 or true indicates this hierarchy is unbalanced.

A value of 0 or false indicates is balanced.

For more information on balanced hierarchies, see the documentation provided for your OLAP server.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

unbalancedGroup (Unbalanced Group)

Specifies a boolean value that indicated whether the grouped version of this hierarchy is an unbalanced hierarchy. If value is not written, then this attribute either cannot be determined or does not apply to the current hierarchy.

A value of 1 or true indicates this hierarchy is unbalanced when grouped.

A value of 0 or false indicates is balanced when grouped.

For more information on balanced hierarchies, see the documentation provided for your OLAP server.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

uniqueName (Hierarchy Unique Name)

Specifies the unique name of the hierarchy.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

[Note: The W3C XML Schema definition of this element’s content model (CT_CacheHierarchy) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

CacheHierarchy Members

DocumentFormat.OpenXml.Spreadsheet Namespace