aspose.cells

Class PivotField

Represents a field in a PivotTable report.

Property Getters/Setters Summary
functiongetAutoShowCount()
function
           Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
functiongetAutoShowField()
function
           Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
functiongetAutoSortField()
function
           Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields.
functiongetBaseField()
function
           Represents the base field for a custom calculation. Please use PivotField.BaseFieldIndex instead
functiongetBaseFieldIndex()
function
           Represents the base field for a custom calculation.
functiongetBaseIndex()
function
           Represents the PivotField index in the base PivotFields.
functiongetBaseItem()
function
           Represents the item in the base field for a custom calculation. Valid only for data fields.
functiongetBaseItemIndex()
function
           Represents the item in the base field for a custom calculation. Valid only for data fields.
functiongetBaseItemPosition()
function
           Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute. The value of the property is PivotItemPosition integer constant.
functiongetCurrentPageItem()
function
           Represents the current page item showing for the page field (valid only for page fields).
functiongetDataDisplayFormat()
function
           Represents how to display the values contained in a data field. The value of the property is PivotFieldDataDisplayFormat integer constant.
functiongetDisplayName()
function
           Represents the PivotField display name.
functiongetDragToColumn()
function
           Indicates whether the specified field can be dragged to the column position. The default value is true.
functiongetDragToData()
function
           Indicates whether the specified field can be dragged to the data position. The default value is true.
functiongetDragToHide()
function
           Indicates whether the specified field can be dragged to the hide position. The default value is true.
functiongetDragToPage()
function
           Indicates whether the specified field can be dragged to the page position. The default value is true.
functiongetDragToRow()
function
           Indicates whether the specified field can be dragged to the row position. The default value is true.
functiongetFunction()
function
           Represents the function used to summarize the PivotTable data field. The value of the property is ConsolidationFunction integer constant.
functiongetInsertBlankRow()
function
           Indicates whether inserting blank line after each item.
functionisAscendShow()
function
           Indicates whether the specified PivotTable field is autoshown ascending.
functionisAscendSort()
function
           Indicates whether the specified PivotTable field is autosorted ascending.
functionisAutoShow()
function
           Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
functionisAutoSort()
function
           Indicates whether the specified PivotTable field is automatically sorted.
functionisAutoSubtotals()
function
           Indicates whether the specified field shows automatic subtotals. Default is true.
functionisCalculatedField()
Indicates whether the specified PivotTable field is calculated field.
functionisIncludeNewItemsInFilter()
function
           indicates whether the field can include new items in manual filter The default value is false.
functionisInsertPageBreaksBetweenItems()
function
           indicates whether the field can insert page breaks between items insert page break after each item The default value is false.
functionisMultipleItemSelectionAllowed()
function
           indicates whether the field can have multiple items selected in the page field The default value is false.
functionisRepeatItemLabels()
function
           indicates whether the field can repeat items labels The default value is false.
functiongetItemCount()
Gets the base item count of this pivot field.
functiongetItems()
Get all base items;
functiongetName()
Represents the PivotField name.
functiongetNumber()
function
setNumber(value)
           Represents the built-in display format of numbers and dates.
functiongetNumberFormat()
function
           Represents the custom display format of numbers and dates.
functiongetOriginalItems()
Get the original base items;
functiongetPivotItems()
Gets the pivot items of the pivot field
functiongetPosition()
Represents the PivotField index in the PivotFields.
functiongetRange()
Gets the group range of the pivot field
functiongetShowAllItems()
function
           Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.
functiongetShowCompact()
function
          
functiongetShowInOutlineForm()
function
           Indicates whether layout this field in outline form on the Pivot Table view
functiongetShowSubtotalAtTop()
function
           when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
 
Method Summary
functionaddCalculatedItem(name, formula)
Add a calculated item to the pivot field.
functiongetCalculatedFieldFormula()
Get the formula string of the specified calculated field .
functiongetPivotFilterByType(type)
Gets the pivot filter of the pivot field by type
functiongetPivotFilters()
Gets the pivot filters of the pivot field
functiongetSubtotals(subtotalType)
Gets whether the specified field shows that subtotals.
functionhideDetail(isHiddenDetail)
Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
functionhideItem(index, isHidden)
Sets whether the specific PivotItem in a data field is hidden.
functionhideItem(itemValue, isHidden)
Sets whether the specific PivotItem in a data field is hidden.
functionhideItemDetail(index, isHiddenDetail)
Sets whether the specific PivotItem in a pivot field is hidden detail.
functioninitPivotItems()
Init the pivot items of the pivot field
functionisHiddenItem(index)
Indicates whether the specific PivotItem is hidden.
functionisHiddenItemDetail(index)
Indicates whether the specific PivotItem is hidden detail.
functionsetSubtotals(subtotalType, shown)
Sets whether the specified field shows that subtotals.
 

    • Property Getters/Setters Detail

      • getPivotItems : PivotItemCollection 

        function getPivotItems()
        
        Gets the pivot items of the pivot field
      • getRange : SxRng 

        function getRange()
        
        Gets the group range of the pivot field
      • isCalculatedField : boolean 

        function isCalculatedField()
        
        Indicates whether the specified PivotTable field is calculated field.
      • getBaseIndex/setBaseIndex : Number 

        function getBaseIndex() / function setBaseIndex(value)
        
        Represents the PivotField index in the base PivotFields.
      • getPosition : Number 

        function getPosition()
        
        Represents the PivotField index in the PivotFields.
      • getName : String 

        function getName()
        
        Represents the PivotField name.
      • getDisplayName/setDisplayName : String 

        function getDisplayName() / function setDisplayName(value)
        
        Represents the PivotField display name.
      • isAutoSubtotals/setAutoSubtotals : boolean 

        function isAutoSubtotals() / function setAutoSubtotals(value)
        
        Indicates whether the specified field shows automatic subtotals. Default is true.
      • getDragToColumn/setDragToColumn : boolean 

        function getDragToColumn() / function setDragToColumn(value)
        
        Indicates whether the specified field can be dragged to the column position. The default value is true.
      • getDragToHide/setDragToHide : boolean 

        function getDragToHide() / function setDragToHide(value)
        
        Indicates whether the specified field can be dragged to the hide position. The default value is true.
      • getDragToRow/setDragToRow : boolean 

        function getDragToRow() / function setDragToRow(value)
        
        Indicates whether the specified field can be dragged to the row position. The default value is true.
      • getDragToPage/setDragToPage : boolean 

        function getDragToPage() / function setDragToPage(value)
        
        Indicates whether the specified field can be dragged to the page position. The default value is true.
      • getDragToData/setDragToData : boolean 

        function getDragToData() / function setDragToData(value)
        
        Indicates whether the specified field can be dragged to the data position. The default value is true.
      • isMultipleItemSelectionAllowed/setMultipleItemSelectionAllowed : boolean 

        function isMultipleItemSelectionAllowed() / function setMultipleItemSelectionAllowed(value)
        
        indicates whether the field can have multiple items selected in the page field The default value is false.
      • isRepeatItemLabels/setRepeatItemLabels : boolean 

        function isRepeatItemLabels() / function setRepeatItemLabels(value)
        
        indicates whether the field can repeat items labels The default value is false.
      • isIncludeNewItemsInFilter/setIncludeNewItemsInFilter : boolean 

        function isIncludeNewItemsInFilter() / function setIncludeNewItemsInFilter(value)
        
        indicates whether the field can include new items in manual filter The default value is false.
      • isInsertPageBreaksBetweenItems/setInsertPageBreaksBetweenItems : boolean 

        function isInsertPageBreaksBetweenItems() / function setInsertPageBreaksBetweenItems(value)
        
        indicates whether the field can insert page breaks between items insert page break after each item The default value is false.
      • getShowAllItems/setShowAllItems : boolean 

        function getShowAllItems() / function setShowAllItems(value)
        
        Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.
      • isAutoSort/setAutoSort : boolean 

        function isAutoSort() / function setAutoSort(value)
        
        Indicates whether the specified PivotTable field is automatically sorted.
      • isAscendSort/setAscendSort : boolean 

        function isAscendSort() / function setAscendSort(value)
        
        Indicates whether the specified PivotTable field is autosorted ascending.
      • getAutoSortField/setAutoSortField : Number 

        function getAutoSortField() / function setAutoSortField(value)
        
        Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields.
      • isAutoShow/setAutoShow : boolean 

        function isAutoShow() / function setAutoShow(value)
        
        Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
      • isAscendShow/setAscendShow : boolean 

        function isAscendShow() / function setAscendShow(value)
        
        Indicates whether the specified PivotTable field is autoshown ascending.
      • getAutoShowCount/setAutoShowCount : Number 

        function getAutoShowCount() / function setAutoShowCount(value)
        
        Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
      • getAutoShowField/setAutoShowField : Number 

        function getAutoShowField() / function setAutoShowField(value)
        
        Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
      • getFunction/setFunction : Number 

        function getFunction() / function setFunction(value)
        
        Represents the function used to summarize the PivotTable data field. The value of the property is ConsolidationFunction integer constant.
      • getDataDisplayFormat/setDataDisplayFormat : Number 

        function getDataDisplayFormat() / function setDataDisplayFormat(value)
        
        Represents how to display the values contained in a data field. The value of the property is PivotFieldDataDisplayFormat integer constant.PivotFieldDataDisplayFormat
      • getBaseField/setBaseField : Number 

        function getBaseField() / function setBaseField(value)
        
        Represents the base field for a custom calculation. Please use PivotField.BaseFieldIndex instead NOTE: This member is now obsolete. Instead, please us PivotField.BaseFieldIndex property. This property will be removed 12 months later since April 2016. Aspose apologizes for any inconvenience you may have experienced.
      • getBaseItem/setBaseItem : Number 

        function getBaseItem() / function setBaseItem(value)
        
        Represents the item in the base field for a custom calculation. Valid only for data fields. NOTE: This member is now obsolete. Instead, please us PivotField.BaseItemIndex property. This property will be removed 12 months later since April 2016. Aspose apologizes for any inconvenience you may have experienced.
      • getBaseFieldIndex/setBaseFieldIndex : Number 

        function getBaseFieldIndex() / function setBaseFieldIndex(value)
        
        Represents the base field for a custom calculation.
      • getBaseItemPosition/setBaseItemPosition : Number 

        function getBaseItemPosition() / function setBaseItemPosition(value)
        
        Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute. The value of the property is PivotItemPosition integer constant.PivotItemPosition
      • getBaseItemIndex/setBaseItemIndex : Number 

        function getBaseItemIndex() / function setBaseItemIndex(value)
        
        Represents the item in the base field for a custom calculation. Valid only for data fields.
      • getCurrentPageItem/setCurrentPageItem : Number 

        function getCurrentPageItem() / function setCurrentPageItem(value)
        
        Represents the current page item showing for the page field (valid only for page fields).
      • getNumber/setNumber : Number 

        function getNumber() / function setNumber(value)
        
        Represents the built-in display format of numbers and dates.
      • getInsertBlankRow/setInsertBlankRow : boolean 

        function getInsertBlankRow() / function setInsertBlankRow(value)
        
        Indicates whether inserting blank line after each item.
      • getShowSubtotalAtTop/setShowSubtotalAtTop : boolean 

        function getShowSubtotalAtTop() / function setShowSubtotalAtTop(value)
        
        when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
      • getShowInOutlineForm/setShowInOutlineForm : boolean 

        function getShowInOutlineForm() / function setShowInOutlineForm(value)
        
        Indicates whether layout this field in outline form on the Pivot Table view
      • getNumberFormat/setNumberFormat : String 

        function getNumberFormat() / function setNumberFormat(value)
        
        Represents the custom display format of numbers and dates.
      • getItems : String[] 

        function getItems()
        
        Get all base items;
      • getOriginalItems : String[] 

        function getOriginalItems()
        
        Get the original base items;
      • getItemCount : Number 

        function getItemCount()
        
        Gets the base item count of this pivot field.
      • getShowCompact/setShowCompact : boolean 

        function getShowCompact() / function setShowCompact(value)
        
    • Method Detail

      • getPivotFilterByType

        function getPivotFilterByType(type)
        Gets the pivot filter of the pivot field by type
        Parameters:
        type - A PivotFilterType value.
      • getPivotFilters

        function getPivotFilters()
        Gets the pivot filters of the pivot field
      • initPivotItems

        function initPivotItems()
        Init the pivot items of the pivot field
      • getCalculatedFieldFormula

        function getCalculatedFieldFormula()
        Get the formula string of the specified calculated field .
      • setSubtotals

        function setSubtotals(subtotalType, shown)
        Sets whether the specified field shows that subtotals. PivotFieldSubtotalType
        Parameters:
        subtotalType: Number - A PivotFieldSubtotalType value. subtotals type.
        shown: boolean - whether the specified field shows that subtotals.
      • getSubtotals

        function getSubtotals(subtotalType)
        Gets whether the specified field shows that subtotals.
        Parameters:
        subtotalType: Number - A PivotFieldSubtotalType value. subtotals type.
        Returns:
        whether the specified field shows that subtotals.
      • isHiddenItem

        function isHiddenItem(index)
        Indicates whether the specific PivotItem is hidden.
        Parameters:
        index: Number - the index of the pivotItem in the pivotField.
        Returns:
        whether the specific PivotItem is hidden
      • hideItem

        function hideItem(index, isHidden)
        Sets whether the specific PivotItem in a data field is hidden.
        Parameters:
        index: Number - the index of the pivotItem in the pivotField.
        isHidden: boolean - whether the specific PivotItem is hidden
      • isHiddenItemDetail

        function isHiddenItemDetail(index)
        Indicates whether the specific PivotItem is hidden detail.
        Parameters:
        index: Number - the index of the pivotItem in the pivotField.
        Returns:
        whether the specific PivotItem is hidden detail
      • hideItemDetail

        function hideItemDetail(index, isHiddenDetail)
        Sets whether the specific PivotItem in a pivot field is hidden detail.
        Parameters:
        index: Number - the index of the pivotItem in the pivotField.
        isHiddenDetail: boolean - whether the specific PivotItem is hidden
      • hideDetail

        function hideDetail(isHiddenDetail)
        Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
        Parameters:
        isHiddenDetail: boolean - whether the PivotItems is hidden
      • hideItem

        function hideItem(itemValue, isHidden)
        Sets whether the specific PivotItem in a data field is hidden.
        Parameters:
        itemValue: String - the value of the pivotItem in the pivotField.
        isHidden: boolean - whether the specific PivotItem is hidden
      • addCalculatedItem

        function addCalculatedItem(name, formula)
        Add a calculated item to the pivot field. Only supports to add calculated item to Row/Column field.
        Parameters:
        name: String - The item's name.
        formula: String - The item's formula