CTPivotArea (docx4j-openxml-objects-sml 8.3.1 API)

java.lang.Object
- org.xlsx4j.sml.CTPivotArea

All Implemented Interfaces:: Child

public class CTPivotArea
extends Object
implements Child

Java class for CT_PivotArea complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_PivotArea">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="references" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_PivotAreaReferences" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="field" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="type" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_PivotAreaType" default="normal" />
       <attribute name="dataOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="labelOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="grandRow" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="grandCol" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="cacheIndex" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="outline" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="offset" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_Ref" />
       <attribute name="collapsedLevelsAreSubtotals" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="axis" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_Axis" />
       <attribute name="fieldPosition" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected STAxis`	`axis`
`protected Boolean`	`cacheIndex`
`protected Boolean`	`collapsedLevelsAreSubtotals`
`protected Boolean`	`dataOnly`
`protected CTExtensionList`	`extLst`
`protected Integer`	`field`
`protected Long`	`fieldPosition`
`protected Boolean`	`grandCol`
`protected Boolean`	`grandRow`
`protected Boolean`	`labelOnly`
`protected String`	`offset`
`protected Boolean`	`outline`
`protected CTPivotAreaReferences`	`references`
`protected STPivotAreaType`	`type`

Constructor Summary

Constructors
Constructor and Description

CTPivotArea()

Constructors
Constructor and Description
`CTPivotArea()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`STAxis`	`getAxis()` Gets the value of the axis property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`Integer`	`getField()` Gets the value of the field property.
`Long`	`getFieldPosition()` Gets the value of the fieldPosition property.
`String`	`getOffset()` Gets the value of the offset property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`CTPivotAreaReferences`	`getReferences()` Gets the value of the references property.
`STPivotAreaType`	`getType()` Gets the value of the type property.
`boolean`	`isCacheIndex()` Gets the value of the cacheIndex property.
`boolean`	`isCollapsedLevelsAreSubtotals()` Gets the value of the collapsedLevelsAreSubtotals property.
`boolean`	`isDataOnly()` Gets the value of the dataOnly property.
`boolean`	`isGrandCol()` Gets the value of the grandCol property.
`boolean`	`isGrandRow()` Gets the value of the grandRow property.
`boolean`	`isLabelOnly()` Gets the value of the labelOnly property.
`boolean`	`isOutline()` Gets the value of the outline property.
`void`	`setAxis(STAxis value)` Sets the value of the axis property.
`void`	`setCacheIndex(Boolean value)` Sets the value of the cacheIndex property.
`void`	`setCollapsedLevelsAreSubtotals(Boolean value)` Sets the value of the collapsedLevelsAreSubtotals property.
`void`	`setDataOnly(Boolean value)` Sets the value of the dataOnly property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setField(Integer value)` Sets the value of the field property.
`void`	`setFieldPosition(Long value)` Sets the value of the fieldPosition property.
`void`	`setGrandCol(Boolean value)` Sets the value of the grandCol property.
`void`	`setGrandRow(Boolean value)` Sets the value of the grandRow property.
`void`	`setLabelOnly(Boolean value)` Sets the value of the labelOnly property.
`void`	`setOffset(String value)` Sets the value of the offset property.
`void`	`setOutline(Boolean value)` Sets the value of the outline property.
`void`	`setParent(Object parent)`
`void`	`setReferences(CTPivotAreaReferences value)` Sets the value of the references property.
`void`	`setType(STPivotAreaType value)` Sets the value of the type property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - references
```
protected CTPivotAreaReferences references
```
  - extLst
```
protected CTExtensionList extLst
```
  - field
```
protected Integer field
```
  - type
```
protected STPivotAreaType type
```
  - dataOnly
```
protected Boolean dataOnly
```
  - labelOnly
```
protected Boolean labelOnly
```
  - grandRow
```
protected Boolean grandRow
```
  - grandCol
```
protected Boolean grandCol
```
  - cacheIndex
```
protected Boolean cacheIndex
```
  - outline
```
protected Boolean outline
```
  - offset
```
protected String offset
```
  - collapsedLevelsAreSubtotals
```
protected Boolean collapsedLevelsAreSubtotals
```
  - axis
```
protected STAxis axis
```
  - fieldPosition
```
protected Long fieldPosition
```
- Constructor Detail
  - CTPivotArea
```
public CTPivotArea()
```
- Method Detail
  - getReferences
```
public CTPivotAreaReferences getReferences()
```
    Gets the value of the references property.
    
    Returns:
    
    possible object is CTPivotAreaReferences
  - setReferences
```
public void setReferences(CTPivotAreaReferences value)
```
    Sets the value of the references property.
    
    Parameters:
    
    value - allowed object is CTPivotAreaReferences
  - getExtLst
```
public CTExtensionList getExtLst()
```
    Gets the value of the extLst property.
    
    Returns:
    
    possible object is CTExtensionList
  - setExtLst
```
public void setExtLst(CTExtensionList value)
```
    Sets the value of the extLst property.
    
    Parameters:
    
    value - allowed object is CTExtensionList
  - getField
```
public Integer getField()
```
    Gets the value of the field property.
    
    Returns:
    
    possible object is Integer
  - setField
```
public void setField(Integer value)
```
    Sets the value of the field property.
    
    Parameters:
    
    value - allowed object is Integer
  - getType
```
public STPivotAreaType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is STPivotAreaType
  - setType
```
public void setType(STPivotAreaType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is STPivotAreaType
  - isDataOnly
```
public boolean isDataOnly()
```
    Gets the value of the dataOnly property.
    
    Returns:
    
    possible object is Boolean
  - setDataOnly
```
public void setDataOnly(Boolean value)
```
    Sets the value of the dataOnly property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isLabelOnly
```
public boolean isLabelOnly()
```
    Gets the value of the labelOnly property.
    
    Returns:
    
    possible object is Boolean
  - setLabelOnly
```
public void setLabelOnly(Boolean value)
```
    Sets the value of the labelOnly property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isGrandRow
```
public boolean isGrandRow()
```
    Gets the value of the grandRow property.
    
    Returns:
    
    possible object is Boolean
  - setGrandRow
```
public void setGrandRow(Boolean value)
```
    Sets the value of the grandRow property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isGrandCol
```
public boolean isGrandCol()
```
    Gets the value of the grandCol property.
    
    Returns:
    
    possible object is Boolean
  - setGrandCol
```
public void setGrandCol(Boolean value)
```
    Sets the value of the grandCol property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isCacheIndex
```
public boolean isCacheIndex()
```
    Gets the value of the cacheIndex property.
    
    Returns:
    
    possible object is Boolean
  - setCacheIndex
```
public void setCacheIndex(Boolean value)
```
    Sets the value of the cacheIndex property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isOutline
```
public boolean isOutline()
```
    Gets the value of the outline property.
    
    Returns:
    
    possible object is Boolean
  - setOutline
```
public void setOutline(Boolean value)
```
    Sets the value of the outline property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getOffset
```
public String getOffset()
```
    Gets the value of the offset property.
    
    Returns:
    
    possible object is String
  - setOffset
```
public void setOffset(String value)
```
    Sets the value of the offset property.
    
    Parameters:
    
    value - allowed object is String
  - isCollapsedLevelsAreSubtotals
```
public boolean isCollapsedLevelsAreSubtotals()
```
    Gets the value of the collapsedLevelsAreSubtotals property.
    
    Returns:
    
    possible object is Boolean
  - setCollapsedLevelsAreSubtotals
```
public void setCollapsedLevelsAreSubtotals(Boolean value)
```
    Sets the value of the collapsedLevelsAreSubtotals property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getAxis
```
public STAxis getAxis()
```
    Gets the value of the axis property.
    
    Returns:
    
    possible object is STAxis
  - setAxis
```
public void setAxis(STAxis value)
```
    Sets the value of the axis property.
    
    Parameters:
    
    value - allowed object is STAxis
  - getFieldPosition
```
public Long getFieldPosition()
```
    Gets the value of the fieldPosition property.
    
    Returns:
    
    possible object is Long
  - setFieldPosition
```
public void setFieldPosition(Long value)
```
    Sets the value of the fieldPosition property.
    
    Parameters:
    
    value - allowed object is Long
  - getParent
```
public Object getParent()
```
    Gets the parent object in the object tree representing the unmarshalled xml document.
    
    Specified by:
    
    getParent in interface Child
    
    Returns:
    
    The parent object.
  - setParent
```
public void setParent(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)
```
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    
    Parameters:
    
    parent - The parent object in the object tree.
    
    unmarshaller - The unmarshaller that generated the instance.

Class CTPivotArea

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

references

extLst

field

type

dataOnly

labelOnly

grandRow

grandCol

cacheIndex

outline

offset

collapsedLevelsAreSubtotals

axis

fieldPosition

Constructor Detail

CTPivotArea

Method Detail

getReferences

setReferences

getExtLst

setExtLst

getField

setField

getType

setType

isDataOnly

setDataOnly

isLabelOnly

setLabelOnly

isGrandRow

setGrandRow

isGrandCol

setGrandCol

isCacheIndex

setCacheIndex

isOutline

setOutline

getOffset

setOffset

isCollapsedLevelsAreSubtotals

setCollapsedLevelsAreSubtotals

getAxis

setAxis

getFieldPosition

setFieldPosition

getParent

setParent

afterUnmarshal