PivotTableCreateOptions
PivotTableCreateOptions class
Options for creating a new PivotTable.
class PivotTableCreateOptions;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| tableName | string | Gets or sets the name of the new PivotTable report. |
| useSameSource | boolean | Gets or sets a value indicating whether to share the same data source with existing pivot tables. Default value is true. |
| isXlsClassic | boolean | Gets or sets a value indicating whether to create classic Excel 97-2003 style PivotTable. |
Methods
| Method | Description |
|---|---|
| getTableName() | @deprecated. Please use the ’tableName’ property instead. Gets or sets the name of the new PivotTable report. |
| setTableName(string) | @deprecated. Please use the ’tableName’ property instead. Gets or sets the name of the new PivotTable report. |
| getUseSameSource() | @deprecated. Please use the ‘useSameSource’ property instead. Gets or sets a value indicating whether to share the same data source with existing pivot tables. Default value is true. |
| setUseSameSource(boolean) | @deprecated. Please use the ‘useSameSource’ property instead. Gets or sets a value indicating whether to share the same data source with existing pivot tables. Default value is true. |
| isXlsClassic() | @deprecated. Please use the ‘isXlsClassic’ property instead. Gets or sets a value indicating whether to create classic Excel 97-2003 style PivotTable. |
| setIsXlsClassic(boolean) | @deprecated. Please use the ‘isXlsClassic’ property instead. Gets or sets a value indicating whether to create classic Excel 97-2003 style PivotTable. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
tableName
Gets or sets the name of the new PivotTable report.
tableName : string;
Remarks
If not set , an automatic name will be set.
useSameSource
Gets or sets a value indicating whether to share the same data source with existing pivot tables. Default value is true.
useSameSource : boolean;
Remarks
When set to true, multiple pivot tables can reuse one pivot cache to reduce memory consumption.
isXlsClassic
Gets or sets a value indicating whether to create classic Excel 97-2003 style PivotTable.
isXlsClassic : boolean;
Remarks
Classic PivotTable uses legacy layout and formatting from Excel 97-2003. When not explicitly set, the default value is determined by the target workbook file format.
getTableName()
@deprecated. Please use the ’tableName’ property instead. Gets or sets the name of the new PivotTable report.
getTableName() : string;
Remarks
If not set , an automatic name will be set.
setTableName(string)
@deprecated. Please use the ’tableName’ property instead. Gets or sets the name of the new PivotTable report.
setTableName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
If not set , an automatic name will be set.
getUseSameSource()
@deprecated. Please use the ‘useSameSource’ property instead. Gets or sets a value indicating whether to share the same data source with existing pivot tables. Default value is true.
getUseSameSource() : boolean;
Remarks
When set to true, multiple pivot tables can reuse one pivot cache to reduce memory consumption.
setUseSameSource(boolean)
@deprecated. Please use the ‘useSameSource’ property instead. Gets or sets a value indicating whether to share the same data source with existing pivot tables. Default value is true.
setUseSameSource(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
When set to true, multiple pivot tables can reuse one pivot cache to reduce memory consumption.
isXlsClassic()
@deprecated. Please use the ‘isXlsClassic’ property instead. Gets or sets a value indicating whether to create classic Excel 97-2003 style PivotTable.
isXlsClassic() : boolean;
Remarks
Classic PivotTable uses legacy layout and formatting from Excel 97-2003. When not explicitly set, the default value is determined by the target workbook file format.
setIsXlsClassic(boolean)
@deprecated. Please use the ‘isXlsClassic’ property instead. Gets or sets a value indicating whether to create classic Excel 97-2003 style PivotTable.
setIsXlsClassic(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Classic PivotTable uses legacy layout and formatting from Excel 97-2003. When not explicitly set, the default value is determined by the target workbook file format.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
