com.aspose.cells

Class Slicer

  • java.lang.Object
    • com.aspose.cells.Slicer
public class Slicer 
extends java.lang.Object

summary description of Slicer View

Property Getters/Setters Summary
java.lang.StringgetAlternativeText()
void
setAlternativeText(java.lang.String)
           Returns or sets the descriptive (alternative) text string of the Slicer object.
java.lang.StringgetCaption()
void
setCaption(java.lang.String)
           Returns or sets the caption of the specified slicer.
booleangetCaptionVisible()
void
           Returns or sets whether the header that displays the slicer Caption is visible the default value is true
doublegetColumnWidth()
void
           Returns or sets the width, in points, of each column in the slicer.
intgetColumnWidthPixel()
void
           Gets or sets the width in unit of pixels for each column of the slicer. 
doublegetHeight()
void
setHeight(double)
           Returns or sets the height of the specified slicer, in points.
intgetHeightPixel()
void
           Returns or sets the height of the specified slicer, in pixels.
booleanisLocked()
void
setLocked(boolean)
           Indicates whether the slicer shape is locked.
booleanisPrintable()
void
setPrintable(boolean)
           Indicates whether the slicer object is printable.
intgetLeftPixel()
void
           Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
booleangetLockedAspectRatio()
void
           Indicates whether locking aspect ratio.
booleangetLockedPosition()
void
           Indicates whether the specified slicer can be moved or resized by using the user interface.
java.lang.StringgetName()
void
setName(java.lang.String)
           Returns or sets the name of the specified slicer
intgetNumberOfColumns()
void
           Returns or sets the number of columns in the specified slicer.
WorksheetgetParent()
Returns the Worksheet object that represents the sheet that contains the slicer. Read-only.
intgetPlacement()
void
           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.
doublegetRowHeight()
void
setRowHeight(double)
           Returns or sets the height, in points, of each row in the specified slicer.
intgetRowHeightPixel()
void
           Returns or sets the height, in pixels, of each row in the specified slicer.
SlicerCachegetSlicerCache()
Returns the SlicerCache object associated with the slicer. Read-only.
intgetStyleType()
void
           Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.
java.lang.StringgetTitle()
void
setTitle(java.lang.String)
           Specifies the title of the current Slicer object.
intgetTopPixel()
void
           Returns or sets the vertical offset of slicer shape from its top row, in pixels.
doublegetWidth()
void
setWidth(double)
           Returns or sets the width of the specified slicer, in points.
intgetWidthPixel()
void
           Returns or sets the width of the specified slicer, in pixels.
 
Method Summary
voidaddPivotConnection(PivotTable pivot)
Adds PivotTable connection.
voidrefresh()
Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
voidremovePivotConnection(PivotTable pivot)
Removes PivotTable connection.
 

    • Property Getters/Setters Detail

      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        
        Specifies the title of the current Slicer object.
      • getAlternativeText/setAlternativeText

        public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
        
        Returns or sets the descriptive (alternative) text string of the Slicer object.
      • isPrintable/setPrintable

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

        public boolean isLocked() / public void setLocked(boolean value)
        
        Indicates whether the slicer shape is locked.
      • getPlacement/setPlacement

        public int getPlacement() / public void setPlacement(int 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

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

        public boolean getLockedPosition() / public void setLockedPosition(boolean value)
        
        Indicates whether the specified slicer can be moved or resized by using the user interface.
      • getSlicerCache

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

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

        public int getStyleType() / public void setStyleType(int 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

        public java.lang.String getName() / public void setName(java.lang.String value)
        
        Returns or sets the name of the specified slicer
      • getCaption/setCaption

        public java.lang.String getCaption() / public void setCaption(java.lang.String value)
        
        Returns or sets the caption of the specified slicer.
      • getCaptionVisible/setCaptionVisible

        public boolean getCaptionVisible() / public void setCaptionVisible(boolean value)
        
        Returns or sets whether the header that displays the slicer Caption is visible the default value is true
      • getNumberOfColumns/setNumberOfColumns

        public int getNumberOfColumns() / public void setNumberOfColumns(int value)
        
        Returns or sets the number of columns in the specified slicer.
      • getLeftPixel/setLeftPixel

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

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

        public double getWidth() / public void setWidth(double value)
        
        Returns or sets the width of the specified slicer, in points.
      • getWidthPixel/setWidthPixel

        public int getWidthPixel() / public void setWidthPixel(int value)
        
        Returns or sets the width of the specified slicer, in pixels.
      • getHeight/setHeight

        public double getHeight() / public void setHeight(double value)
        
        Returns or sets the height of the specified slicer, in points.
      • getHeightPixel/setHeightPixel

        public int getHeightPixel() / public void setHeightPixel(int value)
        
        Returns or sets the height of the specified slicer, in pixels.
      • getColumnWidthPixel/setColumnWidthPixel

        public int getColumnWidthPixel() / public void setColumnWidthPixel(int value)
        
        Gets or sets the width in unit of pixels for each column of the slicer. 
      • getColumnWidth/setColumnWidth

        public double getColumnWidth() / public void setColumnWidth(double value)
        
        Returns or sets the width, in points, of each column in the slicer.
      • getRowHeightPixel/setRowHeightPixel

        public int getRowHeightPixel() / public void setRowHeightPixel(int value)
        
        Returns or sets the height, in pixels, of each row in the specified slicer.
      • getRowHeight/setRowHeight

        public double getRowHeight() / public void setRowHeight(double value)
        
        Returns or sets the height, in points, of each row in the specified slicer.

    setTitle

    public voidsetTitle(java.lang.Stringvalue)
    
    Specifies the title of the current Slicer object.

    setAlternativeText

    public voidsetAlternativeText(java.lang.Stringvalue)
    
    Returns or sets the descriptive (alternative) text string of the Slicer object.

    setPrintable

    public voidsetPrintable(booleanvalue)
    
    Indicates whether the slicer object is printable.

    setLocked

    public voidsetLocked(booleanvalue)
    
    Indicates whether the slicer shape is locked.

    setPlacement

    public voidsetPlacement(intvalue)
    
    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.

    setLockedAspectRatio

    public voidsetLockedAspectRatio(booleanvalue)
    
    Indicates whether locking aspect ratio.

    setLockedPosition

    public voidsetLockedPosition(booleanvalue)
    
    Indicates whether the specified slicer can be moved or resized by using the user interface.

    setStyleType

    public voidsetStyleType(intvalue)
    
    Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.

    setName

    public voidsetName(java.lang.Stringvalue)
    
    Returns or sets the name of the specified slicer

    setCaption

    public voidsetCaption(java.lang.Stringvalue)
    
    Returns or sets the caption of the specified slicer.

    setCaptionVisible

    public voidsetCaptionVisible(booleanvalue)
    
    Returns or sets whether the header that displays the slicer Caption is visible the default value is true

    setNumberOfColumns

    public voidsetNumberOfColumns(intvalue)
    
    Returns or sets the number of columns in the specified slicer.

    setLeftPixel

    public voidsetLeftPixel(intvalue)
    
    Returns or sets the horizontal offset of slicer shape from its left column, in pixels.

    setTopPixel

    public voidsetTopPixel(intvalue)
    
    Returns or sets the vertical offset of slicer shape from its top row, in pixels.

    setWidth

    public voidsetWidth(doublevalue)
    
    Returns or sets the width of the specified slicer, in points.

    setWidthPixel

    public voidsetWidthPixel(intvalue)
    
    Returns or sets the width of the specified slicer, in pixels.

    setHeight

    public voidsetHeight(doublevalue)
    
    Returns or sets the height of the specified slicer, in points.

    setHeightPixel

    public voidsetHeightPixel(intvalue)
    
    Returns or sets the height of the specified slicer, in pixels.

    setColumnWidthPixel

    public voidsetColumnWidthPixel(intvalue)
    
    Gets or sets the width in unit of pixels for each column of the slicer. 

    setColumnWidth

    public voidsetColumnWidth(doublevalue)
    
    Returns or sets the width, in points, of each column in the slicer.

    setRowHeightPixel

    public voidsetRowHeightPixel(intvalue)
    
    Returns or sets the height, in pixels, of each row in the specified slicer.

    setRowHeight

    public voidsetRowHeight(doublevalue)
    
    Returns or sets the height, in points, of each row in the specified slicer.
    • Method Detail

      • addPivotConnection

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

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

        public void refresh()
                    throws java.lang.Exception
        Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.