PivotTableHandle (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.OpenXLS.PivotTableHandle

public class PivotTableHandle
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUTO_FORMAT_Classic`
`static int`	`AUTO_FORMAT_Report1`
`static int`	`AUTO_FORMAT_Report10`
`static int`	`AUTO_FORMAT_Report2`
`static int`	`AUTO_FORMAT_Report3`
`static int`	`AUTO_FORMAT_Report4`
`static int`	`AUTO_FORMAT_Report5`
`static int`	`AUTO_FORMAT_Report6`
`static int`	`AUTO_FORMAT_Report7`
`static int`	`AUTO_FORMAT_Report8`
`static int`	`AUTO_FORMAT_Report9`
`static int`	`AUTO_FORMAT_Table1`
`static int`	`AUTO_FORMAT_Table10`
`static int`	`AUTO_FORMAT_Table2`
`static int`	`AUTO_FORMAT_Table3`
`static int`	`AUTO_FORMAT_Table4`
`static int`	`AUTO_FORMAT_Table5`
`static int`	`AUTO_FORMAT_Table6`
`static int`	`AUTO_FORMAT_Table7`
`static int`	`AUTO_FORMAT_Table8`
`static int`	`AUTO_FORMAT_Table9`

Constructor Summary

Constructors
Constructor and Description

PivotTableHandle(Sxview f, WorkBookHandle bk)
Create a new PivotTableHandle from an Excel PivotTable

Constructors
Constructor and Description
`PivotTableHandle(Sxview f, WorkBookHandle bk)` Create a new PivotTableHandle from an Excel PivotTable

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsCol(int x)` returns whether a given col is contained in this PivotTable
`boolean`	`containsRow(int x)` returns whether a given row is contained in this PivotTable
`boolean`	`getAutoAlign()` get whether Alignment Autoformat is applied
`boolean`	`getAutoBorder()` get whether Border Autoformat is applied
`boolean`	`getAutoFont()` get whether Font Autoformat is applied
`int`	`getAutoFormatId()` get the auto format for the Table
`boolean`	`getAutoNumber()` get whether Number Autoformat is applied
`boolean`	`getAutoPattern()` get whether Pattern Autoformat is applied
`boolean`	`getAutoWidthHeight()` get whether Width/Height Autoformat is applied
`int`	`getColFirst()` get the first Column in the PivotTable
`int`	`getColFirstData()` get the first Column containing data
`int`	`getColLast()` get the last Column in the PivotTable
`boolean`	`getColsHaveGrandTotals()` get whether table displays a column grand total
`String`	`getDataName()` returns the name of the data field
`CellRange`	`getDataSourceRange()`
`String`	`getJSON()` returns the JSON representation of this PivotTable
`int`	`getRowFirst()` get the first row in the PivotTable
`int`	`getRowFirstData()` get the first Row containing data
`int`	`getRowFirstHead()` get the first header row
`int`	`getRowLast()` get the last row in the PivotTable
`boolean`	`getRowsHaveGrandTotals()` get whether table displays row grand totals
`String`	`getTableName()` get the Name of the PivotTable
`boolean`	`getUsesAutoFormat()` get whether table has auto format applied
`WorkSheetHandle`	`getWorkSheetHandle()`
`void`	`removeArtifacts()`
`void`	`setAutoAlign(boolean b)` set whether Alignment Autoformat is applied
`void`	`setAutoBorder(boolean b)` set whether Border Autoformat is applied
`void`	`setAutoFont(boolean b)` set whether Font Autoformat is applied
`void`	`setAutoFormatId(int b)` set the auto format for the Table
`void`	`setAutoNumber(boolean b)` set whether Number Autoformat is applied
`void`	`setAutoPattern(boolean b)` set whether Pattern Autoformat is applied
`void`	`setAutoWidthHeight(boolean b)` set Width/Height Autoformat is applied
`void`	`setColFirst(int s)` set the first Column in the PivotTable
`void`	`setColFirstData(int s)` set the first Column containing data
`void`	`setColLast(int s)` set the last Column in the PivotTable
`void`	`setColsHaveGrandTotals(boolean b)` set whether to display a column grand total
`void`	`setDataName(String name)` sets the name of the data field for this pivot table
`void`	`setRowFirst(int s)` set the first row in the PivotTable
`void`	`setRowFirstData(int s)` set the first Row containing data
`void`	`setRowFirstHead(int s)` set the first header row
`void`	`setRowLast(int s)` set the last row in the PivotTable
`void`	`setRowsHaveGrandTotals(boolean b)` set whether to display row grand totals
`void`	`setSource(String namedrange)` Sets the Pivot Table data source from a named range
`void`	`setSourceDataRange(CellRange cellRange)` Sets the Pivot Table Range to represent the Data to analyse NOTE: any existing data will be replaced
`void`	`setSourceDataRange(String range)` Sets the Pivot Table Range to represent the Data to analyse NOTE: any existing data will be replaced If the cell range does not contain sheet information, the sheet that the pivot table is located will be used
`void`	`setTableName(String tx)` set the Name of the PivotTable
`void`	`setUsesAutoFormat(boolean b)` set whether to auto format the Table
`String`	`toString()` return a more friendly

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

- Field Detail
  - AUTO_FORMAT_Report1
```
public static int AUTO_FORMAT_Report1
```
  - AUTO_FORMAT_Report2
```
public static int AUTO_FORMAT_Report2
```
  - AUTO_FORMAT_Report3
```
public static int AUTO_FORMAT_Report3
```
  - AUTO_FORMAT_Report4
```
public static int AUTO_FORMAT_Report4
```
  - AUTO_FORMAT_Report5
```
public static int AUTO_FORMAT_Report5
```
  - AUTO_FORMAT_Report6
```
public static int AUTO_FORMAT_Report6
```
  - AUTO_FORMAT_Report7
```
public static int AUTO_FORMAT_Report7
```
  - AUTO_FORMAT_Report8
```
public static int AUTO_FORMAT_Report8
```
  - AUTO_FORMAT_Report9
```
public static int AUTO_FORMAT_Report9
```
  - AUTO_FORMAT_Report10
```
public static int AUTO_FORMAT_Report10
```
  - AUTO_FORMAT_Table1
```
public static int AUTO_FORMAT_Table1
```
  - AUTO_FORMAT_Table2
```
public static int AUTO_FORMAT_Table2
```
  - AUTO_FORMAT_Table3
```
public static int AUTO_FORMAT_Table3
```
  - AUTO_FORMAT_Table4
```
public static int AUTO_FORMAT_Table4
```
  - AUTO_FORMAT_Table5
```
public static int AUTO_FORMAT_Table5
```
  - AUTO_FORMAT_Table6
```
public static int AUTO_FORMAT_Table6
```
  - AUTO_FORMAT_Table7
```
public static int AUTO_FORMAT_Table7
```
  - AUTO_FORMAT_Table8
```
public static int AUTO_FORMAT_Table8
```
  - AUTO_FORMAT_Table9
```
public static int AUTO_FORMAT_Table9
```
  - AUTO_FORMAT_Table10
```
public static int AUTO_FORMAT_Table10
```
  - AUTO_FORMAT_Classic
```
public static int AUTO_FORMAT_Classic
```
- Constructor Detail
  - PivotTableHandle
```
public PivotTableHandle(Sxview f,
                        WorkBookHandle bk)
```
    Create a new PivotTableHandle from an Excel PivotTable
    
    Parameters:
    
    PivotTable - - the PivotTable to create a handle for.
- Method Detail
  - getWorkSheetHandle
```
public WorkSheetHandle getWorkSheetHandle()
```
  - getDataSourceRange
```
public CellRange getDataSourceRange()
```
    Returns:
    
    Returns the cellRange.
  - setSourceDataRange
```
public void setSourceDataRange(CellRange cellRange)
```
    Sets the Pivot Table Range to represent the Data to analyse
    NOTE: any existing data will be replaced
    
    Parameters:
    
    cellRange - The cellRange to set.
  - setSourceDataRange
```
public void setSourceDataRange(String range)
```
    Sets the Pivot Table Range to represent the Data to analyse
    NOTE: any existing data will be replaced
    If the cell range does not contain sheet information, the sheet that the pivot table is located will be used
    
    Parameters:
    
    cellRange -
  - setSource
```
public void setSource(String namedrange)
```
    Sets the Pivot Table data source from a named range
    
    Parameters:
    
    namedrange - Named Range
  - getTableName
```
public String getTableName()
```
    get the Name of the PivotTable
    
    Returns:
    
    String - value of the PivotTable if stored as a String.
  - setTableName
```
public void setTableName(String tx)
```
    set the Name of the PivotTable
    
    Parameters:
    
    String - - value of the PivotTable if stored as a String.
  - getDataName
```
public String getDataName()
```
    returns the name of the data field
    
    Returns:
  - setDataName
```
public void setDataName(String name)
```
    sets the name of the data field for this pivot table
    
    Parameters:
    
    name -
  - containsRow
```
public boolean containsRow(int x)
```
    returns whether a given row is contained in this PivotTable
    
    Parameters:
    
    int - the row number
    
    Returns:
    
    boolean whether the row is in the table
  - toString
```
public String toString()
```
    return a more friendly
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - containsCol
```
public boolean containsCol(int x)
```
    returns whether a given col is contained in this PivotTable
    
    Parameters:
    
    int - the column number
    
    Returns:
    
    boolean whether the col is in the table
  - setRowsHaveGrandTotals
```
public void setRowsHaveGrandTotals(boolean b)
```
    set whether to display row grand totals
    
    Parameters:
    
    boolean - whether to display row grand totals
  - getRowsHaveGrandTotals
```
public boolean getRowsHaveGrandTotals()
```
    get whether table displays row grand totals
    
    Returns:
    
    boolean whether table displays row grand total
  - setColsHaveGrandTotals
```
public void setColsHaveGrandTotals(boolean b)
```
    set whether to display a column grand total
    
    Parameters:
    
    boolean - whether to display column grand total
  - getColsHaveGrandTotals
```
public boolean getColsHaveGrandTotals()
```
    get whether table displays a column grand total
    
    Returns:
    
    boolean whether table displays column grand total
  - setAutoFormatId
```
public void setAutoFormatId(int b)
```
    set the auto format for the Table
```
         The valid formats are:
         
             PivotTableHandle.AUTO_FORMAT_Report1
             PivotTableHandle.AUTO_FORMAT_Report2
             PivotTableHandle.AUTO_FORMAT_Report3
             PivotTableHandle.AUTO_FORMAT_Report4
             PivotTableHandle.AUTO_FORMAT_Report5
             PivotTableHandle.AUTO_FORMAT_Report6
             PivotTableHandle.AUTO_FORMAT_Report7
             PivotTableHandle.AUTO_FORMAT_Report8
             PivotTableHandle.AUTO_FORMAT_Report9
             PivotTableHandle.AUTO_FORMAT_Report10
             PivotTableHandle.AUTO_FORMAT_Table1
             PivotTableHandle.AUTO_FORMAT_Table2
             PivotTableHandle.AUTO_FORMAT_Table3
             PivotTableHandle.AUTO_FORMAT_Table4
             PivotTableHandle.AUTO_FORMAT_Table5
             PivotTableHandle.AUTO_FORMAT_Table6
             PivotTableHandle.AUTO_FORMAT_Table7
             PivotTableHandle.AUTO_FORMAT_Table8
             PivotTableHandle.AUTO_FORMAT_Table9
             PivotTableHandle.AUTO_FORMAT_Table10
 
```
    Parameters:
    
    int - the auto format Id for the table
  - getAutoFormatId
```
public int getAutoFormatId()
```
    get the auto format for the Table
    
    Returns:
    
    int the auto format Id for the table
  - setUsesAutoFormat
```
public void setUsesAutoFormat(boolean b)
```
    set whether to auto format the Table
    
    Parameters:
    
    boolean - whether to auto format the table
  - getUsesAutoFormat
```
public boolean getUsesAutoFormat()
```
    get whether table has auto format applied
    
    Parameters:
    
    boolean - whether table has auto format applied
  - setAutoWidthHeight
```
public void setAutoWidthHeight(boolean b)
```
    set Width/Height Autoformat is applied
    
    Parameters:
    
    boolean - whether to apply the Width/Height Autoformat
  - getAutoWidthHeight
```
public boolean getAutoWidthHeight()
```
    get whether Width/Height Autoformat is applied
    
    Returns:
    
    boolean whether the Width/Height Autoformat is applied
  - setAutoFont
```
public void setAutoFont(boolean b)
```
    set whether Font Autoformat is applied
    
    Parameters:
    
    boolean - whether to apply the Font Autoformat
  - getAutoFont
```
public boolean getAutoFont()
```
    get whether Font Autoformat is applied
    
    Returns:
    
    boolean whether the Font Autoformat is applied
  - removeArtifacts
```
public void removeArtifacts()
```
  - setAutoAlign
```
public void setAutoAlign(boolean b)
```
    set whether Alignment Autoformat is applied
    
    Parameters:
    
    boolean - whether to apply the Alignment Autoformat
  - getAutoAlign
```
public boolean getAutoAlign()
```
    get whether Alignment Autoformat is applied
    
    Returns:
    
    boolean whether the Alignment Autoformat is applied
  - setAutoBorder
```
public void setAutoBorder(boolean b)
```
    set whether Border Autoformat is applied
    
    Parameters:
    
    boolean - whether to apply the Border Autoformat
  - getAutoBorder
```
public boolean getAutoBorder()
```
    get whether Border Autoformat is applied
    
    Returns:
    
    boolean whether the Border Autoformat is applied
  - setAutoPattern
```
public void setAutoPattern(boolean b)
```
    set whether Pattern Autoformat is applied
    
    Parameters:
    
    boolean - whether to apply the Pattern Autoformat
  - getAutoPattern
```
public boolean getAutoPattern()
```
    get whether Pattern Autoformat is applied
    
    Returns:
    
    boolean whether the Pattern Autoformat is applied
  - setAutoNumber
```
public void setAutoNumber(boolean b)
```
    set whether Number Autoformat is applied
    
    Parameters:
    
    boolean - whether to apply the Number Autoformat
  - getAutoNumber
```
public boolean getAutoNumber()
```
    get whether Number Autoformat is applied
    
    Returns:
    
    boolean whether the Number Autoformat is applied
  - setRowFirst
```
public void setRowFirst(int s)
```
    set the first row in the PivotTable
  - getRowFirst
```
public int getRowFirst()
```
    get the first row in the PivotTable
  - setRowLast
```
public void setRowLast(int s)
```
    set the last row in the PivotTable
  - getRowLast
```
public int getRowLast()
```
    get the last row in the PivotTable
  - setColFirst
```
public void setColFirst(int s)
```
    set the first Column in the PivotTable
  - getColFirst
```
public int getColFirst()
```
    get the first Column in the PivotTable
  - setColLast
```
public void setColLast(int s)
```
    set the last Column in the PivotTable
  - getColLast
```
public int getColLast()
```
    get the last Column in the PivotTable
  - setRowFirstHead
```
public void setRowFirstHead(int s)
```
    set the first header row
  - getRowFirstHead
```
public int getRowFirstHead()
```
    get the first header row
  - setRowFirstData
```
public void setRowFirstData(int s)
```
    set the first Row containing data
  - getRowFirstData
```
public int getRowFirstData()
```
    get the first Row containing data
  - setColFirstData
```
public void setColFirstData(int s)
```
    set the first Column containing data
  - getColFirstData
```
public int getColFirstData()
```
    get the first Column containing data
  - getJSON
```
public String getJSON()
```
    returns the JSON representation of this PivotTable
    
    Returns:
    
    JSON Pivot Table representation

Class PivotTableHandle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTO_FORMAT_Report1

AUTO_FORMAT_Report2

AUTO_FORMAT_Report3

AUTO_FORMAT_Report4

AUTO_FORMAT_Report5

AUTO_FORMAT_Report6

AUTO_FORMAT_Report7

AUTO_FORMAT_Report8

AUTO_FORMAT_Report9

AUTO_FORMAT_Report10

AUTO_FORMAT_Table1

AUTO_FORMAT_Table2

AUTO_FORMAT_Table3

AUTO_FORMAT_Table4

AUTO_FORMAT_Table5

AUTO_FORMAT_Table6

AUTO_FORMAT_Table7

AUTO_FORMAT_Table8

AUTO_FORMAT_Table9

AUTO_FORMAT_Table10

AUTO_FORMAT_Classic

Constructor Detail

PivotTableHandle

Method Detail

getWorkSheetHandle

getDataSourceRange

setSourceDataRange

setSourceDataRange

setSource

getTableName

setTableName

getDataName

setDataName

containsRow

toString

containsCol

setRowsHaveGrandTotals

getRowsHaveGrandTotals

setColsHaveGrandTotals

getColsHaveGrandTotals

setAutoFormatId

getAutoFormatId

setUsesAutoFormat

getUsesAutoFormat

setAutoWidthHeight

getAutoWidthHeight

setAutoFont

getAutoFont

removeArtifacts

setAutoAlign

getAutoAlign

setAutoBorder

getAutoBorder

setAutoPattern

getAutoPattern

setAutoNumber

getAutoNumber

setRowFirst

getRowFirst

setRowLast

getRowLast

setColFirst

getColFirst

setColLast

getColLast

setRowFirstHead

getRowFirstHead

setRowFirstData

getRowFirstData

setColFirstData

getColFirstData

getJSON