ExcelScript.PivotItem interface

Package:

ExcelScript

Represents the Excel PivotItem.

Methods

getId()	ID of the PivotItem.
getIsExpanded()	Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
getName()	Name of the PivotItem.
getVisible()	Specifies if the PivotItem is visible.
setIsExpanded(isExpanded)	Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
setName(name)	Name of the PivotItem.
setVisible(visible)	Specifies if the PivotItem is visible.

Method Details

getId()

ID of the PivotItem.

getId(): string;

Returns

string

getIsExpanded()

Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.

getIsExpanded(): boolean;

Returns

boolean

getName()

Name of the PivotItem.

getName(): string;

Returns

string

getVisible()

Specifies if the PivotItem is visible.

getVisible(): boolean;

Returns

boolean

setIsExpanded(isExpanded)

Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.

setIsExpanded(isExpanded: boolean): void;

Parameters

isExpanded

boolean

Returns

void

setName(name)

Name of the PivotItem.

setName(name: string): void;

Parameters

name

string

Returns

void

setVisible(visible)

Specifies if the PivotItem is visible.

setVisible(visible: boolean): void;

Parameters

visible

boolean

Returns

void