PivotOptions Class

Defines the PivotOptions Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is c14:pivotOptions.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Office2010.Drawing.Charts.PivotOptions

Namespace:  DocumentFormat.OpenXml.Office2010.Drawing.Charts
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(DropZoneFilter), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DropZoneCategories), FileFormatVersions.Office2010)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DropZoneData), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DropZoneSeries), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DropZonesVisible), FileFormatVersions.Office2010)> _
Public Class PivotOptions _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As PivotOptions
[ChildElementInfoAttribute(typeof(DropZoneFilter), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DropZoneCategories), FileFormatVersions.Office2010)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DropZoneData), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DropZoneSeries), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DropZonesVisible), FileFormatVersions.Office2010)]
public class PivotOptions : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • DropZoneFilter <c14:dropZoneFilter>

  • DropZoneCategories <c14:dropZoneCategories>

  • DropZoneData <c14:dropZoneData>

  • DropZoneSeries <c14:dropZoneSeries>

  • DropZonesVisible <c14:dropZonesVisible>

2.3.26 pivotOptions

Target namespace: https://schemas.microsoft.com/office/drawing/2007/8/2/chart

A CT_PivotOptions element that specifies which pivot controls are displayed on the chart ([ISO/IEC-29500-1] section 21.2).

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="pivotOptions" type="CT_PivotOptions"/>

See section 5.11 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.5.68 CT_PivotOptions

Target namespace: https://schemas.microsoft.com/office/drawing/2007/8/2/chart

Referenced by: pivotOptions

A complex type that specifies which pivot controls are displayed on the chart ([ISO/IEC-29500-1] section 21.2).

Child Elements:

dropZoneFilter : A CT_BooleanFalse element that specifies whether a control for each PivotTable ([ISO/IEC-29500-1] section 18.10) field on the PivotTable ([ISO/IEC-29500-1] section 18.10) page axis of the source PivotTable ([ISO/IEC-29500-1] section 18.10) is displayed on the chart ([ISO/IEC-29500-1] section 21.2) when dropZonesVisible is TRUE. MUST NOT exist if the parent CT_ChartSpace ([ISO/IEC-29500-4] section A.5.1) element does not have a child CT_PivotSource ([ISO/IEC-29500-4] section A.5.1) element.

dropZoneCategories : A CT_BooleanFalse element that specifies whether a control for each PivotTable ([ISO/IEC-29500-1] section 18.10) field on the PivotTable ([ISO/IEC-29500-1] section 18.10) row axis of the source PivotTable ([ISO/IEC-29500-1] section 18.10) is displayed on the chart ([ISO/IEC-29500-1] section 21.2) when dropZonesVisible is TRUE. MUST NOT exist if the parent CT_ChartSpace ([ISO/IEC-29500-4] section A.5.1) element does not have a child CT_PivotSource ([ISO/IEC-29500-4] section A.5.1) element.

dropZoneData : A CT_BooleanFalse element that specifies whether a control for each PivotTable ([ISO/IEC-29500-1] section 18.10) field on the PivotTable ([ISO/IEC-29500-1] section 18.10) data axis of the source PivotTable ([ISO/IEC-29500-1] section 18.10) is displayed on the chart ([ISO/IEC-29500-1] section 21.2) when dropZonesVisible is TRUE. MUST NOT exist if the parent CT_ChartSpace ([ISO/IEC-29500-4] section A.5.1) element does not have a child CT_PivotSource ([ISO/IEC-29500-4] section A.5.1) element.

dropZoneSeries : A CT_BooleanFalse element that specifies whether a control for each PivotTable ([ISO/IEC-29500-1] section 18.10) field on the PivotTable ([ISO/IEC-29500-1] section 18.10) column axis of the source PivotTable ([ISO/IEC-29500-1] section 18.10) is displayed on the chart ([ISO/IEC-29500-1] section 21.2) when dropZonesVisible is TRUE. MUST NOT exist if the parent CT_ChartSpace ([ISO/IEC-29500-4] section A.5.1) element does not have a child CT_PivotSource ([ISO/IEC-29500-4] section A.5.1) element.

dropZonesVisible : A CT_BooleanFalse element that specifies whether any pivot controls can be displayed on the pivot chart (([ISO/IEC-29500-1] section 21.2). For example, if dropZoneFilter and dropZoneCategories are TRUE and dropZoneData and dropZoneSeries are FALSE, then if dropZonesVisible is TRUE, controls corresponding to PivotTable ([ISO/IEC-29500-1] section 18.10) fields on the PivotTable ([ISO/IEC-29500-1] section 18.10) page axis and PivotTable ([ISO/IEC-29500-1] section 18.10) row axis are displayed on the chart ([ISO/IEC-29500-1] section 21.2), and if dropZonesVisible is FALSE, no controls are displayed on the chart ([ISO/IEC-29500-1] section 21.2). MUST NOT exist if its parent CT_ChartSpace ([ISO/IEC-29500-4] section A.5.1) element does not have a child CT_PivotSource ([ISO/IEC-29500-4] section A.5.1) element.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_PivotOptions">

<xsd:sequence>

<xsd:element name="dropZoneFilter" type="CT_BooleanFalse" minOccurs="0" maxOccurs="1"/>

<xsd:element name="dropZoneCategories" type="CT_BooleanFalse" minOccurs="0" maxOccurs="1"/>

<xsd:element name="dropZoneData" type="CT_BooleanFalse" minOccurs="0" maxOccurs="1"/>

<xsd:element name="dropZoneSeries" type="CT_BooleanFalse" minOccurs="0" maxOccurs="1"/>

<xsd:element name="dropZonesVisible" type="CT_BooleanFalse" minOccurs="0" maxOccurs="1"/>

</xsd:sequence>

</xsd:complexType>

See section 5.11 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

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

PivotOptions Members

DocumentFormat.OpenXml.Office2010.Drawing.Charts Namespace