xlspivottable-ag凯发旗舰厅

overview  package   class  tree  deprecated  index  help 
 prev class   next class frames    no frames    
summary: nested | field | constr | method detail: field | constr | method

com.spire.xls.core.spreadsheet.pivottables
class xlspivottable

java.lang.object
  extended by com.spire.xls.core.spreadsheet.xlsobject
      extended by com.spire.xls.core.spreadsheet.pivottables.xlspivottable
all implemented interfaces:
ipivottable
direct known subclasses:
pivottable
public class xlspivottable
extends xlsobject
implements ipivottable
constructor summary
xlspivottable(java.lang.object parent)
           
xlspivottable(java.lang.object parent, int cacheindex, ixlsrange location)
           
 
method summary
 void calculatedata()
          calculates pivottable's data to cells.
 void clear()
          this method clears all the fields, deletes all filtering and sorting applied to the pivottable.
 void clearcolumnfieldfilter(java.lang.string fieldname)
          clear the column field filter.
 void clearfilter(java.lang.string fieldname)
          clear the row and column field filter depends on field name.
 void clearrowfieldfilter(java.lang.string fieldname)
          clear the row field filter.
 java.lang.object deepclone(java.lang.object parent)
           
 java.lang.object deepclone(java.lang.object parent, int cacheindex, java.util.hashmap hashworksheetnames)
           
 boolean getallsubtotaltop()
          indicated whether diplay all subtotal at top of group,change will cover every field's setting
 pivotbuiltinstyles getbuiltinstyle()
          gets/sets built-in pivot style.
 pivotcache getcache()
          returns cache used by this pivot table.
 int getcacheindex()
          gets index of the pivot cache.read-only.
 ipivotcalculatedfields getcalculatedfields()
          returns the collection of calculated fields of the specified pivot table.read-only.
 ipivotfields getcolumnfields()
          returns the collection of column field for the specified pivot table.read-only.
 int getcolumnsperpage()
          specifies the number of columns per page for this pivottable that the filter area will occupy.
 java.lang.string getcustomtablestylename()
           
 pivotdatafields getdatafields()
          gets collection of pivot table data fields.
 boolean getdisplayerrorstring()
          true if the pivottable report displays a custom error string in cells that contain errors.
 boolean getdisplayfieldcaptions()
          gets/sets value controlling whether or not filter buttons and pivotfield captions for rows and columns are displayed in the grid.
 boolean getdisplaynullstring()
          true if the pivottable report displays a custom string in cells that contain null values.
 boolean getenabledrilldown()
          true if drilldown is enabled.
 boolean getenablefielddialog()
          true if the pivottable field dialog box is available when the user double-clicks the pivottable field.
 boolean getenablewizard()
          true if the pivottable wizard is available.
 java.lang.string geterrorstring()
          returns or sets the string displayed in cells that contain errors when the displayerrorstring property is true.
 int getfirstdatacol()
          specifies the first column of the pivottable data, relative to the top left cell in the ref value
 int getfirstdatarow()
          specifies the first column of the pivottable data, relative to the top left cell in the ref value
 int getfirstheaderrow()
          specifies the first row of the pivottable header, relative to the top left cell in the ref value.
 cellrange getlocation()
          returns pivot table location.
 boolean getmanualupdate()
          true if the pivottable report is recalculated only at the user's request.
 boolean getmergelabels()
          true if the specified pivottable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.
 java.lang.string getname()
          gets pivot table name.
 java.lang.string getnullstring()
          returns or sets the string displayed in cells that contain null values when the displaynullstring property is true.
 ipivottableoptions getoptions()
          represents the pivot table options.read-only
 pagesordertype getpagefieldorder()
          returns or sets the order in which page fields are added to the pivottable report layout.
 ipivotfields getpagefields()
          returns the collection of page field for the specified pivot table,read-only.
 java.lang.string getpagefieldstyle()
          returns or sets the style used in the bound page field area.
 int getpagefieldwrapcount()
          returns or sets the number of page fields in each column or row in the pivottable report.
 xlspivottablescollection getparent()
           
  getpivotconditionalformats()
          returns collection of pivot conditional format.
 pivottablefields getpivotfields()
          gets collection of pivot fields.
 boolean getrepeatitemsoneachprintedpage()
          true if row, column, and item labels appear on the first row of each page when the specified pivottable report is printed.
  getreportfilters()
          gets or sets report filter collection
 ipivotfields getrowfields()
          returns the collection of row field for the specified pivot table.read-only.
 int getrowsperpage()
          specifies the number of rows per page for this pivottable that the filter area will occupy.read-only.
 boolean getshowcolheaderstyle()
          specifies a boolean value that indicates whether to show column headers for the table.
 boolean getshowcolstripes()
          specifies a boolean value that indicates whether to show column stripe formatting for the table.
 boolean getshowcolumngrand()
          gets/sets value indicating whether the pivottable contains grand totals for columns.
 boolean getshowdatafieldinrow()
          represents the pivot table to add the calculated data field in rows
 boolean getshowdrillindicators()
          the showdrillindicators property is used for toggling the display of drill indicators in the pivottable.
 boolean getshowlastcol()
          specifies a boolean value that indicates whether to show the last column.
 boolean getshowrowgrand()
          gets/sets value indicating whether the pivottable contains grand totals for rows.
 boolean getshowrowheaderstyle()
          specifies a boolean value that indicates whether to show row headers for the table.
 boolean getshowrowstripes()
          specifies a boolean value that indicates whether to show row stripe formatting for the table.
 xlsworkbook getworkbook()
          gets parent workbook.
 xlsworksheet getworksheet()
           
 boolean iscolumngrand()
          gets/sets value indicating whether the pivottable contains column with grand totals for rows (same as columngrand in vba).
 void iscolumngrand(boolean value)
          gets/sets value indicating whether the pivottable contains column with grand totals for rows (same as columngrand in vba).
 boolean isrowgrand()
          gets/sets value indicating whether the pivottable contains row with grand totals for columns (same as rowgrand in vba).
 void isrowgrand(boolean value)
          gets/sets value indicating whether the pivottable contains row with grand totals for columns (same as rowgrand in vba).
 void setallsubtotaltop(boolean value)
          indicated whether diplay all subtotal at top of group,change will cover every field's setting
 void setbuiltinstyle(pivotbuiltinstyles builtinstyle)
          sets built-in pivot style.
 void setcolumnsperpage(int value)
          specifies the number of columns per page for this pivottable that the filter area will occupy.
 void setcustomtablestylename(java.lang.string value)
           
 void setdisplayerrorstring(boolean value)
          true if the pivottable report displays a custom error string in cells that contain errors.
 void setdisplayfieldcaptions(boolean value)
          gets/sets value controlling whether or not filter buttons and pivotfield captions for rows and columns are displayed in the grid.
 void setdisplaynullstring(boolean value)
          true if the pivottable report displays a custom string in cells that contain null values.
 void setenabledrilldown(boolean value)
          true if drilldown is enabled.
 void setenablefielddialog(boolean value)
          true if the pivottable field dialog box is available when the user double-clicks the pivottable field.
 void setenablewizard(boolean value)
          true if the pivottable wizard is available.
 void seterrorstring(java.lang.string value)
          returns or sets the string displayed in cells that contain errors when the displayerrorstring property is true.
 void setfirstdatacol(int value)
          specifies the first column of the pivottable data, relative to the top left cell in the ref value
 void setfirstheaderrow(int value)
          specifies the first row of the pivottable header, relative to the top left cell in the ref value.
 void setlocation(cellrange value)
          returns pivot table location.
 void setmanualupdate(boolean value)
          true if the pivottable report is recalculated only at the user's request.
 void setmergelabels(boolean value)
          true if the specified pivottable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.
 void setname(java.lang.string value)
          gets pivot table name.
 void setnullstring(java.lang.string value)
          returns or sets the string displayed in cells that contain null values when the displaynullstring property is true.
 void setpagefieldorder(pagesordertype value)
          returns or sets the order in which page fields are added to the pivottable report layout.
 void setpagefieldstyle(java.lang.string value)
          returns or sets the style used in the bound page field area.
 void setpagefieldwrapcount(int value)
          returns or sets the number of page fields in each column or row in the pivottable report.
 void setrepeatitemsoneachprintedpage(boolean value)
          true if row, column, and item labels appear on the first row of each page when the specified pivottable report is printed.
 void setreportfilters( value)
          gets or sets report filter collection
 void setrowsperpage(int value)
          specifies the number of rows per page for this pivottable that the filter area will occupy.read-only.
 void setshowcolheaderstyle(boolean value)
          specifies a boolean value that indicates whether to show column headers for the table.
 void setshowcolstripes(boolean value)
          specifies a boolean value that indicates whether to show column stripe formatting for the table.
 void setshowcolumngrand(boolean value)
          gets/sets value indicating whether the pivottable contains grand totals for columns.
 void setshowdatafieldinrow(boolean value)
          represents the pivot table to add the calculated data field in rows
 void setshowdrillindicators(boolean value)
          the showdrillindicators property is used for toggling the display of drill indicators in the pivottable.
 void setshowlastcol(boolean value)
          specifies a boolean value that indicates whether to show the last column.
 void setshowrowgrand(boolean value)
          gets/sets value indicating whether the pivottable contains grand totals for rows.
 void setshowrowheaderstyle(boolean value)
          specifies a boolean value that indicates whether to show row headers for the table.
 void setshowrowstripes(boolean value)
          specifies a boolean value that indicates whether to show row stripe formatting for the table.
 
methods inherited from class com.spire.xls.core.spreadsheet.xlsobject
dispose
 
constructor detail

xlspivottable

public xlspivottable(java.lang.object parent)

xlspivottable

public xlspivottable(java.lang.object parent,
                     int cacheindex,
                     ixlsrange location)
method detail

getname

public java.lang.string getname()
gets pivot table name. read-only.
specified by:
getname in interface ipivottable
returns:

setname

public void setname(java.lang.string value)
gets pivot table name. read-only.
parameters:
value -

getpivotfields

public pivottablefields getpivotfields()
gets collection of pivot fields. read-only.
specified by:
getpivotfields in interface ipivottable
returns:

getdatafields

public pivotdatafields getdatafields()
gets collection of pivot table data fields. read-only.
specified by:
getdatafields in interface ipivottable
returns:

isrowgrand

public boolean isrowgrand()
gets/sets value indicating whether the pivottable contains row with grand totals for columns (same as rowgrand in vba).
specified by:
isrowgrand in interface ipivottable
returns:

isrowgrand

public void isrowgrand(boolean value)
gets/sets value indicating whether the pivottable contains row with grand totals for columns (same as rowgrand in vba).
parameters:
value -

iscolumngrand

public boolean iscolumngrand()
gets/sets value indicating whether the pivottable contains column with grand totals for rows (same as columngrand in vba).
specified by:
iscolumngrand in interface ipivottable
returns:

iscolumngrand

public void iscolumngrand(boolean value)
gets/sets value indicating whether the pivottable contains column with grand totals for rows (same as columngrand in vba).
parameters:
value -

getshowdrillindicators

public boolean getshowdrillindicators()
the showdrillindicators property is used for toggling the display of drill indicators in the pivottable.
specified by:
getshowdrillindicators in interface ipivottable
returns:

setshowdrillindicators

public void setshowdrillindicators(boolean value)
the showdrillindicators property is used for toggling the display of drill indicators in the pivottable.
parameters:
value -

getdisplayfieldcaptions

public boolean getdisplayfieldcaptions()
gets/sets value controlling whether or not filter buttons and pivotfield captions for rows and columns are displayed in the grid.
specified by:
getdisplayfieldcaptions in interface ipivottable
returns:

setdisplayfieldcaptions

public void setdisplayfieldcaptions(boolean value)
gets/sets value controlling whether or not filter buttons and pivotfield captions for rows and columns are displayed in the grid.
parameters:
value -

getrepeatitemsoneachprintedpage

public boolean getrepeatitemsoneachprintedpage()
true if row, column, and item labels appear on the first row of each page when the specified pivottable report is printed. false if labels are printed only on the first page. the default value is true.
specified by:
getrepeatitemsoneachprintedpage in interface ipivottable
returns:

setrepeatitemsoneachprintedpage

public void setrepeatitemsoneachprintedpage(boolean value)
true if row, column, and item labels appear on the first row of each page when the specified pivottable report is printed. false if labels are printed only on the first page. the default value is true.
parameters:
value -

getbuiltinstyle

public pivotbuiltinstyles getbuiltinstyle()
gets/sets built-in pivot style.
specified by:
getbuiltinstyle in interface ipivottable
returns:

setbuiltinstyle

public void setbuiltinstyle(pivotbuiltinstyles builtinstyle)
sets built-in pivot style.
parameters:
builtinstyle -

getshowrowgrand

public boolean getshowrowgrand()
gets/sets value indicating whether the pivottable contains grand totals for rows.
specified by:
getshowrowgrand in interface ipivottable
returns:

setshowrowgrand

public void setshowrowgrand(boolean value)
gets/sets value indicating whether the pivottable contains grand totals for rows.
parameters:
value -

getshowcolumngrand

public boolean getshowcolumngrand()
gets/sets value indicating whether the pivottable contains grand totals for columns.
specified by:
getshowcolumngrand in interface ipivottable
returns:

setshowcolumngrand

public void setshowcolumngrand(boolean value)
gets/sets value indicating whether the pivottable contains grand totals for columns.
parameters:
value -

getcacheindex

public int getcacheindex()
gets index of the pivot cache.read-only.
specified by:
getcacheindex in interface ipivottable
returns:

getlocation

public cellrange getlocation()
returns pivot table location.
specified by:
getlocation in interface ipivottable
returns:

setlocation

public void setlocation(cellrange value)
returns pivot table location.
parameters:
value -

getoptions

public ipivottableoptions getoptions()
represents the pivot table options.read-only
specified by:
getoptions in interface ipivottable
returns:

getrowsperpage

public int getrowsperpage()
specifies the number of rows per page for this pivottable that the filter area will occupy.read-only.
specified by:
getrowsperpage in interface ipivottable
returns:

setrowsperpage

public void setrowsperpage(int value)
specifies the number of rows per page for this pivottable that the filter area will occupy.read-only.
parameters:
value -

getcolumnsperpage

public int getcolumnsperpage()
specifies the number of columns per page for this pivottable that the filter area will occupy.
specified by:
getcolumnsperpage in interface ipivottable
returns:

setcolumnsperpage

public void setcolumnsperpage(int value)
specifies the number of columns per page for this pivottable that the filter area will occupy.
parameters:
value -

getcalculatedfields

public ipivotcalculatedfields getcalculatedfields()
returns the collection of calculated fields of the specified pivot table.read-only.
specified by:
getcalculatedfields in interface ipivottable
returns:

getpagefields

public ipivotfields getpagefields()
returns the collection of page field for the specified pivot table,read-only.
specified by:
getpagefields in interface ipivottable
returns:

getrowfields

public ipivotfields getrowfields()
returns the collection of row field for the specified pivot table.read-only.
specified by:
getrowfields in interface ipivottable
returns:

getcolumnfields

public ipivotfields getcolumnfields()
returns the collection of column field for the specified pivot table.read-only.
specified by:
getcolumnfields in interface ipivottable
returns:

clear

public void clear()
this method clears all the fields, deletes all filtering and sorting applied to the pivottable.
specified by:
clear in interface ipivottable

clearrowfieldfilter

public void clearrowfieldfilter(java.lang.string fieldname)
clear the row field filter.
specified by:
clearrowfieldfilter in interface ipivottable
parameters:
fieldname - the row field name.

clearcolumnfieldfilter

public void clearcolumnfieldfilter(java.lang.string fieldname)
clear the column field filter.
specified by:
clearcolumnfieldfilter in interface ipivottable
parameters:
fieldname - the column field name.

clearfilter

public void clearfilter(java.lang.string fieldname)
clear the row and column field filter depends on field name.
specified by:
clearfilter in interface ipivottable
parameters:
fieldname - the row and column field name.

getparent

public xlspivottablescollection getparent()
overrides:
getparent in class xlsobject

getdisplayerrorstring

public boolean getdisplayerrorstring()
true if the pivottable report displays a custom error string in cells that contain errors. the default value is false.
returns:

setdisplayerrorstring

public void setdisplayerrorstring(boolean value)
true if the pivottable report displays a custom error string in cells that contain errors. the default value is false.
parameters:
value -

getdisplaynullstring

public boolean getdisplaynullstring()
true if the pivottable report displays a custom string in cells that contain null values. the default value is true.
returns:

setdisplaynullstring

public void setdisplaynullstring(boolean value)
true if the pivottable report displays a custom string in cells that contain null values. the default value is true.
parameters:
value -

getenabledrilldown

public boolean getenabledrilldown()
true if drilldown is enabled. the default value is true.
returns:

setenabledrilldown

public void setenabledrilldown(boolean value)
true if drilldown is enabled. the default value is true.
parameters:
value -

getenablefielddialog

public boolean getenablefielddialog()
true if the pivottable field dialog box is available when the user double-clicks the pivottable field. the default value is true.
returns:

setenablefielddialog

public void setenablefielddialog(boolean value)
true if the pivottable field dialog box is available when the user double-clicks the pivottable field. the default value is true.
parameters:
value -

getenablewizard

public boolean getenablewizard()
true if the pivottable wizard is available. the default value is true.
returns:

setenablewizard

public void setenablewizard(boolean value)
true if the pivottable wizard is available. the default value is true.
parameters:
value -

geterrorstring

public java.lang.string geterrorstring()
returns or sets the string displayed in cells that contain errors when the displayerrorstring property is true.
returns:

seterrorstring

public void seterrorstring(java.lang.string value)
returns or sets the string displayed in cells that contain errors when the displayerrorstring property is true.
parameters:
value -

getmanualupdate

public boolean getmanualupdate()
true if the pivottable report is recalculated only at the user's request. the default value is false.
returns:

setmanualupdate

public void setmanualupdate(boolean value)
true if the pivottable report is recalculated only at the user's request. the default value is false.
parameters:
value -

getmergelabels

public boolean getmergelabels()
true if the specified pivottable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.
returns:

setmergelabels

public void setmergelabels(boolean value)
true if the specified pivottable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.
parameters:
value -

getnullstring

public java.lang.string getnullstring()
returns or sets the string displayed in cells that contain null values when the displaynullstring property is true.
returns:

setnullstring

public void setnullstring(java.lang.string value)
returns or sets the string displayed in cells that contain null values when the displaynullstring property is true.
parameters:
value -

getpagefieldorder

public pagesordertype getpagefieldorder()
returns or sets the order in which page fields are added to the pivottable report layout.
returns:

setpagefieldorder

public void setpagefieldorder(pagesordertype value)
returns or sets the order in which page fields are added to the pivottable report layout.
parameters:
value -

getpagefieldstyle

public java.lang.string getpagefieldstyle()
returns or sets the style used in the bound page field area. the default value is a null string (no style is applied by default).
returns:

setpagefieldstyle

public void setpagefieldstyle(java.lang.string value)
returns or sets the style used in the bound page field area. the default value is a null string (no style is applied by default).
parameters:
value -

getpagefieldwrapcount

public int getpagefieldwrapcount()
returns or sets the number of page fields in each column or row in the pivottable report.
returns:

setpagefieldwrapcount

public void setpagefieldwrapcount(int value)
returns or sets the number of page fields in each column or row in the pivottable report.
parameters:
value -

getcache

public pivotcache getcache()
returns cache used by this pivot table. read-only.
returns:

getpivotconditionalformats

public  getpivotconditionalformats()
returns collection of pivot conditional format. read-only.
returns:

getworkbook

public xlsworkbook getworkbook()
gets parent workbook. read-only.
returns:

getworksheet

public xlsworksheet getworksheet()

getfirstdatacol

public int getfirstdatacol()
specifies the first column of the pivottable data, relative to the top left cell in the ref value
returns:

setfirstdatacol

public void setfirstdatacol(int value)
specifies the first column of the pivottable data, relative to the top left cell in the ref value
parameters:
value -

getfirstdatarow

public int getfirstdatarow()
specifies the first column of the pivottable data, relative to the top left cell in the ref value
returns:

getfirstheaderrow

public int getfirstheaderrow()
specifies the first row of the pivottable header, relative to the top left cell in the ref value.
returns:

setfirstheaderrow

public void setfirstheaderrow(int value)
specifies the first row of the pivottable header, relative to the top left cell in the ref value.
parameters:
value -

getshowcolheaderstyle

public boolean getshowcolheaderstyle()
specifies a boolean value that indicates whether to show column headers for the table.
returns:

setshowcolheaderstyle

public void setshowcolheaderstyle(boolean value)
specifies a boolean value that indicates whether to show column headers for the table.
parameters:
value -

getshowcolstripes

public boolean getshowcolstripes()
specifies a boolean value that indicates whether to show column stripe formatting for the table.
returns:

setshowcolstripes

public void setshowcolstripes(boolean value)
specifies a boolean value that indicates whether to show column stripe formatting for the table.
parameters:
value -

getshowlastcol

public boolean getshowlastcol()
specifies a boolean value that indicates whether to show the last column.
returns:

setshowlastcol

public void setshowlastcol(boolean value)
specifies a boolean value that indicates whether to show the last column.
parameters:
value -

getshowrowheaderstyle

public boolean getshowrowheaderstyle()
specifies a boolean value that indicates whether to show row headers for the table.
returns:

setshowrowheaderstyle

public void setshowrowheaderstyle(boolean value)
specifies a boolean value that indicates whether to show row headers for the table.
parameters:
value -

getshowrowstripes

public boolean getshowrowstripes()
specifies a boolean value that indicates whether to show row stripe formatting for the table.
returns:

setshowrowstripes

public void setshowrowstripes(boolean value)
specifies a boolean value that indicates whether to show row stripe formatting for the table.
parameters:
value -

getshowdatafieldinrow

public boolean getshowdatafieldinrow()
represents the pivot table to add the calculated data field in rows
specified by:
getshowdatafieldinrow in interface ipivottable
returns:

setshowdatafieldinrow

public void setshowdatafieldinrow(boolean value)
represents the pivot table to add the calculated data field in rows
parameters:
value -

getreportfilters

public  getreportfilters()
gets or sets report filter collection
returns:

setreportfilters

public void setreportfilters( value)
gets or sets report filter collection
parameters:
value -

getallsubtotaltop

public boolean getallsubtotaltop()
indicated whether diplay all subtotal at top of group,change will cover every field's setting
returns:

setallsubtotaltop

public void setallsubtotaltop(boolean value)
indicated whether diplay all subtotal at top of group,change will cover every field's setting
parameters:
value -

getcustomtablestylename

public java.lang.string getcustomtablestylename()

setcustomtablestylename

public void setcustomtablestylename(java.lang.string value)

calculatedata

public void calculatedata()
calculates pivottable's data to cells.

deepclone

public java.lang.object deepclone(java.lang.object parent)

deepclone

public java.lang.object deepclone(java.lang.object parent,
                                  int cacheindex,
                                  java.util.hashmap hashworksheetnames)
overview  package   class  tree  deprecated  index  help 
 prev class   next class frames    no frames    
summary: nested | field | constr | method detail: field | constr | method
网站地图