Slicer (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.Slicer

public class Slicer
extends java.lang.Object

summary description of Slicer View

Example

 
         Workbook book = new Workbook();
         Worksheet sheet = book.getWorksheets().get(0);
         Cells cells = sheet.getCells();
         cells.get(0, 0).setValue("fruit");
         cells.get(1, 0).setValue("grape");
         cells.get(2, 0).setValue("blueberry");
         cells.get(3, 0).setValue("kiwi");
         cells.get(4, 0).setValue("cherry");
         cells.get(5, 0).setValue("grape");
         cells.get(6, 0).setValue("blueberry");
         cells.get(7, 0).setValue("kiwi");
         cells.get(8, 0).setValue("cherry");
 
         cells.get(0, 1).setValue("year");
         cells.get(1, 1).setValue(2020);
         cells.get(2, 1).setValue(2020);
         cells.get(3, 1).setValue(2020);
         cells.get(4, 1).setValue(2020);
         cells.get(5, 1).setValue(2021);
         cells.get(6, 1).setValue(2021);
         cells.get(7, 1).setValue(2021);
         cells.get(8, 1).setValue(2021);
 
         cells.get(0, 2).setValue("amount");
         cells.get(1, 2).setValue(50);
         cells.get(2, 2).setValue(60);
         cells.get(3, 2).setValue(70);
         cells.get(4, 2).setValue(80);
         cells.get(5, 2).setValue(90);
         cells.get(6, 2).setValue(100);
         cells.get(7, 2).setValue(110);
         cells.get(8, 2).setValue(120);
 
         PivotTableCollection pivots = sheet.getPivotTables();
 
         int pivotIndex = pivots.add("=Sheet1!A1:C9", "A12", "TestPivotTable");
         PivotTable pivot = pivots.get(pivotIndex);
         pivot.addFieldToArea(PivotFieldType.ROW, "fruit");
         pivot.addFieldToArea(PivotFieldType.COLUMN, "year");
         pivot.addFieldToArea(PivotFieldType.DATA, "amount");
 
         pivot.setPivotTableStyleType(PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM_10);
         pivot.refreshData();
         pivot.calculateData();
 
         SlicerCollection slicers = sheet.getSlicers();
         int slicerIndex = slicers.add(pivot, "E12", "fruit");
         Slicer slicer = slicers.get(slicerIndex);
         slicer.setStyleType(SlicerStyleType.SLICER_STYLE_LIGHT_2);
 
         SlicerCacheItemCollection items = slicer.getSlicerCache().getSlicerCacheItems();
         SlicerCacheItem item = items.get(0);
         item.setSelected(false);
         //do your business
         book.save("out.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPivotConnection(PivotTable pivot)` Adds PivotTable connection.
`java.lang.String`	`getAlternativeText()` Returns or sets the descriptive (alternative) text string of the Slicer object.
`java.lang.String`	`getCaption()` Returns or sets the caption of the specified slicer.
`boolean`	`getCaptionVisible()` Returns or sets whether the header that displays the slicer Caption is visible the default value is true
`double`	`getColumnWidth()` Returns or sets the width, in points, of each column in the slicer.
`int`	`getColumnWidthPixel()` Gets the width in unit of聽pixels for聽each column of聽the slicer.聽
`double`	`getHeight()` Returns or sets the height of the specified slicer, in points.
`int`	`getHeightPixel()` Returns or sets the height of the specified slicer, in pixels.
`int`	`getLeftPixel()` Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
`boolean`	`getLockedAspectRatio()` Indicates whether locking aspect ratio.
`boolean`	`getLockedPosition()` Indicates whether the specified slicer can be moved or resized by using the user interface.
`java.lang.String`	`getName()` Returns or sets the name of the specified slicer
`int`	`getNumberOfColumns()` Returns or sets the number of columns in the specified slicer.
`Worksheet`	`getParent()` Returns the `Range.getWorksheet()` object which contains this slicer.
`int`	`getPlacement()` Represents the way the drawing object is attached to the cells below it.
`double`	`getRowHeight()` Returns or sets the height, in points, of each row in the specified slicer.
`int`	`getRowHeightPixel()` Returns or sets the height, in pixels, of each row in the specified slicer.
`SlicerCache`	`getSlicerCache()` Returns the SlicerCache object associated with the slicer.
`int`	`getStyleType()` Specify the type of Built-in slicer style the default type is SlicerStyleLight1
`java.lang.String`	`getTitle()` Specifies the title of the current Slicer object.
`int`	`getTopPixel()` Returns or sets the vertical offset of slicer shape from its top row, in pixels.
`double`	`getWidth()` Returns or sets the width of the specified slicer, in points.
`int`	`getWidthPixel()` Returns or sets the width of the specified slicer, in pixels.
`boolean`	`isLocked()` Indicates whether the slicer shape is locked.
`boolean`	`isPrintable()` Indicates whether the slicer object is printable.
`void`	`refresh()` Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
`void`	`removePivotConnection(PivotTable pivot)` Removes PivotTable connection.
`void`	`setAlternativeText(java.lang.String value)` Returns or sets the descriptive (alternative) text string of the Slicer object.
`void`	`setCaption(java.lang.String value)` Returns or sets the caption of the specified slicer.
`void`	`setCaptionVisible(boolean value)` Returns or sets whether the header that displays the slicer Caption is visible the default value is true
`void`	`setColumnWidth(double value)` Returns or sets the width, in points, of each column in the slicer.
`void`	`setColumnWidthPixel(int value)` Sets the width in unit of聽pixels for聽each column of聽the slicer.聽
`void`	`setHeight(double value)` Returns or sets the height of the specified slicer, in points.
`void`	`setHeightPixel(int value)` Returns or sets the height of the specified slicer, in pixels.
`void`	`setLeftPixel(int value)` Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
`void`	`setLocked(boolean value)` Indicates whether the slicer shape is locked.
`void`	`setLockedAspectRatio(boolean value)` Indicates whether locking aspect ratio.
`void`	`setLockedPosition(boolean value)` Indicates whether the specified slicer can be moved or resized by using the user interface.
`void`	`setName(java.lang.String value)` Returns or sets the name of the specified slicer
`void`	`setNumberOfColumns(int value)` Returns or sets the number of columns in the specified slicer.
`void`	`setPlacement(int value)` Represents the way the drawing object is attached to the cells below it.
`void`	`setPrintable(boolean value)` Indicates whether the slicer object is printable.
`void`	`setRowHeight(double value)` Returns or sets the height, in points, of each row in the specified slicer.
`void`	`setRowHeightPixel(int value)` Returns or sets the height, in pixels, of each row in the specified slicer.
`void`	`setStyleType(int value)` Specify the type of Built-in slicer style the default type is SlicerStyleLight1
`void`	`setTitle(java.lang.String value)` Specifies the title of the current Slicer object.
`void`	`setTopPixel(int value)` Returns or sets the vertical offset of slicer shape from its top row, in pixels.
`void`	`setWidth(double value)` Returns or sets the width of the specified slicer, in points.
`void`	`setWidthPixel(int value)` Returns or sets the width of the specified slicer, in pixels.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addPivotConnection
```
public void addPivotConnection(PivotTable pivot)
```
    Adds PivotTable connection.
    Example
```
 
         slicer.addPivotConnection(pivot);
 
```
    Parameters:
    pivot - The PivotTable object
  - removePivotConnection
```
public void removePivotConnection(PivotTable pivot)
```
    Removes PivotTable connection.
    Example
```
 
         slicer.removePivotConnection(pivot);
 
```
    Parameters:
    pivot - The PivotTable object
  - getTitle
```
public java.lang.String getTitle()
```
    Specifies the title of the current Slicer object.
    Example
```
 
         slicer.setTitle("slicer title");
 
```
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Specifies the title of the current Slicer object.
  - getAlternativeText
```
public java.lang.String getAlternativeText()
```
    Returns or sets the descriptive (alternative) text string of the Slicer object.
    Example
```
 
         slicer.setAlternativeText("AlternativeText test");
 
```
  - setAlternativeText
```
public void setAlternativeText(java.lang.String value)
```
    Returns or sets the descriptive (alternative) text string of the Slicer object.
  - isPrintable
```
public boolean isPrintable()
```
    Indicates whether the slicer object is printable.
    Example
```
 
         slicer.setPrintable(true);
 
```
  - setPrintable
```
public void setPrintable(boolean value)
```
    Indicates whether the slicer object is printable.
  - isLocked
```
public boolean isLocked()
```
    Indicates whether the slicer shape is locked.
    Example
```
 
         slicer.setLocked(false);
 
```
  - setLocked
```
public void setLocked(boolean value)
```
    Indicates whether the slicer shape is locked.
  - getPlacement
```
public int getPlacement()
```
    Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.
    See PlacementType.
    
    Example
```
 
         slicer.setPlacement(PlacementType.FREE_FLOATING);
 
```
  - setPlacement
```
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.
    See PlacementType.
  - getLockedAspectRatio
```
public boolean getLockedAspectRatio()
```
    Indicates whether locking aspect ratio.
    Example
```
 
         slicer.setLockedAspectRatio(true);
 
```
  - setLockedAspectRatio
```
public void setLockedAspectRatio(boolean value)
```
    Indicates whether locking aspect ratio.
  - getLockedPosition
```
public boolean getLockedPosition()
```
    Indicates whether the specified slicer can be moved or resized by using the user interface.
    Example
```
 
         slicer.setLockedPosition(false);
 
```
  - setLockedPosition
```
public void setLockedPosition(boolean value)
```
    Indicates whether the specified slicer can be moved or resized by using the user interface.
  - refresh
```
public void refresh()
```
    Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
    Example
```
 
         slicer.refresh();
 
```
  - getSlicerCache
```
public SlicerCache getSlicerCache()
```
    Returns the SlicerCache object associated with the slicer. Read-only.
    Example
```
 
         SlicerCache slicerCache = slicer.getSlicerCache();
 
```
  - getParent
```
public Worksheet getParent()
```
    Returns the Range.getWorksheet() object which contains this slicer. Read-only.
    Example
```
 
         Worksheet currSheet = slicer.getParent();
 
```
  - getStyleType
```
public int getStyleType()
```
    Specify the type of Built-in slicer style the default type is SlicerStyleLight1
    See SlicerStyleType.
    
    Example
```
 
         slicer.setStyleType(SlicerStyleType.SLICER_STYLE_LIGHT_2);
 
```
  - setStyleType
```
public void setStyleType(int value)
```
    Specify the type of Built-in slicer style the default type is SlicerStyleLight1
    See SlicerStyleType.
  - getName
```
public java.lang.String getName()
```
    Returns or sets the name of the specified slicer
    Example
```
 
         slicer.setName("slicer name");
 
```
  - setName
```
public void setName(java.lang.String value)
```
    Returns or sets the name of the specified slicer
  - getCaption
```
public java.lang.String getCaption()
```
    Returns or sets the caption of the specified slicer.
    Example
```
 
         slicer.setCaption("slicer caption");
 
```
  - setCaption
```
public void setCaption(java.lang.String value)
```
    Returns or sets the caption of the specified slicer.
  - getCaptionVisible
```
public boolean getCaptionVisible()
```
    Returns or sets whether the header that displays the slicer Caption is visible the default value is true
    Example
```
 
         slicer.setCaptionVisible(true);
 
```
  - setCaptionVisible
```
public void setCaptionVisible(boolean value)
```
    Returns or sets whether the header that displays the slicer Caption is visible the default value is true
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    Returns or sets the number of columns in the specified slicer.
    Example
```
 
         slicer.setNumberOfColumns(1);
 
```
  - setNumberOfColumns
```
public void setNumberOfColumns(int value)
```
    Returns or sets the number of columns in the specified slicer.
  - getLeftPixel
```
public int getLeftPixel()
```
    Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
    Example
```
 
         slicer.setLeftPixel(2);
 
```
  - setLeftPixel
```
public void setLeftPixel(int value)
```
    Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
  - getTopPixel
```
public int getTopPixel()
```
    Returns or sets the vertical offset of slicer shape from its top row, in pixels.
    Example
```
 
         slicer.setTopPixel(6);
 
```
  - setTopPixel
```
public void setTopPixel(int value)
```
    Returns or sets the vertical offset of slicer shape from its top row, in pixels.
  - getWidth
```
public double getWidth()
```
    Returns or sets the width of the specified slicer, in points.
    Example
```
 
         slicer.setWidth(100);
 
```
  - setWidth
```
public void setWidth(double value)
```
    Returns or sets the width of the specified slicer, in points.
  - getWidthPixel
```
public int getWidthPixel()
```
    Returns or sets the width of the specified slicer, in pixels.
    Example
```
 
         slicer.setWidthPixel(120);
 
```
  - setWidthPixel
```
public void setWidthPixel(int value)
```
    Returns or sets the width of the specified slicer, in pixels.
  - getHeight
```
public double getHeight()
```
    Returns or sets the height of the specified slicer, in points.
    Example
```
 
         slicer.setHeight(120);
 
```
  - setHeight
```
public void setHeight(double value)
```
    Returns or sets the height of the specified slicer, in points.
  - getHeightPixel
```
public int getHeightPixel()
```
    Returns or sets the height of the specified slicer, in pixels.
    Example
```
 
         slicer.setHeightPixel(150);
 
```
  - setHeightPixel
```
public void setHeightPixel(int value)
```
    Returns or sets the height of the specified slicer, in pixels.
  - getColumnWidthPixel
```
public int getColumnWidthPixel()
```
    Gets the width in unit of聽pixels for聽each column of聽the slicer.聽
    Example
```
 
         slicer.setColumnWidthPixel(120);
 
```
  - setColumnWidthPixel
```
public void setColumnWidthPixel(int value)
```
    Sets the width in unit of聽pixels for聽each column of聽the slicer.聽
  - getColumnWidth
```
public double getColumnWidth()
```
    Returns or sets the width, in points, of each column in the slicer.
    Example
```
 
         slicer.setColumnWidth(80);
 
```
  - setColumnWidth
```
public void setColumnWidth(double value)
```
    Returns or sets the width, in points, of each column in the slicer.
  - getRowHeightPixel
```
public int getRowHeightPixel()
```
    Returns or sets the height, in pixels, of each row in the specified slicer.
    Example
```
 
         slicer.setRowHeightPixel(30);
 
```
  - setRowHeightPixel
```
public void setRowHeightPixel(int value)
```
    Returns or sets the height, in pixels, of each row in the specified slicer.
  - getRowHeight
```
public double getRowHeight()
```
    Returns or sets the height, in points, of each row in the specified slicer.
    Example
```
 
         slicer.setRowHeight(20);
 
```
  - setRowHeight
```
public void setRowHeight(double value)
```
    Returns or sets the height, in points, of each row in the specified slicer.

Class Slicer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addPivotConnection

removePivotConnection

getTitle

setTitle

getAlternativeText

setAlternativeText

isPrintable

setPrintable

isLocked

setLocked

getPlacement

setPlacement

getLockedAspectRatio

setLockedAspectRatio

getLockedPosition

setLockedPosition

refresh

getSlicerCache

getParent

getStyleType

setStyleType

getName

setName

getCaption

setCaption

getCaptionVisible

setCaptionVisible

getNumberOfColumns

setNumberOfColumns

getLeftPixel

setLeftPixel

getTopPixel

setTopPixel

getWidth

setWidth

getWidthPixel

setWidthPixel

getHeight

setHeight

getHeightPixel

setHeightPixel

getColumnWidthPixel

setColumnWidthPixel

getColumnWidth

setColumnWidth

getRowHeightPixel

setRowHeightPixel

getRowHeight

setRowHeight