asposecells.api

Classes

Constants

Class Slicer

summary description of Slicer View

Property Getters/Setters Summary
`method`	`getAlternativeText()`
`method`	`setAlternativeText(value)`
	Returns or sets the descriptive (alternative) text string of the Slicer object.
`method`	`getCaption()`
`method`	`setCaption(value)`
	Returns or sets the caption of the specified slicer.
`method`	`getCaptionVisible()`
`method`	`setCaptionVisible(value)`
	Returns or sets whether the header that displays the slicer Caption is visible the default value is true
`method`	`getColumnWidth()`
`method`	`setColumnWidth(value)`
	Returns or sets the width, in points, of each column in the slicer.
`method`	`getColumnWidthPixel()`
`method`	`setColumnWidthPixel(value)`
	Gets or sets the width in unit of pixels for each column of the slicer.
`method`	`getHeight()`
`method`	`setHeight(value)`
	Returns or sets the height of the specified slicer, in points.
`method`	`getHeightPixel()`
`method`	`setHeightPixel(value)`
	Returns or sets the height of the specified slicer, in pixels.
`method`	`isLocked()`
`method`	`setLocked(value)`
	Indicates whether the slicer shape is locked.
`method`	`isPrintable()`
`method`	`setPrintable(value)`
	Indicates whether the slicer object is printable.
`method`	`getLeftPixel()`
`method`	`setLeftPixel(value)`
	Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
`method`	`getLockedAspectRatio()`
`method`	`setLockedAspectRatio(value)`
	Indicates whether locking aspect ratio.
`method`	`getLockedPosition()`
`method`	`setLockedPosition(value)`
	Indicates whether the specified slicer can be moved or resized by using the user interface.
`method`	`getName()`
`method`	`setName(value)`
	Returns or sets the name of the specified slicer
`method`	`getNumberOfColumns()`
`method`	`setNumberOfColumns(value)`
	Returns or sets the number of columns in the specified slicer.
`method`	`getParent()`
	Returns the Worksheet object which contains this slicer. Read-only.
`method`	`getPlacement()`
`method`	`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.
`method`	`getRowHeight()`
`method`	`setRowHeight(value)`
	Returns or sets the height, in points, of each row in the specified slicer.
`method`	`getRowHeightPixel()`
`method`	`setRowHeightPixel(value)`
	Returns or sets the height, in pixels, of each row in the specified slicer.
`method`	`getSlicerCache()`
	Returns the SlicerCache object associated with the slicer. Read-only.
`method`	`getStyleType()`
`method`	`setStyleType(value)`
	Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.
`method`	`getTitle()`
`method`	`setTitle(value)`
	Specifies the title of the current Slicer object.
`method`	`getTopPixel()`
`method`	`setTopPixel(value)`
	Returns or sets the vertical offset of slicer shape from its top row, in pixels.
`method`	`getWidth()`
`method`	`setWidth(value)`
	Returns or sets the width of the specified slicer, in points.
`method`	`getWidthPixel()`
`method`	`setWidthPixel(value)`
	Returns or sets the width of the specified slicer, in pixels.

Method Summary
`method`	`addPivotConnection(pivot)`
`method`	Adds PivotTable connection.
`method`	`refresh()`
`method`	Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
`method`	`removePivotConnection(pivot)`
`method`	Removes PivotTable connection.

- Property Getters/Setters Detail
  - getTitle/setTitle : String
```
String getTitle() / setTitle(value)
```
    Specifies the title of the current Slicer object.
  - getAlternativeText/setAlternativeText : String
```
String getAlternativeText() / setAlternativeText(value)
```
    Returns or sets the descriptive (alternative) text string of the Slicer object.
  - isPrintable/setPrintable : boolean
```
boolean isPrintable() / setPrintable(value)
```
    Indicates whether the slicer object is printable.
  - isLocked/setLocked : boolean
```
boolean isLocked() / setLocked(value)
```
    Indicates whether the slicer shape is locked.
  - getPlacement/setPlacement : int
```
int getPlacement() / 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
```
boolean getLockedAspectRatio() / setLockedAspectRatio(value)
```
    Indicates whether locking aspect ratio.
  - getLockedPosition/setLockedPosition : boolean
```
boolean getLockedPosition() / setLockedPosition(value)
```
    Indicates whether the specified slicer can be moved or resized by using the user interface.
  - getSlicerCache : SlicerCache
```
SlicerCache getSlicerCache()
```
    Returns the SlicerCache object associated with the slicer. Read-only.
  - getParent : Worksheet
```
Worksheet getParent()
```
    Returns the Worksheet object which contains this slicer. Read-only.
  - getStyleType/setStyleType : int
```
int getStyleType() / 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
```
String getName() / setName(value)
```
    Returns or sets the name of the specified slicer
  - getCaption/setCaption : String
```
String getCaption() / setCaption(value)
```
    Returns or sets the caption of the specified slicer.
  - getCaptionVisible/setCaptionVisible : boolean
```
boolean getCaptionVisible() / setCaptionVisible(value)
```
    Returns or sets whether the header that displays the slicer Caption is visible the default value is true
  - getNumberOfColumns/setNumberOfColumns : int
```
int getNumberOfColumns() / setNumberOfColumns(value)
```
    Returns or sets the number of columns in the specified slicer.
  - getLeftPixel/setLeftPixel : int
```
int getLeftPixel() / setLeftPixel(value)
```
    Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
  - getTopPixel/setTopPixel : int
```
int getTopPixel() / setTopPixel(value)
```
    Returns or sets the vertical offset of slicer shape from its top row, in pixels.
  - getWidth/setWidth : float
```
float getWidth() / setWidth(value)
```
    Returns or sets the width of the specified slicer, in points.
  - getWidthPixel/setWidthPixel : int
```
int getWidthPixel() / setWidthPixel(value)
```
    Returns or sets the width of the specified slicer, in pixels.
  - getHeight/setHeight : float
```
float getHeight() / setHeight(value)
```
    Returns or sets the height of the specified slicer, in points.
  - getHeightPixel/setHeightPixel : int
```
int getHeightPixel() / setHeightPixel(value)
```
    Returns or sets the height of the specified slicer, in pixels.
  - getColumnWidthPixel/setColumnWidthPixel : int
```
int getColumnWidthPixel() / setColumnWidthPixel(value)
```
    Gets or sets the width in unit of pixels for each column of the slicer.
  - getColumnWidth/setColumnWidth : float
```
float getColumnWidth() / setColumnWidth(value)
```
    Returns or sets the width, in points, of each column in the slicer.
  - getRowHeightPixel/setRowHeightPixel : int
```
int getRowHeightPixel() / setRowHeightPixel(value)
```
    Returns or sets the height, in pixels, of each row in the specified slicer.
  - getRowHeight/setRowHeight : float
```
float getRowHeight() / setRowHeight(value)
```
    Returns or sets the height, in points, of each row in the specified slicer.
- Method Detail
  - addPivotConnection
```
 addPivotConnection(pivot)
```
    Adds PivotTable connection.
    Parameters:
    pivot: PivotTable - The PivotTable object
  - removePivotConnection
```
 removePivotConnection(pivot)
```
    Removes PivotTable connection.
    Parameters:
    pivot: PivotTable - The PivotTable object
  - refresh
```
 refresh()
```
    Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.

asposecells.api

Classes

Constants

Class Slicer

Property Getters/Setters Detail

getTitle/setTitle : String

getAlternativeText/setAlternativeText : String

isPrintable/setPrintable : boolean

isLocked/setLocked : boolean

getPlacement/setPlacement : int

getLockedAspectRatio/setLockedAspectRatio : boolean

getLockedPosition/setLockedPosition : boolean

getSlicerCache : SlicerCache

getParent : Worksheet

getStyleType/setStyleType : int

getName/setName : String

getCaption/setCaption : String

getCaptionVisible/setCaptionVisible : boolean

getNumberOfColumns/setNumberOfColumns : int

getLeftPixel/setLeftPixel : int

getTopPixel/setTopPixel : int

getWidth/setWidth : float

getWidthPixel/setWidthPixel : int

getHeight/setHeight : float

getHeightPixel/setHeightPixel : int

getColumnWidthPixel/setColumnWidthPixel : int

getColumnWidth/setColumnWidth : float

getRowHeightPixel/setRowHeightPixel : int

getRowHeight/setRowHeight : float

Method Detail

addPivotConnection

removePivotConnection

refresh