2.4.308 SXTH
The SXTH record specifies properties of a pivot hierarchy.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
frtHeaderOld |
|||||||||||||||||||||||||||||||
|
A |
B |
C |
D |
E |
F |
G |
H |
I |
J |
K |
L |
M |
unused3 |
||||||||||||||||||
|
sxaxis |
reserved |
||||||||||||||||||||||||||||||
|
isxvd |
|||||||||||||||||||||||||||||||
|
csxvdXl |
|||||||||||||||||||||||||||||||
|
N |
O |
P |
Q |
R |
unused4 |
stUnique (variable) |
|||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDisplay (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDefault (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stAll (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDimension (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
cisxvd |
|||||||||||||||||||||||||||||||
|
rgisxvd (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
cHiddenMemberSets |
|||||||||||||||||||||||||||||||
|
rgHiddenMemberSets (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
frtHeaderOld (4 bytes): An FrtHeaderOld structure. The frtHeaderOld.rt field MUST be 0x080D.
A - fMeasure (1 bit): A bit that specifies whether this pivot hierarchy is an OLAP measure, which means it can be placed only on the data axis.
B - unused1 (1 bit): Undefined and MUST be ignored.
C - fOutlineMode (1 bit): A bit that specifies whether the pivot fields representing the levels of this pivot hierarchy have the fOutline field of the SXVDEx record set to 1 when the pivot fields are first created. See Subtotalling for more information.
D - fEnableMultiplePageItems (1 bit): A bit that specifies whether multiple OLAP members can be selected when the pivot hierarchy is on the page axis of the PivotTable view.
E - fSubtotalAtTop (1 bit): A bit that specifies whether the pivot fields representing the levels of this pivot hierarchy have the fSubtotalAtTop field of the SXVDEx record set to 1 when the pivot fields are first created. See Subtotalling for more information.
F - fSet (1 bit): A bit that specifies whether this pivot hierarchy is an OLAP named set. MUST be 0 if fMeasure is 1.
G - fDontShowFList (1 bit): A bit that specifies whether this pivot hierarchy is hidden in the list of pivot fields that can be added to or removed from the PivotTable view.
H - fAttributeHierarchy (1 bit): A bit that specifies whether this pivot hierarchy is an attribute hierarchy.
I - fTimeHierarchy (1 bit): A bit that specifies whether this pivot hierarchy is a time hierarchy.
J - fFilterInclusive (1 bit): A bit that specifies whether manual filters applied to this pivot hierarchy are inclusive or exclusive. MUST be a value from the following table:
|
Value |
Meaning |
|---|---|
|
0 |
OLAP members specified in the manual filter are excluded from the PivotTable view along with their descendants. |
|
1 |
OLAP members specified in the manual filter are included from the PivotTable view along with their ascendants and descendants. |
For more information, see OLAP Manual Filters.
K - unused2 (1 bit): Undefined and MUST be ignored.
L - fKeyAttributeHierarchy (1 bit): A bit that specifies whether this pivot hierarchy is the key attribute hierarchy in the OLAP dimension (1).
M - fKPI (1 bit): A bit that specifies whether this pivot hierarchy is a key performance indicator (KPI) hierarchy.
unused3 (19 bits): Undefined and MUST be ignored.
sxaxis (2 bytes): An SXAxis structure that specifies the axis or axes this pivot hierarchy is present on. For more information, see PivotTable Axes.
If sxaxis.sxaxisData is 1, then sxaxis.sxaxisRw, sxaxis.sxaxisCol, and sxaxis.sxaxisPage MUST be zero.
If sxaxis.sxaxisRw is 1, then sxaxis.sxaxisCol and sxaxis.sxaxisPage MUST be zero.
If sxaxis.sxaxisCol is 1, sxaxis.sxaxisPage MUST be zero.
reserved (2 bytes): MUST be zero, and MUST be ignored.
isxvd (4 bytes): A signed integer that specifies a pivot field index as specified by Pivot Fields. The pivot field index specifies the associated pivot field for this pivot hierarchy.
If the value of sxaxis.sxaxisPage is 1 or the value of sxaxis.sxaxisData is 1, then the value of this field MUST be greater than or equal to 0 and MUST be less than the value of the cDim field of the SxView record of the PivotTable view, and the value of cisxvd MUST be 0. Also, the sxaxis field of the Sxvd record of the referenced pivot field MUST be equal to the sxaxis field of this record.
If both sxaxis.sxaxisPage and sxaxis.sxaxisData are equal to 0, the value of this field MUST be ignored.
csxvdXl (4 bytes): A signed integer that specifies the number of pivot fields in the PivotTable view on PivotTable axes for this pivot hierarchy. MUST be greater than or equal to 0.
-
If sxaxis.sxaxisPage is 1 or sxaxis.sxaxisData is 1, then the value of this field MUST be 1.
-
If sxaxis.sxaxisPage is 0, sxaxis.sxaxisData is 0, sxaxis.sxaxisRw is 0 and sxaxis.sxaxisCol is 0, the value of this field MUST be 0.
-
If sxaxis.sxaxisRw is 1 or sxaxis.sxaxisCol is 1, the restrictions on the value of this field vary depending on the value of the stAll string, as specified in the following table:
-
-
stAll
Value of csxvdXl
Empty
MUST be equal to the value of cisxvd
Not empty
MUST be equal to cisxvd – 1
-
-
-
N - fDragToRow (1 bit): A bit that specifies whether this pivot hierarchy can be placed on the row axis of the PivotTable view. MUST be 0 if fMeasure is 1.
O - fDragToColumn (1 bit): A bit that specifies whether this pivot hierarchy can be placed on the column axis of the PivotTable view. MUST be 0 if fMeasure is 1.
P - fDragToPage (1 bit): A bit that specifies whether this pivot hierarchy can be placed on the page axis of the PivotTable view. MUST be 0 if fMeasure is 1.
Q - fDragToData (1 bit): A bit that specifies whether this pivot hierarchy can be placed on the data axis of the PivotTable view.
R - fDragToHide (1 bit): A bit that specifies whether this pivot hierarchy can be removed from the PivotTable view.
unused4 (11 bits): Undefined and MUST be ignored.
stUnique (variable): An XLUnicodeString structure that specifies the MDX unique name of this pivot hierarchy. The length of the string MUST be greater than zero and less than or equal to 255.
stDisplay (variable): An XLUnicodeString structure that specifies the display name of this pivot hierarchy. The length of the string MUST be greater than zero and less than or equal to 255.
stDefault (variable): An XLUnicodeString structure that specifies the MDX unique name of the default member (2) of this pivot hierarchy. The length of the string MUST be less than or equal to 255.
stAll (variable): An XLUnicodeString structure that specifies the unique name of the ALL member (2) of this pivot hierarchy. The length of the string MUST be less than or equal to 255. A length of zero specifies that there is no ALL member (2) of this pivot hierarchy.
stDimension (variable): An XLUnicodeString structure that specifies the unique name of the OLAP dimension (1) to which this pivot hierarchy belongs, unless the length of the string is zero. The length of the string MUST be less than or equal to 255. If fMeasure is 1, the length of the string MUST be zero.
cisxvd (4 bytes): An unsigned integer that specifies the number of elements in rgisxvd. MUST be zero If sxaxis.sxaxisRw is 0 and sxaxis.sxaxisCol is 0.
rgisxvd (variable): An array of 4-byte signed
integers that specify the pivot fields associated with this pivot hierarchy.
Each array element MUST be a value from the following table:
-
Value
Meaning
-1
No pivot field is referenced.
Greater than or equal to zero
A pivot field index, as specified by pivot fields, that specifies a pivot field that is associated with this pivot hierarchy. The referenced pivot field MUST have an sxaxis field equal to the value of the sxaxis field of this record.
-
This field is arranged such that the nth element in the array is a reference to the Sxvd record that has a related SXVDTEx record that has a value of n for its isxtl field. If there is no such SXVDTEx for the nth element, the value of the nth element MUST be equal to -1.
cHiddenMemberSets (4 bytes): An unsigned integer that specifies the deepest one-based level in the pivot hierarchy that has OLAP members hidden from the PivotTable view. If the value of cisxvd is greater than 0, then the value of this field also specifies the number of elements in rgHiddenMemberSets. If the value of fFilterInclusive is 1, then the value of this field MUST be 0.
rgHiddenMemberSets (variable): An array of HiddenMemberSet structures that specifies which of the OLAP members in the pivot hierarchy are hidden from the PivotTable view through manual filtering at each level of the pivot hierarchy. The index of each member (2) in the array corresponds to a level in the pivot hierarchy, beginning with index 0. MUST exist if and only if cHiddenMemberSets is greater than 0 and cisxvd is greater than 0.