aspose.cells

Class Slicer

summary description of Slicer View

Property Getters/Setters Summary
functiongetAlternativeText()
function
           Returns or sets the descriptive (alternative) text string of the Slicer object.
functiongetCaption()
function
setCaption(value)
           Returns or sets the caption of the specified slicer.
functiongetCaptionVisible()
function
           Returns or sets whether the header that displays the slicer Caption is visible the default value is true
functiongetColumnWidth()
function
           Returns or sets the width, in points, of each column in the slicer.
functiongetColumnWidthPixel()
function
           Gets or sets the width in unit of pixels for each column of the slicer. 
functiongetHeight()
function
setHeight(value)
           Returns or sets the height of the specified slicer, in points.
functiongetHeightPixel()
function
           Returns or sets the height of the specified slicer, in pixels.
functionisLocked()
function
setLocked(value)
           Indicates whether the slicer shape is locked.
functionisPrintable()
function
           Indicates whether the slicer object is printable.
functiongetLeftPixel()
function
           Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
functiongetLockedAspectRatio()
function
           Indicates whether locking aspect ratio.
functiongetLockedPosition()
function
           Indicates whether the specified slicer can be moved or resized by using the user interface.
functiongetName()
function
setName(value)
           Returns or sets the name of the specified slicer
functiongetNumberOfColumns()
function
           Returns or sets the number of columns in the specified slicer.
functiongetParent()
Returns the Worksheet object that represents the sheet that contains the slicer. Read-only.
functiongetPlacement()
function
           Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. The value of the property is PlacementType integer constant.
functiongetRowHeight()
function
           Returns or sets the height, in points, of each row in the specified slicer.
functiongetRowHeightPixel()
function
           Returns or sets the height, in pixels, of each row in the specified slicer.
functiongetSlicerCache()
Returns the SlicerCache object associated with the slicer. Read-only.
functiongetStyleType()
function
           Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.
functiongetTitle()
function
setTitle(value)
           Specifies the title of the current Slicer object.
functiongetTopPixel()
function
           Returns or sets the vertical offset of slicer shape from its top row, in pixels.
functiongetWidth()
function
setWidth(value)
           Returns or sets the width of the specified slicer, in points.
functiongetWidthPixel()
function
           Returns or sets the width of the specified slicer, in pixels.
 
Method Summary
functionaddPivotConnection(pivot)
Adds PivotTable connection.
functionrefresh()
Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
functionremovePivotConnection(pivot)
Removes PivotTable connection.
 

    • Property Getters/Setters Detail

      • getTitle/setTitle : String 

        function getTitle() / function setTitle(value)
        
        Specifies the title of the current Slicer object.
      • getAlternativeText/setAlternativeText : String 

        function getAlternativeText() / function setAlternativeText(value)
        
        Returns or sets the descriptive (alternative) text string of the Slicer object.
      • isPrintable/setPrintable : boolean 

        function isPrintable() / function setPrintable(value)
        
        Indicates whether the slicer object is printable.
      • isLocked/setLocked : boolean 

        function isLocked() / function setLocked(value)
        
        Indicates whether the slicer shape is locked.
      • getPlacement/setPlacement : Number 

        function getPlacement() / function setPlacement(value)
        
        Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. The value of the property is PlacementType integer constant.
      • getLockedAspectRatio/setLockedAspectRatio : boolean 

        function getLockedAspectRatio() / function setLockedAspectRatio(value)
        
        Indicates whether locking aspect ratio.
      • getLockedPosition/setLockedPosition : boolean 

        function getLockedPosition() / function setLockedPosition(value)
        
        Indicates whether the specified slicer can be moved or resized by using the user interface.
      • getSlicerCache : SlicerCache 

        function getSlicerCache()
        
        Returns the SlicerCache object associated with the slicer. Read-only.
      • getParent : Worksheet 

        function getParent()
        
        Returns the Worksheet object that represents the sheet that contains the slicer. Read-only.
      • getStyleType/setStyleType : Number 

        function getStyleType() / function setStyleType(value)
        
        Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.
      • getName/setName : String 

        function getName() / function setName(value)
        
        Returns or sets the name of the specified slicer
      • getCaption/setCaption : String 

        function getCaption() / function setCaption(value)
        
        Returns or sets the caption of the specified slicer.
      • getCaptionVisible/setCaptionVisible : boolean 

        function getCaptionVisible() / function setCaptionVisible(value)
        
        Returns or sets whether the header that displays the slicer Caption is visible the default value is true
      • getNumberOfColumns/setNumberOfColumns : Number 

        function getNumberOfColumns() / function setNumberOfColumns(value)
        
        Returns or sets the number of columns in the specified slicer.
      • getLeftPixel/setLeftPixel : Number 

        function getLeftPixel() / function setLeftPixel(value)
        
        Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
      • getTopPixel/setTopPixel : Number 

        function getTopPixel() / function setTopPixel(value)
        
        Returns or sets the vertical offset of slicer shape from its top row, in pixels.
      • getWidth/setWidth : Number 

        function getWidth() / function setWidth(value)
        
        Returns or sets the width of the specified slicer, in points.
      • getWidthPixel/setWidthPixel : Number 

        function getWidthPixel() / function setWidthPixel(value)
        
        Returns or sets the width of the specified slicer, in pixels.
      • getHeight/setHeight : Number 

        function getHeight() / function setHeight(value)
        
        Returns or sets the height of the specified slicer, in points.
      • getHeightPixel/setHeightPixel : Number 

        function getHeightPixel() / function setHeightPixel(value)
        
        Returns or sets the height of the specified slicer, in pixels.
      • getColumnWidthPixel/setColumnWidthPixel : Number 

        function getColumnWidthPixel() / function setColumnWidthPixel(value)
        
        Gets or sets the width in unit of pixels for each column of the slicer. 
      • getColumnWidth/setColumnWidth : Number 

        function getColumnWidth() / function setColumnWidth(value)
        
        Returns or sets the width, in points, of each column in the slicer.
      • getRowHeightPixel/setRowHeightPixel : Number 

        function getRowHeightPixel() / function setRowHeightPixel(value)
        
        Returns or sets the height, in pixels, of each row in the specified slicer.
      • getRowHeight/setRowHeight : Number 

        function getRowHeight() / function setRowHeight(value)
        
        Returns or sets the height, in points, of each row in the specified slicer.
    • Method Detail

      • addPivotConnection

        function addPivotConnection(pivot)
        Adds PivotTable connection.
        Parameters:
        pivot: PivotTable - The PivotTable object
      • removePivotConnection

        function removePivotConnection(pivot)
        Removes PivotTable connection.
        Parameters:
        pivot: PivotTable - The PivotTable object
      • refresh

        function refresh()
        Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.