3.1.4.47.3.1 PivotFieldApplyData
Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/
The PivotFieldApplyData complex type specifies PivotTable field information (including how it is changing) to apply to a PivotTable or PivotChart.
-
<xs:complexType name="PivotFieldApplyData" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:sequence> <xs:element minOccurs="1" maxOccurs="1" name="FieldListType" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="FieldListVersion" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="FieldWellVersion" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="SourceAxis" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="SourceAxisPosition" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="ItemType" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="ItemIndex" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="DestinationAxis" type="xs:int"/> <xs:element minOccurs="1" maxOccurs="1" name="DestinationAxisPosition" type="xs:int"/> </xs:sequence> </xs:complexType>
FieldListType: The PivotTable field list type. MUST be one of the values specified in the following table.
|
Value |
Meaning |
|---|---|
|
1 |
Associated with the entire Pivot (PivotTable or PivotChart) |
|
4 |
Associated with a particular entity within the Pivot (PivotTable or PivotChart) |
FieldListVersion: A unique identifier for the state of the PivotTable fields on the protocol server. MUST be equal to or greater than -1. The protocol client MUST use one of the following values:
-1, in which case the protocol server MUST bypass the version validation.
The value obtained from the FieldListVersion element as specified in either the PivotFieldListData (section 3.1.4.52.3.1) complex type or the PivotFieldManagerData section 3.1.4.53.3.1) complex type.
FieldWellVersion: A unique identifier for the state of the PivotTable or PivotChart on the protocol server. MUST be equal to or greater than -1. The protocol client MUST use one of the following values:
-1, in which case the protocol server MUST bypass the version validation.
The value obtained from the FieldWellVersion element as specified in the PivotFieldManagerData (section 3.1.4.53.3.1) complex type.
SourceAxis: An identifier for the source axis of the PivotTable field. MUST be one of the values specified in the following table.
|
Value |
Meaning |
|---|---|
|
0 |
Null (adds the specified PivotTable field to the DestinationAxis) |
|
1 |
Rows |
|
2 |
Columns |
|
4 |
Filter |
|
8 |
Data |
SourceAxisPosition: A zero-based index of the source axis position. MUST be present. If SourceAxis is Null, SourceAxisPosition MUST be ignored by the protocol server.
ItemType: The PivotTable field type as specified by the TypeTag element in the PivotFieldListItem (section 2.2.4.53) complex type. MUST be present.
ItemIndex: A PivotTable field index. If SourceAxis is Null (0), ItemIndex MUST be the PivotCacheIndex element as specified in the PivotFieldListItem (section 2.2.4.53) complex type. Otherwise, ItemIndex MUST be the PivotTableIndex element as specified in the PivotFieldListItem (section 2.2.4.53) complex type.
DestinationAxis: An identifier for the destination axis of the PivotTable field. MUST be one of the values specified in the following table.
|
Value |
Meaning |
|---|---|
|
-1 |
Default |
|
0 |
Null (removes the specified PivotTable field from the SourceAxis) |
|
1 |
Rows |
|
2 |
Columns |
|
4 |
Filter |
|
8 |
Data |
DestinationAxisPosition: A zero-based index of the destination axis position before the source axis is removed and the item is added before the indexed item. MUST be present. If DestinationAxis is Default or Null, DestinationAxisPosition MUST be ignored by the protocol server.