Class: PivotTableItemSlicer

Spread.Pivot.PivotTableItemSlicer

Table of contents

Constructors

• constructor

Methods

• allowMove
• allowResize
• captionName
• columnCount
• connectPivotTable
• disableResizingAndMoving
• disconnectPivotTable
• dynamicMove
• dynamicSize
• endColumn
• endColumnOffset
• endRow
• endRowOffset
• getAllConnectedPivotTables
• getAllPivotTables
• getConnectedPivotTableNameList
• height
• isConnectedPivotTable
• isLocked
• isSelected
• isVisible
• itemHeight
• multiSelect
• name
• nameInFormula
• position
• refresh
• sheet
• showHeader
• showNoDataItems
• showNoDataItemsInLast
• sortState
• sourceName
• startColumn
• startColumnOffset
• startRow
• startRowOffset
• style
• visuallyNoDataItems
• width
• x
• y

Constructors

constructor

• new PivotTableItemSlicer()

Represents a pivot slicer.

Methods

allowMove

▸ allowMove(value?): any

Gets or sets the allowMove of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the allowMove of the slicer; otherwise, returns the slicer.

---

allowResize

▸ allowResize(value?): any

Gets or sets the allowResize of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the allowResize of the slicer; otherwise, returns the slicer.

---

captionName

▸ captionName(value?): any

Gets or sets the captionName of the slicer.

Parameters

Name	Type
value?	string

Returns

any

If no value is set, returns the captionName of the slicer; otherwise, returns the slicer.

---

columnCount

▸ columnCount(value?): any

Gets or sets the columnCount of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the columnCount of the slicer; otherwise, returns the slicer.

---

connectPivotTable

▸ connectPivotTable(ptName): void

Connect pivot table with the slicer

Parameters

Name	Type	Description
ptName	string	name of pivot table

Returns

void

---

disableResizingAndMoving

▸ disableResizingAndMoving(value?): any

Gets or sets the disableResizingAndMoving of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the disableResizingAndMoving of the slicer; otherwise, returns the slicer.

---

disconnectPivotTable

▸ disconnectPivotTable(ptName): void

Disconnect pivot table with the slicer

Parameters

Name	Type	Description
ptName	string	name of pivot table

Returns

void

---

dynamicMove

▸ dynamicMove(value?): any

Gets or sets the dynamicMove of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the dynamicMove of the slicer; otherwise, returns the slicer.

---

dynamicSize

▸ dynamicSize(value?): any

Gets or sets the dynamicSize of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the dynamicSize of the slicer; otherwise, returns the slicer.

---

endColumn

▸ endColumn(value?): any

Gets or sets the endColumn of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the endColumn of the slicer; otherwise, returns the slicer.

---

endColumnOffset

▸ endColumnOffset(value?): any

Gets or sets the endColumnOffset of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the endColumnOffset of the slicer; otherwise, returns the slicer.

---

endRow

▸ endRow(value?): any

Gets or sets the endRow of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the endRow of the slicer; otherwise, returns the slicer.

---

endRowOffset

▸ endRowOffset(value?): any

Gets or sets the endRowOffset of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the endRowOffset of the slicer; otherwise, returns the slicer.

---

getAllConnectedPivotTables

▸ getAllConnectedPivotTables(): PivotTable[]

get all connected PivotTables

Returns

PivotTable[]

PivotTables connected with the slicer.

---

getAllPivotTables

▸ getAllPivotTables(): PivotTable[]

get all PivotTables whether connected or not.

Returns

PivotTable[]

PivotTables whose source is same as the slicer.

---

getConnectedPivotTableNameList

▸ getConnectedPivotTableNameList(): string[]

get all connected PivotTables' name.

Returns

string[]

name list of PivotTables connected with the slicer.

---

height

▸ height(value?): any

Gets or sets the height of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the height of the slicer; otherwise, returns the slicer.

---

isConnectedPivotTable

▸ isConnectedPivotTable(ptName): boolean

Check whether pivot table connect with the slicer

Parameters

Name	Type	Description
ptName	string	name of pivot table

Returns

boolean

---

isLocked

▸ isLocked(value?): any

Gets or sets the isLocked of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the isLocked of the slicer; otherwise, returns the slicer.

---

isSelected

▸ isSelected(value?): any

Gets or sets the isSelected of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the isSelected of the slicer; otherwise, returns the slicer.

---

isVisible

▸ isVisible(value?): any

Gets or sets the isVisible of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the isVisible of the slicer; otherwise, returns the slicer.

---

itemHeight

▸ itemHeight(value?): any

Gets or sets the itemHeight of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the itemHeight of the slicer; otherwise, returns the slicer.

---

multiSelect

▸ multiSelect(value?): any

Gets or sets the multiSelect of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the multiSelect of the slicer

---

name

▸ name(value?): any

Gets or sets the name of the slicer.

Parameters

Name	Type
value?	string

Returns

any

If no value is set, returns the name of the slicer; otherwise, returns the slicer.

---

nameInFormula

▸ nameInFormula(): string

Gets the nameInFormula of the slicer.

Returns

string

returns the nameInFormula of the slicer.

---

position

▸ position(value?): any

Gets or sets the position of the slicer.

Parameters

Name	Type
value?	Point

Returns

any

If no value is set, returns the position of the slicer; otherwise, returns the slicer.

---

refresh

▸ refresh(): void

Refresh the slicer.

Returns

void

---

sheet

▸ sheet(): Worksheet

Get the worksheet of the slicer.

Returns

Worksheet

returns the worksheet of the slicer.

---

showHeader

▸ showHeader(value?): any

Gets or sets the showHeader of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the showHeader of the slicer; otherwise, returns the slicer.

---

showNoDataItems

▸ showNoDataItems(value?): any

Gets or sets the showNoDataItems of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the showNoDataItems of the slicer; otherwise, returns the slicer.

---

showNoDataItemsInLast

▸ showNoDataItemsInLast(value?): any

Gets or sets the showNoDataItemsInLast of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the showNoDataItemsInLast of the slicer; otherwise, returns the slicer.

---

sortState

▸ sortState(value?): any

Gets or sets the sortState of the slicer.

Parameters

Name	Type
value?	SortState

Returns

any

If no value is set, returns the sortState of the slicer; otherwise, returns the slicer.

---

sourceName

▸ sourceName(): string

Get the sourceName of the slicer.

Returns

string

returns the sourceName of the slicer.

---

startColumn

▸ startColumn(value?): any

Gets or sets the startColumn of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the startColumn of the slicer; otherwise, returns the slicer.

---

startColumnOffset

▸ startColumnOffset(value?): any

Gets or sets the startColumnOffset of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the startColumnOffset of the slicer; otherwise, returns the slicer.

---

startRow

▸ startRow(value?): any

Gets or sets the startRow of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the startRow of the slicer; otherwise, returns the slicer.

---

startRowOffset

▸ startRowOffset(value?): any

Gets or sets the startRowOffset of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the startRowOffset of the slicer; otherwise, returns the slicer.

---

style

▸ style(value?): any

Gets or sets the style of the slicer.

Parameters

Name	Type
value?	SlicerStyle

Returns

any

If no style is set, returns the style of the slicer; otherwise, returns the slicer.

---

visuallyNoDataItems

▸ visuallyNoDataItems(value?): any

Gets or sets the visuallyNoDataItems of the slicer.

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns the visuallyNoDataItems of the slicer; otherwise, returns the slicer.

---

width

▸ width(value?): any

Gets or sets the width of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the width of the slicer; otherwise, returns the slicer.

---

x

▸ x(value?): any

Gets or sets the x of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the x of the slicer; otherwise, returns the slicer.

---

y

▸ y(value?): any

Gets or sets the y of the slicer.

Parameters

Name	Type
value?	number

Returns

any

If no value is set, returns the y of the slicer; otherwise, returns the slicer.