PivotTableRefreshOption
PivotTableRefreshOption class
Represents the options of refreshing data source of the pivot table.
class PivotTableRefreshOption;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Represents the options of refreshing data source of the pivot table. |
Properties
| Property | Type | Description |
|---|---|---|
| reserveMissingPivotItemType | ReserveMissingPivotItemType | Represents how to reserve missing pivot items. |
| isKeepOriginalOrder | boolean | Indicates whether to keep pivot items’ original order as old data source. |
Methods
| Method | Description |
|---|---|
| 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. |
| isKeepOriginalOrder() | @deprecated. Please use the ‘isKeepOriginalOrder’ property instead. Indicates whether to keep pivot items’ original order as old data source. |
| setIsKeepOriginalOrder(boolean) | @deprecated. Please use the ‘isKeepOriginalOrder’ property instead. Indicates whether to keep pivot items’ original order as old data source. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Represents the options of refreshing data source of the pivot table.
constructor();
reserveMissingPivotItemType
Represents how to reserve missing pivot items.
reserveMissingPivotItemType : ReserveMissingPivotItemType;
isKeepOriginalOrder
Indicates whether to keep pivot items’ original order as old data source.
isKeepOriginalOrder : boolean;
Remarks
Only applicable for the pivot field which is not sorted. When refreshing such kind of pivot field, Ms Excel keeps the original order of old data source. Default value of this property is true, representing the same behavior with Ms Excel. If user needs the pivot field to be refreshed completely as the data in the new data source, this property should be set as false.
getReserveMissingPivotItemType()
@deprecated. Please use the ‘reserveMissingPivotItemType’ property instead. Represents how to reserve missing pivot items.
getReserveMissingPivotItemType() : ReserveMissingPivotItemType;
Returns
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. |
isKeepOriginalOrder()
@deprecated. Please use the ‘isKeepOriginalOrder’ property instead. Indicates whether to keep pivot items’ original order as old data source.
isKeepOriginalOrder() : boolean;
Remarks
Only applicable for the pivot field which is not sorted. When refreshing such kind of pivot field, Ms Excel keeps the original order of old data source. Default value of this property is true, representing the same behavior with Ms Excel. If user needs the pivot field to be refreshed completely as the data in the new data source, this property should be set as false.
setIsKeepOriginalOrder(boolean)
@deprecated. Please use the ‘isKeepOriginalOrder’ property instead. Indicates whether to keep pivot items’ original order as old data source.
setIsKeepOriginalOrder(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Only applicable for the pivot field which is not sorted. When refreshing such kind of pivot field, Ms Excel keeps the original order of old data source. Default value of this property is true, representing the same behavior with Ms Excel. If user needs the pivot field to be refreshed completely as the data in the new data source, this property should be set as false.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;