XlsPivotField module

class XlsPivotField.XlsPivotField

Bases: SpireObject, IPivotField, ICloneParent

AddItemOption(index: int)

<summary>: Represents the index of item and itemoptions key pairs

</summary>

property AutoSort: AutoSortScope

<summary>: Preserves the sorting elements of the field

</summary>

property Axis: AxisTypes

property CanDragOff: bool

property CanDragToColumn: bool

property CanDragToData: bool

property CanDragToPage: bool

property CanDragToRow: bool

property Caption: str

<summary>

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

</summary>

Clone(parent: SpireObject) → SpireObject

property Compact: bool

<summary>

Specifies a boolean value that indicates whether the application will display fields: compactly in the sheet on which this PivotTable resides

</summary>

property DataField: bool

property Formula: str

<summary>: Specifies the formula for the calculated field

</summary>

HideAllItem(isHidden: bool)

<summary>

Sets whether the all PivotItem in a data field is hidden.: Must call after pivottable CalculateData function.

</summary> <param name=”isHidden”>whether the specific PivotItem is hidden</param>

HideDetail(isHiddenDetail: bool)

<summary>

Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.: Must call after pivottable CalculateData function.

</summary> <param name=”isHiddenDetail”>whether DetailItems is hidden</param>

HideItem

<summary>

Sets whether the specific PivotItem in a data field is hidden.: Must call after pivottable CalculateData function.

</summary> <param name=”index”>the index of the pivotItem in the pivotField.</param> <param name=”isHidden”>whether the specific PivotItem is hidden</param>

HideItemDetail

<summary>

Sets whether the specific PivotItem in a pivot field is hidden detail.: Must call after pivottable CalculateData function.

</summary> <param name=”index”>the index of the pivotItem in the pivotField.</param> <param name=”isHiddenDetail”>whether the specific PivotItem is hidden</param>

property IsAutoShow: bool

<summary>: Autoshow is enabled.

</summary>

property IsDataField: bool

property IsDragToHide: bool

<summary>: User can remove field from fiew.

</summary>

property IsFormulaField: bool

<summary>: Indicates whether this field is formula field

</summary>

IsHiddenItem(index: int) → bool

<summary>

Indicates whether the specific PivotItem is hidden.: Must call after pivottable CalculateData function.

</summary> <param name=”index”>the index of the pivotItem in the pivotField.</param> <returns>whether the specific PivotItem is hidden</returns>

IsHiddenItemDetail(index: int) → bool

<summary>

Indicates whether the specific PivotItem is hidden detail.: Must call after pivottable CalculateData function.

</summary> <param name=”index”>the index of the pivotItem in the pivotField.</param> <returns>whether the specific PivotItem is hidden detail</returns>

property IsMultiSelected: bool

<summary>

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

</summary>

property IsShowAllItems: bool

<summary>: Show all items for this field.

</summary>

property ItemsPerPage: int

<summary>: Specifies the number of items showed per page in the PivotTable.

</summary>

property Name: str

property NumberFormat: str

property NumberFormatIndex: int

property Parent: PivotTableFields

property RepeatItemLabels: bool

<summary>: True if the field repeat item labels.

</summary>

property ShowBlankRow: bool

<summary>: True if a blank row is inserted after the specified row field in a PivotTable report.

</summary>

property ShowDataAs: PivotFieldFormatType

property ShowDropDown: bool

<summary>: True if the flag for the specified PivotTable field or PivotTable item is set to “drilled” (expanded, or visible).

</summary>

property ShowNewItemsInFilter: bool

<summary>: Specifies a boolean value that indicates whether manual filter is in inclusive mode.

</summary>

property ShowNewItemsOnRefresh: bool

<summary>

Specifies a boolean value that indicates whether new items that appear after a refresh: should be hidden by default.

</summary>

property ShowOutline: bool

<summary>

Specifies a boolean value that indicates whether the items in this field should be shown: in Outline form. If the parameter is true, the field layout is “Show item labels in outline form”. If the parameter is false, the field layout is “Show item labels in tabular form”.

</summary>

property ShowPageBreak: bool

<summary>: True if a page break is inserted after each field.

</summary>

property ShowPropAsCaption: bool

<summary>

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

</summary>

property ShowToolTip: bool

<summary>

Specifies a boolean value that indicates whether to show the member property value in a: tooltip on the appropriate PivotTable cells.

</summary>

Sort(isAscendSort: bool, sortByField: PivotDataField)

<summary>: Sort row fildes or col fields by data field.

</summary>

property SortType: PivotFieldSortType

<summary>: Specifies the type of sort that is applied to this field.

</summary>

property SubtotalCaption: str

<summary>: Specifies the custom text that is displayed for the subtotals caption.

</summary>

property SubtotalTop: bool

<summary>: Get or set whether show

</summary>

property Subtotals: SubtotalTypes