2.4.301 SxRule
The SxRule record specifies areas or parts of a one or more PivotTable views, as specified in PivotTable rules, and that specifies the beginning of a collection of SxFilt records as specified by the Common Productions ABNF. Each SxFilt record specifies an individual area or part of the PivotTable view.
If this record occurs as part of the specification of a PivotTable view, references (in this record and in the collection) to pivot fields, the data field, and pivot items are instances of those entities in the context of the PivotTable view.
If this record occurs as part of the specification of a PivotCache, references (in this record and the collection) to PivotTable view, pivot fields, the data field, and pivot items are instances of those entities in the context of all the associated PivotTable views of the PivotCache.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
iDim |
isxvd |
A |
B |
C |
D |
sxrType |
E |
F |
G |
H |
I |
J |
K |
L |
|||||||||||||||||
|
reserved |
csxFilt |
||||||||||||||||||||||||||||||
|
irwFirst (optional) |
irwLast (optional) |
icolFirst (optional) |
icolLast (optional) |
||||||||||||||||||||||||||||
iDim (8 bits): An unsigned integer that specifies the zero-based position of the pivot field specified by isxvd within the PivotTable axis. MUST be greater than or equal to 0 and less than or equal to 255.
isxvd (8 bits): An unsigned integer that specifies the data field, pivot field, or cache field that this rule refers to. MUST be equal to 0xFF if this record is followed by any SxFilt records. MUST be a value from the following table:
-
Value
Value of fCacheBased
Meaning
0 to 0xFD
0
Specifies a pivot field index, as specified by pivot fields, to the pivot field that this rule refers to.
0 to 0xFD
1
Specifies a cache field index, as specified by cache fields, to the cache field that this rule refers to.
0xFE
MUST be 0
Specifies that this rule refers to the data field.
0xFF
0
Specifies that the rule is followed by zero or more SxFilt records, which specify the pivot fields that this rule refers to.
0xFF
1
Specifies that the rule is followed by zero or more SxFilt records, which specify the cache fields that this rule refers to.
A - sxaxisRw (1 bit): A bit that specifies whether the row axis is referenced by this record.
-
MUST be zero if sxaxisCol is 1, sxaxisPage is 1, or sxaxisData is 1.
B - sxaxisCol (1 bit): A bit that specifies whether the column axis is referenced by this record.
-
MUST be zero if sxaxisRw is 1, sxaxisPage is 1, or sxaxisData is 1.
C - sxaxisPage (1 bit): A bit that specifies whether the page axis is referenced by this record.
-
MUST be zero if sxaxisRw is 1, sxaxisCol is 1, or sxaxisData is 1.
D - sxaxisData (1 bit): A bit that specifies whether the value axis is referenced by this record.
-
MUST be zero if sxaxisRw is 1, sxaxisCol is 1, or sxaxisPage is 1.
sxrType (4 bits): An unsigned integer that specifies the PivotTable view area that this rule refers to. MUST be a value from the following table:
-
Value
Meaning
0x0
Does not refer to any area.
0x1
Refers to one or more pivot fields specified by SxFilt records that follow this record.
0x2
Refers to cells displaying values of data items specified by SxFilt records that follow this record.
0x3
Refers to the entire PivotTable view.
0x4
Refers to the cells at the top-left of the PivotTable view, or at the top-right for a right-to-left sheet. For more information about this area, see Location and Body.
0x5
Refers to a cell displaying a pivot field caption.
The pivot field is specified by isxvd.
0x6
Refers to the cells at the top-right of the PivotTable view, or at the top-left for a right-to-left sheet. For more information about this area, see Location and Body.
This rule is followed by SxFilt records if and only if that value of sxrType is equal to 0x1 or 0x2.
E - fPart (1 bit): A bit that specifies whether only a portion of the PivotTable view area is included in this rule. If the value equals 1, irwFirst, irwLast, icolFirst, and icolLast hold the relative location in the PivotTable view area included in this rule.
F - fDataOnly (1 bit): A bit that specifies whether only the data cells of the PivotTable view are included in this rule. MUST be 0 if fLabelOnly is equal to 1.
G - fLabelOnly (1 bit): A bit that specifies whether only the labels of the PivotTable view are included in this rule. MUST be 1 if sxrType is equal to 0x5 or 0x6. MUST be 0 if fDataOnly is equal to 1.
H - fGrandRw (1 bit): A bit that specifies whether the grand total row is included in this rule.
I - fGrandCol (1 bit): A bit that specifies whether the grand total column is included in this rule.
J - fGrandRwSav (1 bit): A bit that specifies whether the grand total row was included in this PivotTable rule when the PivotTable rule was created.
K - fCacheBased (1 bit): A bit that specifies whether isxvd specifies a cache field in the PivotCache, or a pivot field or the data field in a PivotTable view.
|
Value |
Meaning |
|---|---|
|
0 |
isxvd specifies a pivot field or the data field in a PivotTable view. |
|
1 |
isxvd specifies a cache field in the PivotCache. |
L - fGrandColSav (1 bit): A bit that specifies whether the grand total column was included in this PivotTable rule when the PivotTable rule was created.
reserved (2 bytes): MUST be zero, and MUST be ignored.
csxFilt (2 bytes): An unsigned integer that specifies the number of SxFilt records following this record. MUST be zero if sxrType is neither 0x1 nor 0x2.
irwFirst (1 byte): An optional unsigned integer that specifies the offset of the first row, from the first cell in the PivotTable view area to the first cell in the partial area included in this rule. MUST be less than or equal to 255. This field MUST NOT exist if fPart is equal to 0.
irwLast (1 byte): An optional unsigned integer that specifies the offset of the last row, from the first cell in the PivotTable view area to the last cell in the partial area included in this rule. MUST be greater than or equal to irwFirst and less than or equal to 255. This field MUST NOT exist if fPart is equal to 0.
icolFirst (1 byte): An optional unsigned integer that specifies the offset of the first column, from the first cell in the PivotTable view area to the first cell in the partial area included in this rule. MUST be less than or equal to 255. This field MUST NOT exist if fPart is equal to 0.
icolLast (1 byte): An optional unsigned integer that specifies the offset of the last column, from the first cell in the PivotTable view area to the last cell in the partial area included in this rule. MUST be greater than or equal to icolFirst and less than or equal to 255. This field MUST NOT exist if fPart is equal to 0.