aspose.cells.node 24.12.0 → 25.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -35,6 +35,17 @@ workbook.getWorksheets().get(0).getCells().get("A1").putValue("Hello World");
35
35
  workbook.save("hello-world.xlsx");
36
36
  ```
37
37
 
38
+ #### Use **import** of ES6
39
+ ``` js
40
+ import AsposeCells from "aspose.cells.node";
41
+ const { Workbook, FileFormatType } = AsposeCells;
42
+
43
+ var workbook = new Workbook(FileFormatType.Xlsx);
44
+ workbook.getWorksheets().get(0).getCells().get("A1").putValue("Hello World");
45
+ workbook.save("hello-world.xlsx");
46
+ ```
47
+ **Note**: Please save the above code as **example.mjs** file and run it using **`node example.mjs`**.
48
+
38
49
  ### Convert Excel XLSX File to PDF
39
50
  ``` js
40
51
  const { Workbook } = require("aspose.cells.node");
@@ -74,4 +85,105 @@ worksheet.getPictures().add(5, 5, "image.gif");
74
85
  workbook.save("picture-example.xls", SaveFormat.Excel97To2003);
75
86
  ```
76
87
 
88
+ ### Calculate Custom Functions
89
+ ```js
90
+ const { Workbook, CalculationOptions, AbstractCalculationEngine } = require("aspose.cells.node");
91
+
92
+ class CustomFunction extends AbstractCalculationEngine {
93
+ constructor() {
94
+ super();
95
+ }
96
+
97
+ calculate(data) {
98
+ var functionName = data.getFunctionName();
99
+ if (functionName == "myarrayfunch") {
100
+ var r = new Array();
101
+ r[0] = [1.0, 2.0, 3.0, 4.0, 5.0];
102
+ data.setCalculatedValue(r);
103
+ return;
104
+ }
105
+ else if (functionName == "myarrayfuncv") {
106
+ var r = new Array();
107
+ r[0] = [1.0];
108
+ r[1] = [2.0];
109
+ r[2] = [3.0];
110
+ r[3] = [4.0];
111
+ r[4] = [5.0];
112
+ data.setCalculatedValue(r);
113
+ return;
114
+ }
115
+ else if (functionName == "myrange") {
116
+ data.setCalculatedValue(data.getWorksheet().getCells().createRange("A1", "F1"));
117
+ return;
118
+ }
119
+ else if (functionName == "UDFTest") {
120
+ data.setCalculatedValue(data.getParamValue(0));
121
+ }
122
+ }
123
+ };
124
+
125
+ var wb = new Workbook();
126
+ var sheet = wb.getWorksheets().get(0);
127
+ var cells = sheet.getCells();
128
+
129
+ // Create table with data
130
+ var range = cells.createRange("B3:D5");
131
+ var arr = new Array();
132
+ arr[0] = ["AccountNum", "UDF", "Normal"];
133
+ arr[1] = ["Row01", "", ""];
134
+ arr[2] = ["Row02", "", ""];
135
+
136
+ range.setValue(arr);
137
+ var firstRow = range.getFirstRow();
138
+ var firstColumn = range.getFirstColumn();
139
+ var endRow = firstRow + range.getRowCount();
140
+ var endColumn = firstColumn + range.getColumnCount();
141
+ sheet.getListObjects().add(firstRow, firstColumn, endRow, endColumn, true);
142
+
143
+ // Populate formulas
144
+ cells.get("C5").setFormula("=UDFTest([@AccountNum])");
145
+ cells.get("C4").setFormula("=UDFTest([@AccountNum])"); // UDF formula
146
+
147
+ cells.get("D5").setFormula("=[@AccountNum]");
148
+ cells.get("D4").setFormula("=[@AccountNum]"); // Built-in formula comparison
149
+
150
+ // Calculate workbook
151
+ var opt = new CalculationOptions();
152
+ var customFunction = new CustomFunction();
153
+ opt.setCustomEngine(customFunction);
154
+ wb.calculateFormula(opt);
155
+
156
+ console.log("Row01" == cells.get("C4").getStringValue());
157
+ console.log("Row02" == cells.get("C5").getStringValue());
158
+ console.log("Row01" == cells.get("D4").getStringValue());
159
+ console.log("Row02" == cells.get("D5").getStringValue());
160
+
161
+
162
+ var workbook = new Workbook();
163
+ var worksheet = workbook.getWorksheets().get(0);
164
+
165
+ // Get the cells collection in the sheet
166
+ var cells = worksheet.getCells();
167
+ cells.get("A1").setArrayFormula("=myarrayfunch()", 1, 5);
168
+ cells.get("A2").setArrayFormula("=myarrayfuncv()", 5, 1);
169
+ cells.get("A7").setArrayFormula("=A1:E1*100", 1, 5);
170
+ cells.get("A8").setFormula("=sum(myrange())", 100);
171
+
172
+ var cf = new CustomFunction();
173
+ var cOpt = new CalculationOptions();
174
+ cOpt.setCustomEngine(cf);
175
+ workbook.calculateFormula(cOpt);
176
+ for (var i = 0; i < 5; i++) {
177
+ console.log(i + 1.0 == cells.get(0, i).getDoubleValue());
178
+ }
179
+ for (var i = 1; i < 6; i++) {
180
+ console.log(i == cells.get(i, 0).getDoubleValue());
181
+ }
182
+ for (var i = 0; i < 5; i++) {
183
+ console.log(i * 100 + 100.0 == cells.get(6, i).getDoubleValue());
184
+ }
185
+ console.log(cells.get("A8").getDoubleValue() == 15);
186
+ console.log("done");
187
+ ```
188
+
77
189
  [Product Page](https://products.aspose.com/cells/nodejs-cpp) | [Product Documentation](https://docs.aspose.com/cells/nodejs-cpp/) | [Blog](https://blog.aspose.com/categories/aspose.cells-product-family/) |[API Reference](https://reference.aspose.com/cells/nodejs-cpp) | [Free Support](https://forum.aspose.com/c/cells) | [Temporary License](https://purchase.aspose.com/temporary-license)
package/aspose.cells.js CHANGED
@@ -1,4 +1,4 @@
1
- // Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.
1
+ // Copyright (c) 2001-2025 Aspose Pty Ltd. All Rights Reserved.
2
2
  // Powered by Aspose.Cells.
3
3
  'use strict'
4
4
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "aspose.cells.node",
3
- "version": "24.12.0",
3
+ "version": "25.1.0",
4
4
  "description": "Aspose.Cells for Node.js via C++ is a high-performance and powerful library for manipulating and converting Excel (XLS, XLSX, XLSB), ODS, CSV, and HTML files, offering a comprehensive set of features for creating, editing, converting, and rendering spreadsheets within Node.js applications.",
5
5
  "main": "aspose.cells.js",
6
6
  "types": "types.d.ts",
@@ -35,9 +35,9 @@
35
35
  "license": "Commercial",
36
36
  "homepage": "https://www.aspose.com",
37
37
  "optionalDependencies": {
38
- "aspose.cells.node.win32.x64": "~24.12.0",
39
- "aspose.cells.node.linux.x64": "~24.12.0",
40
- "aspose.cells.node.darwin.x64": "~24.12.0",
41
- "aspose.cells.node.darwin.arm64": "~24.12.0"
38
+ "aspose.cells.node.win32.x64": "~25.1.0",
39
+ "aspose.cells.node.linux.x64": "~25.1.0",
40
+ "aspose.cells.node.darwin.x64": "~25.1.0",
41
+ "aspose.cells.node.darwin.arm64": "~25.1.0"
42
42
  }
43
43
  }
package/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.
1
+ // Copyright (c) 2001-2025 Aspose Pty Ltd. All Rights Reserved.
2
2
  // Powered by Aspose.Cells.
3
3
  /**
4
4
  * Monitor for interruption requests in all time-consuming operations.
@@ -104,9 +104,18 @@ export class AutoFilter {
104
104
  */
105
105
  setRange(row: number, startColumn: number, endColumn: number) : void;
106
106
  /**
107
- * Gets the <see cref="CellArea"/> where the specified AutoFilter applies to.
107
+ * Gets the <see cref="CellArea"/> where the this AutoFilter applies to.
108
+ * @returns
109
+ * the area this filter applies to
108
110
  */
109
111
  getCellArea() : CellArea;
112
+ /**
113
+ * Gets the <see cref="CellArea"/> where the specified AutoFilter applies to.
114
+ * @param refreshAppliedRange - Whether refresh the applied range. /// For the applied range of auto filter, the last row may change when cells data changes. /// If this flag is true, then the last row of the range will be re-calculated according to current cells data.
115
+ * @returns
116
+ * the area this filter applies to
117
+ */
118
+ getCellArea(refreshAppliedRange: boolean) : CellArea;
110
119
  /**
111
120
  * Adds a filter for a filter column.
112
121
  * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0).
@@ -329,18 +338,14 @@ export enum AutoFitWrappedTextType {
329
338
  * For example, while deleting/inserting range of cells,
330
339
  * formulas of other cells may be changed because of the shift of references.
331
340
  */
332
- export class AbstractFormulaChangeMonitor {
341
+ export abstract class AbstractFormulaChangeMonitor {
333
342
  /**
334
343
  * The event that will be triggered when the formula in a cell is changed.
335
344
  * @param sheetIndex - The sheet index of the changed cell
336
345
  * @param rowIndex - The row index of the changed cell
337
346
  * @param columnIndex - The column index of the changed cell
338
347
  */
339
- onCellFormulaChanged(sheetIndex: number, rowIndex: number, columnIndex: number) : void;
340
- /**
341
- * Checks whether the implementation object is null.
342
- */
343
- isNull() : boolean;
348
+ abstract onCellFormulaChanged(sheetIndex: number, rowIndex: number, columnIndex: number) : void;
344
349
  }
345
350
 
346
351
  /**
@@ -2138,6 +2143,125 @@ export class HtmlTableLoadOptionCollection {
2138
2143
  isNull() : boolean;
2139
2144
  }
2140
2145
 
2146
+ /**
2147
+ * Represents a list of pivot area.
2148
+ */
2149
+ export class PivotAreaCollection {
2150
+ /**
2151
+ * Gets a <see cref="PivotArea"/> object;
2152
+ */
2153
+ get(index: number) : PivotArea;
2154
+ /**
2155
+ * Adds pivot area.
2156
+ * @param pivotArea - The pivot area.
2157
+ */
2158
+ add(pivotArea: PivotArea) : number;
2159
+ /**
2160
+ * Adds an area based on pivot table view.
2161
+ * @param cellArea - The area based on pivot table view.
2162
+ */
2163
+ add(cellArea: CellArea) : void;
2164
+ /**
2165
+ * Remove one pivot conditional formatted area setting.
2166
+ * @param index - The index
2167
+ */
2168
+ removeAt(index: number) : void;
2169
+ /**
2170
+ * Gets the number of elements contained in.
2171
+ */
2172
+ getCount() : number;
2173
+ /**
2174
+ * Checks whether the implementation object is null.
2175
+ */
2176
+ isNull() : boolean;
2177
+ }
2178
+
2179
+ /**
2180
+ * Represents a PivotTable Format Condition in PivotFormatCondition Collection.
2181
+ */
2182
+ export class PivotConditionalFormat {
2183
+ /**
2184
+ * Gets all pivot areas.
2185
+ */
2186
+ getPivotAreas() : PivotAreaCollection;
2187
+ /**
2188
+ * Get conditions for the pivot table conditional format .
2189
+ */
2190
+ getFormatConditions() : FormatConditionCollection;
2191
+ /**
2192
+ * Get and set scope type for the pivot table conditional format .
2193
+ */
2194
+ getScopeType() : PivotConditionFormatScopeType;
2195
+ /**
2196
+ * Get and set scope type for the pivot table conditional format .
2197
+ * @param value - The value to set.
2198
+ */
2199
+ setScopeType(value: PivotConditionFormatScopeType) : void;
2200
+ /**
2201
+ * Get and set rule type for the pivot table condition format .
2202
+ */
2203
+ getRuleType() : PivotConditionFormatRuleType;
2204
+ /**
2205
+ * Get and set rule type for the pivot table condition format .
2206
+ * @param value - The value to set.
2207
+ */
2208
+ setRuleType(value: PivotConditionFormatRuleType) : void;
2209
+ /**
2210
+ * Gets all cell areas where this conditional format applies to.
2211
+ */
2212
+ getCellAreas() : CellArea[];
2213
+ /**
2214
+ * Adds an area based on pivot table view.
2215
+ * @param ca - The cell area.
2216
+ */
2217
+ addCellArea(ca: CellArea) : void;
2218
+ /**
2219
+ * Adds an area of pivot field.
2220
+ * @param axisType - The region type.
2221
+ * @param fieldName - The name of pivot field.
2222
+ */
2223
+ addFieldArea(axisType: PivotFieldType, fieldName: string) : void;
2224
+ /**
2225
+ * Adds an area of pivot field.
2226
+ * @param axisType - The region type.
2227
+ * @param field - The pivot field.
2228
+ */
2229
+ addFieldArea(axisType: PivotFieldType, field: PivotField) : void;
2230
+ /**
2231
+ * Checks whether the implementation object is null.
2232
+ */
2233
+ isNull() : boolean;
2234
+ }
2235
+
2236
+ /**
2237
+ * Represents all conditional formats of pivot table.
2238
+ */
2239
+ export class PivotConditionalFormatCollection {
2240
+ /**
2241
+ * Gets the pivot FormatCondition object at the specific index.
2242
+ * @returns
2243
+ * pivot FormatCondition object.
2244
+ */
2245
+ get(index: number) : PivotConditionalFormat;
2246
+ /**
2247
+ * Adds a pivot FormatCondition to the collection.
2248
+ * @returns
2249
+ * pivot FormatCondition object index.
2250
+ *
2251
+ * @remarks
2252
+ * not supported
2253
+ */
2254
+ add() : number;
2255
+ /**
2256
+ * Gets the number of elements contained in.
2257
+ */
2258
+ getCount() : number;
2259
+ /**
2260
+ * Checks whether the implementation object is null.
2261
+ */
2262
+ isNull() : boolean;
2263
+ }
2264
+
2141
2265
  /**
2142
2266
  * Represents the type of power query formula.
2143
2267
  */
@@ -8678,15 +8802,6 @@ export class Cells {
8678
8802
  * Clears all data of the worksheet.
8679
8803
  */
8680
8804
  clear() : void;
8681
- /**
8682
- * Imports an array of data into a worksheet.
8683
- * @param objArray - Data array.
8684
- * @param firstRow - The row number of the first cell to import in.
8685
- * @param firstColumn - The column number of the first cell to import in.
8686
- * @param isVertical - Specifies to import data vertically or horizontally.
8687
- * @param skip - Skipped number of rows or columns.
8688
- */
8689
- importObjectArray(objArray: object[], firstRow: number, firstColumn: number, isVertical: boolean, skip: number) : void;
8690
8805
  /**
8691
8806
  * Imports an array of formula into a worksheet.
8692
8807
  * @param stringArray - Formula array.
@@ -12664,6 +12779,13 @@ export class Workbook {
12664
12779
  * Returns a style object.
12665
12780
  */
12666
12781
  createStyle() : Style;
12782
+ /**
12783
+ * Creates a new style.
12784
+ * @param cloneDefaultStyle - Incidates whether clones the default style
12785
+ * @returns
12786
+ * Returns a style object.
12787
+ */
12788
+ createStyle(cloneDefaultStyle: boolean) : Style;
12667
12789
  /**
12668
12790
  * Creates built-in style by given type.
12669
12791
  * @param type - The builtin style stype.
@@ -16657,7 +16779,7 @@ export class PivotTable {
16657
16779
  */
16658
16780
  getBaseFields() : PivotFieldCollection;
16659
16781
  /**
16660
- * Returns a list of pivot filters.
16782
+ * Returns all filters of pivot fields in the pivot table.
16661
16783
  */
16662
16784
  getPivotFilters() : PivotFilterCollection;
16663
16785
  /**
@@ -16685,15 +16807,6 @@ export class PivotTable {
16685
16807
  * includes page fields. Read-only.
16686
16808
  */
16687
16809
  getTableRange2() : CellArea;
16688
- /**
16689
- * Indicates whether the PivotTable report shows grand totals for columns.
16690
- */
16691
- getColumnGrand() : boolean;
16692
- /**
16693
- * Indicates whether the PivotTable report shows grand totals for columns.
16694
- * @param value - The value to set.
16695
- */
16696
- setColumnGrand(value: boolean) : void;
16697
16810
  /**
16698
16811
  * Indicates whether the PivotTable report displays classic pivottable layout.
16699
16812
  * (enables dragging fields in the grid)
@@ -16706,12 +16819,71 @@ export class PivotTable {
16706
16819
  */
16707
16820
  setIsGridDropZones(value: boolean) : void;
16708
16821
  /**
16709
- * Indicates whether the PivotTable report shows grand totals for rows.
16822
+ * Indicates whether to show grand totals for columns of this pivot table.
16823
+ */
16824
+ getShowColumnGrandTotals() : boolean;
16825
+ /**
16826
+ * Indicates whether to show grand totals for columns of this pivot table.
16827
+ * @param value - The value to set.
16828
+ */
16829
+ setShowColumnGrandTotals(value: boolean) : void;
16830
+ /**
16831
+ * Indicates whether to show grand totals for rows of the pivot table.
16832
+ */
16833
+ getShowRowGrandTotals() : boolean;
16834
+ /**
16835
+ * Indicates whether to show grand totals for rows of the pivot table.
16836
+ * @param value - The value to set.
16837
+ */
16838
+ setShowRowGrandTotals(value: boolean) : void;
16839
+ /**
16840
+ * Indicates whether the PivotTable report shows grand totals for columns.
16841
+ *
16842
+ * @remarks
16843
+ * NOTE: This property is now obsolete. Instead,
16844
+ * please use PivotTable.ShowColumnGrandTotals method.
16845
+ * This method will be removed 12 months later since December 2024.
16846
+ * Aspose apologizes for any inconvenience you may have experienced.
16847
+ * @deprecated
16848
+ * Use PivotTable.ShowColumnGrandTotals property instead.
16849
+ */
16850
+ getColumnGrand() : boolean;
16851
+ /**
16852
+ * Indicates whether the PivotTable report shows grand totals for columns.
16853
+ * @param value - The value to set.
16854
+ *
16855
+ * @remarks
16856
+ * NOTE: This property is now obsolete. Instead,
16857
+ * please use PivotTable.ShowColumnGrandTotals method.
16858
+ * This method will be removed 12 months later since December 2024.
16859
+ * Aspose apologizes for any inconvenience you may have experienced.
16860
+ * @deprecated
16861
+ * Use PivotTable.ShowColumnGrandTotals property instead.
16862
+ */
16863
+ setColumnGrand(value: boolean) : void;
16864
+ /**
16865
+ * Indicates whether to show grand totals for rows of this pivot table.
16866
+ *
16867
+ * @remarks
16868
+ * NOTE: This property is now obsolete. Instead,
16869
+ * please use PivotTable.ShowRowGrandTotals method.
16870
+ * This method will be removed 12 months later since December 2024.
16871
+ * Aspose apologizes for any inconvenience you may have experienced.
16872
+ * @deprecated
16873
+ * Use PivotTable.ShowRowGrandTotals property instead.
16710
16874
  */
16711
16875
  getRowGrand() : boolean;
16712
16876
  /**
16713
- * Indicates whether the PivotTable report shows grand totals for rows.
16877
+ * Indicates whether to show grand totals for rows of this pivot table.
16714
16878
  * @param value - The value to set.
16879
+ *
16880
+ * @remarks
16881
+ * NOTE: This property is now obsolete. Instead,
16882
+ * please use PivotTable.ShowRowGrandTotals method.
16883
+ * This method will be removed 12 months later since December 2024.
16884
+ * Aspose apologizes for any inconvenience you may have experienced.
16885
+ * @deprecated
16886
+ * Use PivotTable.ShowRowGrandTotals property instead.
16715
16887
  */
16716
16888
  setRowGrand(value: boolean) : void;
16717
16889
  /**
@@ -16851,11 +17023,11 @@ export class PivotTable {
16851
17023
  */
16852
17024
  setEnableFieldDialog(value: boolean) : void;
16853
17025
  /**
16854
- * Gets whether enable the field list for the PivotTable.
17026
+ * Indicates whether the field list for the PivotTable is available on the view of Excel.
16855
17027
  */
16856
17028
  getEnableFieldList() : boolean;
16857
17029
  /**
16858
- * Gets whether enable the field list for the PivotTable.
17030
+ * Indicates whether the field list for the PivotTable is available on the view of Excel.
16859
17031
  * @param value - The value to set.
16860
17032
  */
16861
17033
  setEnableFieldList(value: boolean) : void;
@@ -16882,12 +17054,12 @@ export class PivotTable {
16882
17054
  */
16883
17055
  setSubtotalHiddenPageItems(value: boolean) : void;
16884
17056
  /**
16885
- * Returns the text string label that is displayed in the grand total column or row heading.
17057
+ * Returns the label that is displayed in the grand total column or row heading.
16886
17058
  * The default value is the string "Grand Total".
16887
17059
  */
16888
17060
  getGrandTotalName() : string;
16889
17061
  /**
16890
- * Returns the text string label that is displayed in the grand total column or row heading.
17062
+ * Returns the label that is displayed in the grand total column or row heading.
16891
17063
  * The default value is the string "Grand Total".
16892
17064
  * @param value - The value to set.
16893
17065
  */
@@ -16903,13 +17075,38 @@ export class PivotTable {
16903
17075
  setManualUpdate(value: boolean) : void;
16904
17076
  /**
16905
17077
  * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
17078
+ *
17079
+ * @remarks
17080
+ * NOTE: This property is now obsolete. Instead,
17081
+ * please use PivotTable.AllowMultipleFiltersPerField property.
17082
+ * This method will be removed 12 months later since December 2024.
17083
+ * Aspose apologizes for any inconvenience you may have experienced.
17084
+ * @deprecated
17085
+ * Use PivotTable.AllowMultipleFiltersPerField property instead.
16906
17086
  */
16907
17087
  isMultipleFieldFilters() : boolean;
16908
17088
  /**
16909
17089
  * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
16910
17090
  * @param value - The value to set.
17091
+ *
17092
+ * @remarks
17093
+ * NOTE: This property is now obsolete. Instead,
17094
+ * please use PivotTable.AllowMultipleFiltersPerField property.
17095
+ * This method will be removed 12 months later since December 2024.
17096
+ * Aspose apologizes for any inconvenience you may have experienced.
17097
+ * @deprecated
17098
+ * Use PivotTable.AllowMultipleFiltersPerField property instead.
16911
17099
  */
16912
17100
  setIsMultipleFieldFilters(value: boolean) : void;
17101
+ /**
17102
+ * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
17103
+ */
17104
+ getAllowMultipleFiltersPerField() : boolean;
17105
+ /**
17106
+ * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
17107
+ * @param value - The value to set.
17108
+ */
17109
+ setAllowMultipleFiltersPerField(value: boolean) : void;
16913
17110
  /**
16914
17111
  * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
16915
17112
  */
@@ -16958,20 +17155,20 @@ export class PivotTable {
16958
17155
  */
16959
17156
  setShowValuesRow(value: boolean) : void;
16960
17157
  /**
16961
- * Specifies a boolean value that indicates whether to include empty columns in the table
17158
+ * Indicates whether to include empty columns in the table
16962
17159
  */
16963
17160
  getShowEmptyCol() : boolean;
16964
17161
  /**
16965
- * Specifies a boolean value that indicates whether to include empty columns in the table
17162
+ * Indicates whether to include empty columns in the table
16966
17163
  * @param value - The value to set.
16967
17164
  */
16968
17165
  setShowEmptyCol(value: boolean) : void;
16969
17166
  /**
16970
- * Specifies a boolean value that indicates whether to include empty rows in the table.
17167
+ * Indicates whether to include empty rows in the table.
16971
17168
  */
16972
17169
  getShowEmptyRow() : boolean;
16973
17170
  /**
16974
- * Specifies a boolean value that indicates whether to include empty rows in the table.
17171
+ * Indicates whether to include empty rows in the table.
16975
17172
  * @param value - The value to set.
16976
17173
  */
16977
17174
  setShowEmptyRow(value: boolean) : void;
@@ -17071,8 +17268,20 @@ export class PivotTable {
17071
17268
  setCustomListSort(value: boolean) : void;
17072
17269
  /**
17073
17270
  * Gets the Format Conditions of the pivot table.
17271
+ *
17272
+ * @remarks
17273
+ * NOTE: This property is now obsolete. Instead,
17274
+ * please use PivotTable.ConditionalFormats property.
17275
+ * This method will be removed 12 months later since December 2024.
17276
+ * Aspose apologizes for any inconvenience you may have experienced.
17277
+ * @deprecated
17278
+ * Use PivotTable.ConditionalFormats property instead.
17074
17279
  */
17075
17280
  getPivotFormatConditions() : PivotFormatConditionCollection;
17281
+ /**
17282
+ * Gets the conditional formats of the pivot table.
17283
+ */
17284
+ getConditionalFormats() : PivotConditionalFormatCollection;
17076
17285
  /**
17077
17286
  * Gets and sets the order in which page fields are added to the PivotTable report's layout.
17078
17287
  */
@@ -17120,11 +17329,25 @@ export class PivotTable {
17120
17329
  setRefreshDataOnOpeningFile(value: boolean) : void;
17121
17330
  /**
17122
17331
  * Indicates whether Refreshing Data or not.
17332
+ *
17333
+ * @remarks
17334
+ * NOTE: This method is now obsolete. Instead,
17335
+ * This method will be removed 12 months later since December 2024.
17336
+ * Aspose apologizes for any inconvenience you may have experienced.
17337
+ * @deprecated
17338
+ * Simply remove this calling.
17123
17339
  */
17124
17340
  getRefreshDataFlag() : boolean;
17125
17341
  /**
17126
17342
  * Indicates whether Refreshing Data or not.
17127
17343
  * @param value - The value to set.
17344
+ *
17345
+ * @remarks
17346
+ * NOTE: This method is now obsolete. Instead,
17347
+ * This method will be removed 12 months later since December 2024.
17348
+ * Aspose apologizes for any inconvenience you may have experienced.
17349
+ * @deprecated
17350
+ * Simply remove this calling.
17128
17351
  */
17129
17352
  setRefreshDataFlag(value: boolean) : void;
17130
17353
  /**
@@ -17136,11 +17359,11 @@ export class PivotTable {
17136
17359
  *
17137
17360
  * @remarks
17138
17361
  * NOTE: This property is now obsolete. Instead,
17139
- * please use pivotTable.GetSourceDataConnections() method.
17362
+ * please use PivotTable.GetSourceDataConnections() method.
17140
17363
  * This method will be removed 12 months later since October 2024.
17141
17364
  * Aspose apologizes for any inconvenience you may have experienced.
17142
17365
  * @deprecated
17143
- * Use pivotTable.GetSourceDataConnections() method instead.
17366
+ * Use PivotTable.GetSourceDataConnections() method instead.
17144
17367
  */
17145
17368
  getExternalConnectionDataSource() : ExternalConnection;
17146
17369
  /**
@@ -17357,13 +17580,40 @@ export class PivotTable {
17357
17580
  * Moves the PivotTable to a different location in the worksheet.
17358
17581
  * @param row - row index.
17359
17582
  * @param column - column index.
17583
+ *
17584
+ * @remarks
17585
+ * NOTE: This property is now obsolete. Instead,
17586
+ * please use PivotTable.MoveTo() method.
17587
+ * This method will be removed 12 months later since December 2024.
17588
+ * Aspose apologizes for any inconvenience you may have experienced.
17589
+ * @deprecated
17590
+ * Use PivotTable.MoveTo() method instead.
17360
17591
  */
17361
17592
  move(row: number, column: number) : void;
17362
17593
  /**
17363
17594
  * Moves the PivotTable to a different location in the worksheet.
17364
17595
  * @param destCellName - the dest cell name.
17596
+ *
17597
+ * @remarks
17598
+ * NOTE: This property is now obsolete. Instead,
17599
+ * please use PivotTable.MoveTo() method.
17600
+ * This method will be removed 12 months later since December 2024.
17601
+ * Aspose apologizes for any inconvenience you may have experienced.
17602
+ * @deprecated
17603
+ * Use PivotTable.MoveTo() method instead.
17365
17604
  */
17366
17605
  move(destCellName: string) : void;
17606
+ /**
17607
+ * Moves the PivotTable to a different location in the worksheet.
17608
+ * @param row - row index.
17609
+ * @param column - column index.
17610
+ */
17611
+ moveTo(row: number, column: number) : void;
17612
+ /**
17613
+ * Moves the PivotTable to a different location in the worksheet.
17614
+ * @param destCellName - the dest cell name.
17615
+ */
17616
+ moveTo(destCellName: string) : void;
17367
17617
  /**
17368
17618
  * Gets the external connection data sources.
17369
17619
  */
@@ -17374,7 +17624,6 @@ export class PivotTable {
17374
17624
  getNamesOfSourceDataConnections() : string[];
17375
17625
  /**
17376
17626
  * Set pivottable's source data.
17377
- * Sheet1!$A$1:$C$3
17378
17627
  */
17379
17628
  changeDataSource(source: string[]) : void;
17380
17629
  /**
@@ -17435,10 +17684,16 @@ export class PivotTable {
17435
17684
  formatRow(row: number, style: Style) : void;
17436
17685
  /**
17437
17686
  * Formats selected area of the PivotTable.
17438
- * @param pivotArea -
17439
- * @param style -
17687
+ * @param pivotArea - The selected pivot view area.
17688
+ * @param style - The formatted setting.
17440
17689
  */
17441
17690
  format(pivotArea: PivotArea, style: Style) : void;
17691
+ /**
17692
+ * Formats selected area of the PivotTable.
17693
+ * @param ca - The range of the cells.
17694
+ * @param style - The style
17695
+ */
17696
+ format(ca: CellArea, style: Style) : void;
17442
17697
  /**
17443
17698
  * Format the cell in the pivottable area
17444
17699
  * @param row - Row Index of the cell
@@ -17446,6 +17701,11 @@ export class PivotTable {
17446
17701
  * @param style - Style which is to format the cell
17447
17702
  */
17448
17703
  format(row: number, column: number, style: Style) : void;
17704
+ /**
17705
+ * Select an area of pivot table view.
17706
+ * @param ca - The cell area.
17707
+ */
17708
+ selectArea(ca: CellArea) : PivotAreaCollection;
17449
17709
  /**
17450
17710
  * Show the detail of one item in the data region to a new Table.
17451
17711
  * @param rowOffset - Offset to the first data row in the data region.
@@ -17455,6 +17715,10 @@ export class PivotTable {
17455
17715
  * @param destColumn - The target column.
17456
17716
  */
17457
17717
  showDetail(rowOffset: number, columnOffset: number, newSheet: boolean, destRow: number, destColumn: number) : void;
17718
+ /**
17719
+ * Gets horizontal page breaks of this pivot table.
17720
+ */
17721
+ getHorizontalPageBreaks() : number[];
17458
17722
  /**
17459
17723
  * Layouts the PivotTable in compact form.
17460
17724
  */
@@ -26523,10 +26787,6 @@ export enum WarningType {
26523
26787
  * Specifies write protection settings for a workbook.
26524
26788
  */
26525
26789
  export class WriteProtection {
26526
- /**
26527
- * Default Constructor.
26528
- */
26529
- constructor();
26530
26790
  /**
26531
26791
  * Gets and sets the author.
26532
26792
  */
@@ -29860,14 +30120,22 @@ export enum PivotFilterType {
29860
30120
 
29861
30121
  /**
29862
30122
  * Represents a PivotTable Format Condition in PivotFormatCondition Collection.
30123
+ *
30124
+ * @remarks
30125
+ * NOTE: This class is now obsolete. Instead,
30126
+ * please use PivotConditional class.
30127
+ * This method will be removed 12 months later since December 2024.
30128
+ * Aspose apologizes for any inconvenience you may have experienced.
30129
+ * @deprecated
30130
+ * Use PivotConditional class instead.
29863
30131
  */
29864
30132
  export class PivotFormatCondition {
29865
30133
  /**
29866
- * Get and set scope type for the pivot table condition format .
30134
+ * Get and set scope type for the pivot table conditional format .
29867
30135
  */
29868
30136
  getScopeType() : PivotConditionFormatScopeType;
29869
30137
  /**
29870
- * Get and set scope type for the pivot table condition format .
30138
+ * Get and set scope type for the pivot table conditional format .
29871
30139
  * @param value - The value to set.
29872
30140
  */
29873
30141
  setScopeType(value: PivotConditionFormatScopeType) : void;
@@ -29881,7 +30149,7 @@ export class PivotFormatCondition {
29881
30149
  */
29882
30150
  setRuleType(value: PivotConditionFormatRuleType) : void;
29883
30151
  /**
29884
- * Get formatconditions for the pivot table condition format .
30152
+ * Get conditions for the pivot table conditional format .
29885
30153
  */
29886
30154
  getFormatConditions() : FormatConditionCollection;
29887
30155
  /**
@@ -29926,6 +30194,14 @@ export class PivotFormatCondition {
29926
30194
 
29927
30195
  /**
29928
30196
  * Represents PivotTable Format Conditions.
30197
+ *
30198
+ * @remarks
30199
+ * NOTE: This method is now obsolete. Instead,
30200
+ * please use PivotConditionalFormatCollection class.
30201
+ * This method will be removed 12 months later since December 2024.
30202
+ * Aspose apologizes for any inconvenience you may have experienced.
30203
+ * @deprecated
30204
+ * Use PivotConditionalFormatCollection class instead.
29929
30205
  */
29930
30206
  export class PivotFormatConditionCollection {
29931
30207
  /**
@@ -29934,6 +30210,10 @@ export class PivotFormatConditionCollection {
29934
30210
  * pivot FormatCondition object.
29935
30211
  */
29936
30212
  get(index: number) : PivotFormatCondition;
30213
+ /**
30214
+ * Gets the count of conditional formats.
30215
+ */
30216
+ getCount() : number;
29937
30217
  /**
29938
30218
  * Adds a pivot FormatCondition to the collection.
29939
30219
  * @returns
@@ -29944,9 +30224,9 @@ export class PivotFormatConditionCollection {
29944
30224
  */
29945
30225
  add() : number;
29946
30226
  /**
29947
- * Gets the number of elements contained in.
30227
+ * Remove a conditional formats.
29948
30228
  */
29949
- getCount() : number;
30229
+ removeAt(index: number) : void;
29950
30230
  /**
29951
30231
  * Checks whether the implementation object is null.
29952
30232
  */
@@ -32077,6 +32357,22 @@ export class PivotArea {
32077
32357
  * @param selectionType - Specifies what can be selected in a PivotTable during a structured selection.
32078
32358
  */
32079
32359
  select(axisType: PivotFieldType, fieldPosition: number, selectionType: PivotTableSelectionType) : void;
32360
+ /**
32361
+ * Select a field in the region as an area.
32362
+ * @param axisType - The region type.
32363
+ * @param fieldName - The name of pivot field.
32364
+ */
32365
+ selectField(axisType: PivotFieldType, fieldName: string) : void;
32366
+ /**
32367
+ * Select a field in the region as an area.
32368
+ * @param axisType - The region type.
32369
+ * @param field - The pivot field.
32370
+ */
32371
+ selectField(axisType: PivotFieldType, field: PivotField) : void;
32372
+ /**
32373
+ * Gets cell areas of this pivot area.
32374
+ */
32375
+ getCellAreas() : CellArea[];
32080
32376
  /**
32081
32377
  * Checks whether the implementation object is null.
32082
32378
  */
@@ -34162,6 +34458,17 @@ export class HtmlSaveOptions extends SaveOptions {
34162
34458
  * @param value - The value to set.
34163
34459
  */
34164
34460
  setDisableCss(value: boolean) : void;
34461
+ /**
34462
+ * Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved.
34463
+ * The default value is false.
34464
+ */
34465
+ getEnableCssCustomProperties() : boolean;
34466
+ /**
34467
+ * Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved.
34468
+ * The default value is false.
34469
+ * @param value - The value to set.
34470
+ */
34471
+ setEnableCssCustomProperties(value: boolean) : void;
34165
34472
  /**
34166
34473
  * Checks whether the implementation object is null.
34167
34474
  */
@@ -50053,25 +50360,6 @@ export class Protection {
50053
50360
  * @param value - The value to set.
50054
50361
  */
50055
50362
  setAllowEditingScenario(value: boolean) : void;
50056
- /**
50057
- * Represents the password to protect the worksheet.
50058
- *
50059
- * @remarks
50060
- * If password is set to null or blank string, you can unprotect the worksheet or workbook without using a password. Otherwise, you must specify the password to unprotect the worksheet or workbook.
50061
- */
50062
- getPassword() : string;
50063
- /**
50064
- * Represents the password to protect the worksheet.
50065
- * @param value - The value to set.
50066
- *
50067
- * @remarks
50068
- * If password is set to null or blank string, you can unprotect the worksheet or workbook without using a password. Otherwise, you must specify the password to unprotect the worksheet or workbook.
50069
- */
50070
- setPassword(value: string) : void;
50071
- /**
50072
- * Indicates whether the worksheets is protected with password.
50073
- */
50074
- isProtectedWithPassword() : boolean;
50075
50363
  /**
50076
50364
  * Represents if the user is allowed to select locked cells on a protected worksheet.
50077
50365
  */
@@ -50090,20 +50378,43 @@ export class Protection {
50090
50378
  * @param value - The value to set.
50091
50379
  */
50092
50380
  setAllowSelectingUnlockedCell(value: boolean) : void;
50381
+ /**
50382
+ * Represents the password to protect the worksheet.
50383
+ *
50384
+ * @remarks
50385
+ * If password is set to null or blank string,
50386
+ * you can unprotect the worksheet or workbook without using a password.
50387
+ * Otherwise, you must specify the password to unprotect the worksheet or workbook.
50388
+ */
50389
+ getPassword() : string;
50390
+ /**
50391
+ * Represents the password to protect the worksheet.
50392
+ * @param value - The value to set.
50393
+ *
50394
+ * @remarks
50395
+ * If password is set to null or blank string,
50396
+ * you can unprotect the worksheet or workbook without using a password.
50397
+ * Otherwise, you must specify the password to unprotect the worksheet or workbook.
50398
+ */
50399
+ setPassword(value: string) : void;
50400
+ /**
50401
+ * Indicates whether the worksheets is protected with password.
50402
+ */
50403
+ isProtectedWithPassword() : boolean;
50093
50404
  /**
50094
50405
  * Copy protection info.
50095
50406
  * @param source -
50096
50407
  */
50097
50408
  copy(source: Protection) : void;
50098
- /**
50099
- * Gets the hash of current password.
50100
- */
50101
- getPasswordHash() : number;
50102
50409
  /**
50103
50410
  * Verifies password.
50104
50411
  * @param password - The password.
50105
50412
  */
50106
50413
  verifyPassword(password: string) : boolean;
50414
+ /**
50415
+ * Gets the hash of current password.
50416
+ */
50417
+ getPasswordHash() : number;
50107
50418
  /**
50108
50419
  * Checks whether the implementation object is null.
50109
50420
  */