2.2.4.53 PivotFieldListItem

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

The PivotFieldListItem complex type is used to specify a PivotTable field, visual state information for the PivotTable field, and child PivotTable fields.

 <xs:complexType name="PivotFieldListItem" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="Children" type="tns:ArrayOfPivotFieldListItem"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ShowSeparator" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsSet" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ShowFilterArrow" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="CanDrag" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsCollapsible" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ShowCheckBox" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsCollapsed" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsChecked" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="UserRank" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="FilterImage" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Image" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="InternalMargin" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="TypeTag" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="PivotTableIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="PivotCacheIndex" type="xs:int"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ToolTip" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="UniqueName" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

Children: A list of all the child PivotTable fields as specified in the ArrayOfPivotFieldListItem (section 2.2.4.47) complex type. MUST be present.

ShowSeparator:  MUST be set to true if the PivotTable field is to be followed by a separator line; otherwise, MUST be false. A separator line delineates a grouping of related PivotTable fields.

IsSet: MUST be set to true if the PivotFieldListItem is an OLAP set; otherwise, MUST be false.

ShowFilterArrow: MUST be set to true if the PivotTable field can be used as a filter; otherwise, MUST be false.

CanDrag: MUST be set to true if the PivotTable field can be dragged between PivotTable or PivotChart field list drop zones; otherwise, MUST be false.

IsCollapsible: MUST be set to true if the PivotTable field can be represented in a collapsed state; otherwise, MUST be false. A collapsed state shows no child PivotTable fields.

ShowCheckBox: MUST be set to true if the PivotTable field can be represented in a checked state; otherwise, MUST be false. A checked state determines if the PivotTable field is used in the query.

IsCollapsed: MUST be set to true if the PivotTable field is represented in a collapsed state; otherwise, MUST be false. A collapsed state shows no child PivotTable fields.

IsChecked: MUST be set to true if the PivotTable field is represented in a checked state; otherwise, MUST be false. A checked state determines if the PivotTable field is used in the query.

UserRank: The PivotTable field user rank. MUST be one of the values specified in the following table.

FilterImage: The PivotTable field filter image as specified by the Image element in the PivotFieldListItem (section 2.2.4.53) complex type. MUST be present.

Image: The PivotTable field image. MUST be one of the values specified in the following table.

InternalMargin: The horizontal indent for the PivotTable field. The value is zero-based, where the root node is 0, the child of the root is 1, the child of the child is 2, and so on. MUST be equal to or greater than 0.

TypeTag: The PivotTable field type. MUST be one of the values specified in the following table.

PivotTableIndex: A unique identifier for the protocol server. MUST be greater than or equal to 0. MUST be unique across all the query-related PivotTable fields in the PivotTable or PivotChart.

PivotCacheIndex: A unique identifier for the protocol server. MUST be greater than or equal to 0. MUST be unique across all the PivotTable fields in the PivotTable or PivotChart.

ToolTip: The tooltip for the PivotTable field. MUST be present. MAY be empty.

UniqueName: The unique name of the PivotTable field. MUST be present. MAY be empty.

Name: The PivotTable field name. MUST be present. MUST NOT be empty.