PivotTableCalculateOption
PivotTableCalculateOption class
Rerepsents the options of calculating data of the pivot table.
class PivotTableCalculateOption;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| refreshData | boolean | Indicates whether refreshing data source of the pivottable. |
| refreshCharts | boolean | Indicates whether refreshing charts are based on this pivot table. |
| reserveMissingPivotItemType | ReserveMissingPivotItemType | Represents how to reserve missing pivot items. |
| refreshOption | PivotTableRefreshOption | Gets and set options for refreshing data source to pivot cache. |
Methods
| Method | Description |
|---|---|
| getRefreshData() | @deprecated. Please use the ‘refreshData’ property instead. Indicates whether refreshing data source of the pivottable. |
| setRefreshData(boolean) | @deprecated. Please use the ‘refreshData’ property instead. Indicates whether refreshing data source of the pivottable. |
| getRefreshCharts() | @deprecated. Please use the ‘refreshCharts’ property instead. Indicates whether refreshing charts are based on this pivot table. |
| setRefreshCharts(boolean) | @deprecated. Please use the ‘refreshCharts’ property instead. Indicates whether refreshing charts are based on this pivot table. |
| getReserveMissingPivotItemType() | @deprecated. Please use the ‘reserveMissingPivotItemType’ property instead. Represents how to reserve missing pivot items. |
| setReserveMissingPivotItemType(ReserveMissingPivotItemType) | @deprecated. Please use the ‘reserveMissingPivotItemType’ property instead. Represents how to reserve missing pivot items. |
| getRefreshOption() | @deprecated. Please use the ‘refreshOption’ property instead. Gets and set options for refreshing data source to pivot cache. |
| setRefreshOption(PivotTableRefreshOption) | @deprecated. Please use the ‘refreshOption’ property instead. Gets and set options for refreshing data source to pivot cache. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
refreshData
Indicates whether refreshing data source of the pivottable.
refreshData : boolean;
Remarks
If it is true, refresh pivot cache from data source,then calculate all pivot tables based same pivot cache.
refreshCharts
Indicates whether refreshing charts are based on this pivot table.
refreshCharts : boolean;
reserveMissingPivotItemType
Represents how to reserve missing pivot items.
reserveMissingPivotItemType : ReserveMissingPivotItemType;
Remarks
Only works when PivotTableCalculateOption.RefreshData is true.
refreshOption
Gets and set options for refreshing data source to pivot cache.
refreshOption : PivotTableRefreshOption;
getRefreshData()
@deprecated. Please use the ‘refreshData’ property instead. Indicates whether refreshing data source of the pivottable.
getRefreshData() : boolean;
Remarks
If it is true, refresh pivot cache from data source,then calculate all pivot tables based same pivot cache.
setRefreshData(boolean)
@deprecated. Please use the ‘refreshData’ property instead. Indicates whether refreshing data source of the pivottable.
setRefreshData(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
If it is true, refresh pivot cache from data source,then calculate all pivot tables based same pivot cache.
getRefreshCharts()
@deprecated. Please use the ‘refreshCharts’ property instead. Indicates whether refreshing charts are based on this pivot table.
getRefreshCharts() : boolean;
setRefreshCharts(boolean)
@deprecated. Please use the ‘refreshCharts’ property instead. Indicates whether refreshing charts are based on this pivot table.
setRefreshCharts(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getReserveMissingPivotItemType()
@deprecated. Please use the ‘reserveMissingPivotItemType’ property instead. Represents how to reserve missing pivot items.
getReserveMissingPivotItemType() : ReserveMissingPivotItemType;
Returns
Remarks
Only works when PivotTableCalculateOption.RefreshData is true.
setReserveMissingPivotItemType(ReserveMissingPivotItemType)
@deprecated. Please use the ‘reserveMissingPivotItemType’ property instead. Represents how to reserve missing pivot items.
setReserveMissingPivotItemType(value: ReserveMissingPivotItemType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ReserveMissingPivotItemType | The value to set. |
Remarks
Only works when PivotTableCalculateOption.RefreshData is true.
getRefreshOption()
@deprecated. Please use the ‘refreshOption’ property instead. Gets and set options for refreshing data source to pivot cache.
getRefreshOption() : PivotTableRefreshOption;
Returns
setRefreshOption(PivotTableRefreshOption)
@deprecated. Please use the ‘refreshOption’ property instead. Gets and set options for refreshing data source to pivot cache.
setRefreshOption(value: PivotTableRefreshOption) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PivotTableRefreshOption | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;