xlspivotfield-ag凯发旗舰厅

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

java.lang.object
  com.spire.xls.core.spreadsheet.pivottables.xlspivotfield

all implemented interfaces:

ipivotfield

direct known subclasses:

pivotfield

public class xlspivotfield
extends java.lang.object
implements ipivotfield

xlspivotfield

public xlspivotfield(java.lang.object parent)

getparent

public pivottablefields getparent()

getname

public java.lang.string getname()

returns pivot field name. read-only.

specified by:

getname in interface ipivotfield

returns:

getaxis

public axistypes getaxis()

gets field axis.

specified by:

getaxis in interface ipivotfield

returns:

axistypes

setaxis

public void setaxis(axistypes axis)

sets field axis.

specified by:

setaxis in interface ipivotfield

parameters:

axis - sets field axis.

getnumberformat

public java.lang.string getnumberformat()

gets/sets number format.

specified by:

getnumberformat in interface ipivotfield

returns:

setnumberformat

public void setnumberformat(java.lang.string value)

gets/sets number format.

specified by:

setnumberformat in interface ipivotfield

parameters:

value -

getsubtotals

public subtotaltypes getsubtotals()

gets or sets type of field subtotals.

specified by:

getsubtotals in interface ipivotfield

returns:

setsubtotals

public void setsubtotals(subtotaltypes value)

gets or sets type of field subtotals.

specified by:

setsubtotals in interface ipivotfield

parameters:

value -

candragtorow

public boolean candragtorow()

user can drag field to row area.

specified by:

candragtorow in interface ipivotfield

returns:

candragtorow

public void candragtorow(boolean value)

user can drag field to row area.

specified by:

candragtorow in interface ipivotfield

parameters:

value -

candragtocolumn

public boolean candragtocolumn()

user can drag field to column area.

specified by:

candragtocolumn in interface ipivotfield

returns:

candragtocolumn

public void candragtocolumn(boolean value)

user can drag field to column area.

specified by:

candragtocolumn in interface ipivotfield

parameters:

value -

candragtopage

public boolean candragtopage()

user can drag field to page area.

specified by:

candragtopage in interface ipivotfield

returns:

candragtopage

public void candragtopage(boolean value)

user can drag field to page area.

specified by:

candragtopage in interface ipivotfield

parameters:

value -

candragoff

public boolean candragoff()

user can remove field from view.

specified by:

candragoff in interface ipivotfield

returns:

candragoff

public void candragoff(boolean value)

user can remove field from view.

specified by:

candragoff in interface ipivotfield

parameters:

value -

candragtodata

public boolean candragtodata()

true if the specified field can be dragged to the data position. the default value is true.

specified by:

candragtodata in interface ipivotfield

returns:

candragtodata

public void candragtodata(boolean value)

true if the specified field can be dragged to the data position. the default value is true.

specified by:

candragtodata in interface ipivotfield

parameters:

value -

getdatafield

public boolean getdatafield()

gets value indicating whether this is data field.

returns:

isdatafield

public boolean isdatafield()

gets/sets value indicating whether this is data field.

returns:

getnumberformatindex

public int getnumberformatindex()

gets / sets number format index.

returns:

setnumberformatindex

public void setnumberformatindex(int value)

gets / sets number format index.

parameters:

value -

getsubtotalcaption

public java.lang.string getsubtotalcaption()

specifies the custom text that is displayed for the subtotals caption.

returns:

setsubtotalcaption

public void setsubtotalcaption(java.lang.string value)

specifies the custom text that is displayed for the subtotals caption.

parameters:

value -

getsubtotaltop

public boolean getsubtotaltop()

get or set whether show

returns:

setsubtotaltop

public void setsubtotaltop(boolean value)

get or set whether show

parameters:

value -

isautoshow

public boolean isautoshow()

autoshow is enabled.

returns:

isautoshow

public void isautoshow(boolean value)

autoshow is enabled.

parameters:

value -

isdragtohide

public boolean isdragtohide()

user can remove field from fiew.

returns:

isdragtohide

public void isdragtohide(boolean value)

user can remove field from fiew.

parameters:

value -

getshownewitemsinfilter

public boolean getshownewitemsinfilter()

specifies a boolean value that indicates whether manual filter is in inclusive mode.

returns:

setshownewitemsinfilter

public void setshownewitemsinfilter(boolean value)

specifies a boolean value that indicates whether manual filter is in inclusive mode.

parameters:

value -

getshownewitemsonrefresh

public boolean getshownewitemsonrefresh()

specifies a boolean value that indicates whether new items that appear after a refresh

returns:

setshownewitemsonrefresh

public void setshownewitemsonrefresh(boolean value)

specifies a boolean value that indicates whether new items that appear after a refresh

parameters:

value -

getshowblankrow

public boolean getshowblankrow()

true if a blank row is inserted after the specified row field in a pivottable report.

specified by:

getshowblankrow in interface ipivotfield

returns:

setshowblankrow

public void setshowblankrow(boolean value)

true if a blank row is inserted after the specified row field in a pivottable report.

specified by:

setshowblankrow in interface ipivotfield

parameters:

value -

getshowpagebreak

public boolean getshowpagebreak()

true if a page break is inserted after each field.

returns:

setshowpagebreak

public void setshowpagebreak(boolean value)

true if a page break is inserted after each field.

parameters:

value -

getitemsperpage

public int getitemsperpage()

specifies the number of items showed per page in the pivottable.

returns:

setitemsperpage

public void setitemsperpage(int value)

specifies the number of items showed per page in the pivottable.

parameters:

value -

ismultiselected

public boolean ismultiselected()

specifies a boolean value that indicates whether the field can have multiple items selected in the page field.

returns:

ismultiselected

public void ismultiselected(boolean value)

specifies a boolean value that indicates whether the field can have multiple items selected in the page field.

parameters:

value -

isshowallitems

public boolean isshowallitems()

show all items for this field.

returns:

isshowallitems

public void isshowallitems(boolean value)

show all items for this field.

parameters:

value -

getshowoutline

public boolean getshowoutline()

specifies a boolean value that indicates whether the items in this field should be shown in outline form.

returns:

setshowoutline

public void setshowoutline(boolean value)

specifies a boolean value that indicates whether the items in this field should be shown in outline form.

parameters:

value -

getshowdropdown

public boolean getshowdropdown()

true if the flag for the specified pivottable field or pivottable item is set to "drilled" (expanded, or visible).

returns:

setshowdropdown

public void setshowdropdown(boolean value)

true if the flag for the specified pivottable field or pivottable item is set to "drilled" (expanded, or visible).

parameters:

value -

getshowpropascaption

public boolean getshowpropascaption()

specifies a boolean value that indicates whether to show the property as a member caption.

returns:

setshowpropascaption

public void setshowpropascaption(boolean value)

specifies a boolean value that indicates whether to show the property as a member caption.

parameters:

value -

getshowtooltip

public boolean getshowtooltip()

specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate pivottable cells.

returns:

setshowtooltip

public void setshowtooltip(boolean value)

specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate pivottable cells.

parameters:

value -

getsorttype

public pivotfieldsorttype getsorttype()

specifies the type of sort that is applied to this field.

returns:

setsorttype

public void setsorttype(pivotfieldsorttype value)

specifies the type of sort that is applied to this field.

parameters:

value -

getcaption

public java.lang.string getcaption()

specifies the unique name of the member property to be used as a caption for the field and field items.

returns:

setcaption

public void setcaption(java.lang.string value)

specifies the unique name of the member property to be used as a caption for the field and field items.

parameters:

value -

getcompact

public boolean getcompact()

specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this pivottable resides

returns:

setcompact

public void setcompact(boolean value)

specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this pivottable resides

parameters:

value -

getformula

public java.lang.string getformula()

specifies the formula for the calculated field

specified by:

getformula in interface ipivotfield

returns:

setformula

public void setformula(java.lang.string value)

specifies the formula for the calculated field

specified by:

setformula in interface ipivotfield

parameters:

value -

isformulafield

public boolean isformulafield()

indicates whether this field is formula field

specified by:

isformulafield in interface ipivotfield

returns:

getautosort

public  getautosort()

preserves the sorting elements of the field

returns:

setautosort

public void setautosort( value)

preserves the sorting elements of the field

parameters:

value -

getshowdataas

public pivotfieldformattype getshowdataas()

gets or sets the show data as.

returns:

the show data as.

setshowdataas

public void setshowdataas(pivotfieldformattype value)

gets or sets the show data as.

parameters:

value - the show data as.

additemoption

public void additemoption(int index)

ishiddenitemdetail

public boolean ishiddenitemdetail(int index)

indicates whether the specific pivotitem is hidden detail. must call after pivottable calculatedata function.

parameters:

index - the index of the pivotitem in the pivotfield.

returns:

whether the specific pivotitem is hidden detail

hideitemdetail

public void hideitemdetail(int index,
                           boolean ishiddendetail)

sets whether the specific pivotitem in a pivot field is hidden detail. must call after pivottable calculatedata function.

parameters:

index - the index of the pivotitem in the pivotfield.

ishiddendetail - whether the specific pivotitem is hidden

hideitemdetail

public void hideitemdetail(java.lang.string itemvalue,
                           boolean ishiddendetail)

sets whether the pivotitems in a pivot field is hidden detail.that is collapse/expand this field. must call after pivottable calculatedata function.

parameters:

itemvalue - the value of the pivotitem in the pivotfield.

ishiddendetail - whether the specific pivotitem is hidden

hidedetail

public void hidedetail(boolean ishiddendetail)

sets whether the pivotitems in a pivot field is hidden detail.that is collapse/expand this field. must call after pivottable calculatedata function.

parameters:

ishiddendetail - whether detailitems is hidden

ishiddenitem

public boolean ishiddenitem(int index)

indicates whether the specific pivotitem is hidden. must call after pivottable calculatedata function.

parameters:

index - the index of the pivotitem in the pivotfield.

returns:

whether the specific pivotitem is hidden

hideitem

public void hideitem(java.lang.string itemvalue,
                     boolean ishidden)

sets whether the specific pivotitem in a data field is hidden. must call after pivottable calculatedata function.

parameters:

itemvalue - the value of the pivotitem in the pivotfield.

ishidden - whether the specific pivotitem is hidden

sort

public void sort(java.lang.boolean isascendsort,
                 pivotdatafield sortbyfield)