aspose.cells.node 24.11.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/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).
@@ -257,6 +266,32 @@ export class AutoFilter {
257
266
  isNull() : boolean;
258
267
  }
259
268
 
269
+ /**
270
+ * Represents the category of the filter.
271
+ */
272
+ export enum FilterCategory {
273
+ /**
274
+ * No Filter.
275
+ */
276
+ None = 0,
277
+ /**
278
+ * Caption Filter.
279
+ */
280
+ Label = 1,
281
+ /**
282
+ * Number Value Filter.
283
+ */
284
+ NumberValue = 2,
285
+ /**
286
+ * Date Value Filter.
287
+ */
288
+ Date = 3,
289
+ /**
290
+ * Top10 Value Filter.
291
+ */
292
+ Top10 = 4,
293
+ }
294
+
260
295
  /**
261
296
  * Represents the type of auto fitting merged cells.
262
297
  */
@@ -296,6 +331,23 @@ export enum AutoFitWrappedTextType {
296
331
  Paragraph = 1,
297
332
  }
298
333
 
334
+ /**
335
+ * Monitor for user to track the change of formulas during certain operations.
336
+ *
337
+ * @remarks
338
+ * For example, while deleting/inserting range of cells,
339
+ * formulas of other cells may be changed because of the shift of references.
340
+ */
341
+ export abstract class AbstractFormulaChangeMonitor {
342
+ /**
343
+ * The event that will be triggered when the formula in a cell is changed.
344
+ * @param sheetIndex - The sheet index of the changed cell
345
+ * @param rowIndex - The row index of the changed cell
346
+ * @param columnIndex - The column index of the changed cell
347
+ */
348
+ abstract onCellFormulaChanged(sheetIndex: number, rowIndex: number, columnIndex: number) : void;
349
+ }
350
+
299
351
  /**
300
352
  * Utility for instantiating classes of Cells model.
301
353
  */
@@ -2091,6 +2143,125 @@ export class HtmlTableLoadOptionCollection {
2091
2143
  isNull() : boolean;
2092
2144
  }
2093
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
+
2094
2265
  /**
2095
2266
  * Represents the type of power query formula.
2096
2267
  */
@@ -8631,15 +8802,6 @@ export class Cells {
8631
8802
  * Clears all data of the worksheet.
8632
8803
  */
8633
8804
  clear() : void;
8634
- /**
8635
- * Imports an array of data into a worksheet.
8636
- * @param objArray - Data array.
8637
- * @param firstRow - The row number of the first cell to import in.
8638
- * @param firstColumn - The column number of the first cell to import in.
8639
- * @param isVertical - Specifies to import data vertically or horizontally.
8640
- * @param skip - Skipped number of rows or columns.
8641
- */
8642
- importObjectArray(objArray: object[], firstRow: number, firstColumn: number, isVertical: boolean, skip: number) : void;
8643
8805
  /**
8644
8806
  * Imports an array of formula into a worksheet.
8645
8807
  * @param stringArray - Formula array.
@@ -9177,6 +9339,13 @@ export class Cells {
9177
9339
  * @param updateReference - Indicates whether update references in other worksheets.
9178
9340
  */
9179
9341
  deleteColumns(columnIndex: number, totalColumns: number, updateReference: boolean) : void;
9342
+ /**
9343
+ * Deletes several columns.
9344
+ * @param columnIndex - Index of the first column to be deleted.
9345
+ * @param totalColumns - Count of columns to be deleted.
9346
+ * @param options - Options for the deleting operation
9347
+ */
9348
+ deleteColumns(columnIndex: number, totalColumns: number, options: DeleteOptions) : void;
9180
9349
  /**
9181
9350
  * Check whether the range could be deleted.
9182
9351
  * @param startRow - The start row index of the range.
@@ -9197,7 +9366,7 @@ export class Cells {
9197
9366
  */
9198
9367
  deleteRow(rowIndex: number, updateReference: boolean) : void;
9199
9368
  /**
9200
- * Deletes several rows.
9369
+ * Deletes multiple rows.
9201
9370
  * @param rowIndex - The first row index to be deleted.
9202
9371
  * @param totalRows - Count of rows to be deleted.
9203
9372
  *
@@ -9214,6 +9383,13 @@ export class Cells {
9214
9383
  * @param updateReference - Indicates whether update references in other worksheets.
9215
9384
  */
9216
9385
  deleteRows(rowIndex: number, totalRows: number, updateReference: boolean) : boolean;
9386
+ /**
9387
+ * Deletes multiple rows in the worksheet.
9388
+ * @param rowIndex - Index of the first row to be deleted.
9389
+ * @param totalRows - Count of rows to be deleted.
9390
+ * @param options - Options for the deleting operation
9391
+ */
9392
+ deleteRows(rowIndex: number, totalRows: number, options: DeleteOptions) : boolean;
9217
9393
  /**
9218
9394
  * Delete all blank columns which do not contain any data.
9219
9395
  */
@@ -9257,6 +9433,13 @@ export class Cells {
9257
9433
  * @param updateReference - Indicates if references in other worksheets will be updated.
9258
9434
  */
9259
9435
  insertColumns(columnIndex: number, totalColumns: number, updateReference: boolean) : void;
9436
+ /**
9437
+ * Inserts some columns into the worksheet.
9438
+ * @param columnIndex - Column index.
9439
+ * @param totalColumns - The number of columns.
9440
+ * @param options - The options for inserting operation.
9441
+ */
9442
+ insertColumns(columnIndex: number, totalColumns: number, options: InsertOptions) : void;
9260
9443
  /**
9261
9444
  * Inserts a new column into the worksheet.
9262
9445
  * @param columnIndex - Column index.
@@ -9279,7 +9462,7 @@ export class Cells {
9279
9462
  * Inserts multiple rows into the worksheet.
9280
9463
  * @param rowIndex - Row index.
9281
9464
  * @param totalRows - Number of rows to be inserted.
9282
- * @param options - Indicates if references in other worksheets will be updated.
9465
+ * @param options - Options for inserting operation.
9283
9466
  */
9284
9467
  insertRows(rowIndex: number, totalRows: number, options: InsertOptions) : void;
9285
9468
  /**
@@ -10409,6 +10592,10 @@ export class PowerQueryFormula {
10409
10592
  * Gets the type of this power query formula.
10410
10593
  */
10411
10594
  getType() : PowerQueryFormulaType;
10595
+ /**
10596
+ * Gets the name of group which contains this power query formula.
10597
+ */
10598
+ getGroupName() : string;
10412
10599
  /**
10413
10600
  * Gets the definition of the power query formula.
10414
10601
  */
@@ -12592,6 +12779,13 @@ export class Workbook {
12592
12779
  * Returns a style object.
12593
12780
  */
12594
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;
12595
12789
  /**
12596
12790
  * Creates built-in style by given type.
12597
12791
  * @param type - The builtin style stype.
@@ -15991,6 +16185,10 @@ export class PivotField {
15991
16185
  * Indicates whether the specified PivotTable field is calculated field.
15992
16186
  */
15993
16187
  isCalculatedField() : boolean;
16188
+ /**
16189
+ * Indicates whether this field represents values fields.
16190
+ */
16191
+ isValueFields() : boolean;
15994
16192
  /**
15995
16193
  * Represents the PivotField index in the base PivotFields.
15996
16194
  */
@@ -16004,6 +16202,10 @@ export class PivotField {
16004
16202
  * Represents the index of <see cref="PivotField"/> in the region.
16005
16203
  */
16006
16204
  getPosition() : number;
16205
+ /**
16206
+ * Specifies the region of the PivotTable that this field is displayed.
16207
+ */
16208
+ getRegionType() : PivotFieldType;
16007
16209
  /**
16008
16210
  * Represents the name of PivotField.
16009
16211
  */
@@ -16323,14 +16525,6 @@ export class PivotField {
16323
16525
  * @param value - The value to set.
16324
16526
  */
16325
16527
  setShowCompact(value: boolean) : void;
16326
- /**
16327
- * Gets the pivot filter of the pivot field by type
16328
- */
16329
- getPivotFilterByType(type: PivotFilterType) : PivotFilter;
16330
- /**
16331
- * Gets all pivot filters of this pivot field.
16332
- */
16333
- getFilters() : PivotFilter[];
16334
16528
  /**
16335
16529
  * Init the pivot items of the pivot field
16336
16530
  */
@@ -16374,6 +16568,48 @@ export class PivotField {
16374
16568
  * Ungroup the pivot field.
16375
16569
  */
16376
16570
  ungroup() : void;
16571
+ /**
16572
+ * Gets the pivot filter of the pivot field by type
16573
+ */
16574
+ getPivotFilterByType(type: PivotFilterType) : PivotFilter;
16575
+ /**
16576
+ * Gets all pivot filters of this pivot field.
16577
+ */
16578
+ getFilters() : PivotFilter[];
16579
+ /**
16580
+ * Clears filter setting on this pivot field.
16581
+ */
16582
+ clearFilter() : void;
16583
+ /**
16584
+ * Filters by values of data pivot field.
16585
+ * @param valueFieldIndex - The index of data field in the data region.
16586
+ * @param type - The type of filtering data. Only can be Count,Sum and Percent.
16587
+ * @param isTop - Indicates whether filter from top or bottom
16588
+ * @param itemCount - The item count
16589
+ */
16590
+ filterTop10(valueFieldIndex: number, type: PivotFilterType, isTop: boolean, itemCount: number) : PivotFilter;
16591
+ /**
16592
+ * Filters by values of data pivot field.
16593
+ * @param valueFieldIndex - The index of value field in the value region.
16594
+ * @param type - The type of filtering data.
16595
+ * @param value1 - The value of filter condition
16596
+ * @param value2 - The upper-bound value of between filter condition
16597
+ */
16598
+ filterByValue(valueFieldIndex: number, type: PivotFilterType, value1: number, value2: number) : PivotFilter;
16599
+ /**
16600
+ * Filters by captions of row or column pivot field.
16601
+ * @param type - The type of filtering data.
16602
+ * @param label1 - The label of filter condition
16603
+ * @param label2 - The upper-bound label of between filter condition
16604
+ */
16605
+ filterByLabel(type: PivotFilterType, label1: string, label2: string) : PivotFilter;
16606
+ /**
16607
+ * Filters by date setting of row or column pivot field.
16608
+ * @param type - The type of filtering data.
16609
+ * @param dateTime1 - The date label of filter condition
16610
+ * @param dateTime2 - The upper-bound date label of between filter condition
16611
+ */
16612
+ filterByDate(type: PivotFilterType, dateTime1: Date, dateTime2: Date) : PivotFilter;
16377
16613
  /**
16378
16614
  * Gets formula of the calculated field .
16379
16615
  */
@@ -16543,7 +16779,7 @@ export class PivotTable {
16543
16779
  */
16544
16780
  getBaseFields() : PivotFieldCollection;
16545
16781
  /**
16546
- * Returns a list of pivot filters.
16782
+ * Returns all filters of pivot fields in the pivot table.
16547
16783
  */
16548
16784
  getPivotFilters() : PivotFilterCollection;
16549
16785
  /**
@@ -16571,15 +16807,6 @@ export class PivotTable {
16571
16807
  * includes page fields. Read-only.
16572
16808
  */
16573
16809
  getTableRange2() : CellArea;
16574
- /**
16575
- * Indicates whether the PivotTable report shows grand totals for columns.
16576
- */
16577
- getColumnGrand() : boolean;
16578
- /**
16579
- * Indicates whether the PivotTable report shows grand totals for columns.
16580
- * @param value - The value to set.
16581
- */
16582
- setColumnGrand(value: boolean) : void;
16583
16810
  /**
16584
16811
  * Indicates whether the PivotTable report displays classic pivottable layout.
16585
16812
  * (enables dragging fields in the grid)
@@ -16592,12 +16819,71 @@ export class PivotTable {
16592
16819
  */
16593
16820
  setIsGridDropZones(value: boolean) : void;
16594
16821
  /**
16595
- * 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.
16596
16874
  */
16597
16875
  getRowGrand() : boolean;
16598
16876
  /**
16599
- * Indicates whether the PivotTable report shows grand totals for rows.
16877
+ * Indicates whether to show grand totals for rows of this pivot table.
16600
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.
16601
16887
  */
16602
16888
  setRowGrand(value: boolean) : void;
16603
16889
  /**
@@ -16737,11 +17023,11 @@ export class PivotTable {
16737
17023
  */
16738
17024
  setEnableFieldDialog(value: boolean) : void;
16739
17025
  /**
16740
- * 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.
16741
17027
  */
16742
17028
  getEnableFieldList() : boolean;
16743
17029
  /**
16744
- * 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.
16745
17031
  * @param value - The value to set.
16746
17032
  */
16747
17033
  setEnableFieldList(value: boolean) : void;
@@ -16768,12 +17054,12 @@ export class PivotTable {
16768
17054
  */
16769
17055
  setSubtotalHiddenPageItems(value: boolean) : void;
16770
17056
  /**
16771
- * 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.
16772
17058
  * The default value is the string "Grand Total".
16773
17059
  */
16774
17060
  getGrandTotalName() : string;
16775
17061
  /**
16776
- * 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.
16777
17063
  * The default value is the string "Grand Total".
16778
17064
  * @param value - The value to set.
16779
17065
  */
@@ -16789,13 +17075,38 @@ export class PivotTable {
16789
17075
  setManualUpdate(value: boolean) : void;
16790
17076
  /**
16791
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.
16792
17086
  */
16793
17087
  isMultipleFieldFilters() : boolean;
16794
17088
  /**
16795
17089
  * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
16796
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.
16797
17099
  */
16798
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;
16799
17110
  /**
16800
17111
  * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
16801
17112
  */
@@ -16844,20 +17155,20 @@ export class PivotTable {
16844
17155
  */
16845
17156
  setShowValuesRow(value: boolean) : void;
16846
17157
  /**
16847
- * Specifies a boolean value that indicates whether to include empty columns in the table
17158
+ * Indicates whether to include empty columns in the table
16848
17159
  */
16849
17160
  getShowEmptyCol() : boolean;
16850
17161
  /**
16851
- * Specifies a boolean value that indicates whether to include empty columns in the table
17162
+ * Indicates whether to include empty columns in the table
16852
17163
  * @param value - The value to set.
16853
17164
  */
16854
17165
  setShowEmptyCol(value: boolean) : void;
16855
17166
  /**
16856
- * Specifies a boolean value that indicates whether to include empty rows in the table.
17167
+ * Indicates whether to include empty rows in the table.
16857
17168
  */
16858
17169
  getShowEmptyRow() : boolean;
16859
17170
  /**
16860
- * Specifies a boolean value that indicates whether to include empty rows in the table.
17171
+ * Indicates whether to include empty rows in the table.
16861
17172
  * @param value - The value to set.
16862
17173
  */
16863
17174
  setShowEmptyRow(value: boolean) : void;
@@ -16957,8 +17268,20 @@ export class PivotTable {
16957
17268
  setCustomListSort(value: boolean) : void;
16958
17269
  /**
16959
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.
16960
17279
  */
16961
17280
  getPivotFormatConditions() : PivotFormatConditionCollection;
17281
+ /**
17282
+ * Gets the conditional formats of the pivot table.
17283
+ */
17284
+ getConditionalFormats() : PivotConditionalFormatCollection;
16962
17285
  /**
16963
17286
  * Gets and sets the order in which page fields are added to the PivotTable report's layout.
16964
17287
  */
@@ -17006,11 +17329,25 @@ export class PivotTable {
17006
17329
  setRefreshDataOnOpeningFile(value: boolean) : void;
17007
17330
  /**
17008
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.
17009
17339
  */
17010
17340
  getRefreshDataFlag() : boolean;
17011
17341
  /**
17012
17342
  * Indicates whether Refreshing Data or not.
17013
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.
17014
17351
  */
17015
17352
  setRefreshDataFlag(value: boolean) : void;
17016
17353
  /**
@@ -17022,11 +17359,11 @@ export class PivotTable {
17022
17359
  *
17023
17360
  * @remarks
17024
17361
  * NOTE: This property is now obsolete. Instead,
17025
- * please use pivotTable.GetSourceDataConnections() method.
17362
+ * please use PivotTable.GetSourceDataConnections() method.
17026
17363
  * This method will be removed 12 months later since October 2024.
17027
17364
  * Aspose apologizes for any inconvenience you may have experienced.
17028
17365
  * @deprecated
17029
- * Use pivotTable.GetSourceDataConnections() method instead.
17366
+ * Use PivotTable.GetSourceDataConnections() method instead.
17030
17367
  */
17031
17368
  getExternalConnectionDataSource() : ExternalConnection;
17032
17369
  /**
@@ -17243,13 +17580,40 @@ export class PivotTable {
17243
17580
  * Moves the PivotTable to a different location in the worksheet.
17244
17581
  * @param row - row index.
17245
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.
17246
17591
  */
17247
17592
  move(row: number, column: number) : void;
17248
17593
  /**
17249
17594
  * Moves the PivotTable to a different location in the worksheet.
17250
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.
17251
17604
  */
17252
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;
17253
17617
  /**
17254
17618
  * Gets the external connection data sources.
17255
17619
  */
@@ -17260,7 +17624,6 @@ export class PivotTable {
17260
17624
  getNamesOfSourceDataConnections() : string[];
17261
17625
  /**
17262
17626
  * Set pivottable's source data.
17263
- * Sheet1!$A$1:$C$3
17264
17627
  */
17265
17628
  changeDataSource(source: string[]) : void;
17266
17629
  /**
@@ -17321,10 +17684,16 @@ export class PivotTable {
17321
17684
  formatRow(row: number, style: Style) : void;
17322
17685
  /**
17323
17686
  * Formats selected area of the PivotTable.
17324
- * @param pivotArea -
17325
- * @param style -
17687
+ * @param pivotArea - The selected pivot view area.
17688
+ * @param style - The formatted setting.
17326
17689
  */
17327
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;
17328
17697
  /**
17329
17698
  * Format the cell in the pivottable area
17330
17699
  * @param row - Row Index of the cell
@@ -17332,6 +17701,11 @@ export class PivotTable {
17332
17701
  * @param style - Style which is to format the cell
17333
17702
  */
17334
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;
17335
17709
  /**
17336
17710
  * Show the detail of one item in the data region to a new Table.
17337
17711
  * @param rowOffset - Offset to the first data row in the data region.
@@ -17341,6 +17715,10 @@ export class PivotTable {
17341
17715
  * @param destColumn - The target column.
17342
17716
  */
17343
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[];
17344
17722
  /**
17345
17723
  * Layouts the PivotTable in compact form.
17346
17724
  */
@@ -19747,6 +20125,10 @@ export class CalculationOptions {
19747
20125
  * used in INDIRECT function. For those external links used in INDIRECT function,
19748
20126
  * they are not taken as part of the external links of the workbook and cannot be updated
19749
20127
  * by <see cref="Workbook.UpdateLinkedDataSource(Workbook[])"/>.
20128
+ * The match of those workbooks with external links is determined by <see cref="Workbook.FileName"/>
20129
+ * and <see cref="ExternalLink.DataSource"/>. So please make sure <see cref="Workbook.FileName"/> has
20130
+ * been specified with the proper value(generally it should be same with corresponding
20131
+ * <see cref="ExternalLink.DataSource"/>) for every workbook so they can be linked as expected.
19750
20132
  */
19751
20133
  getLinkedDataSources() : Workbook[];
19752
20134
  /**
@@ -19759,6 +20141,10 @@ export class CalculationOptions {
19759
20141
  * used in INDIRECT function. For those external links used in INDIRECT function,
19760
20142
  * they are not taken as part of the external links of the workbook and cannot be updated
19761
20143
  * by <see cref="Workbook.UpdateLinkedDataSource(Workbook[])"/>.
20144
+ * The match of those workbooks with external links is determined by <see cref="Workbook.FileName"/>
20145
+ * and <see cref="ExternalLink.DataSource"/>. So please make sure <see cref="Workbook.FileName"/> has
20146
+ * been specified with the proper value(generally it should be same with corresponding
20147
+ * <see cref="ExternalLink.DataSource"/>) for every workbook so they can be linked as expected.
19762
20148
  */
19763
20149
  setLinkedDataSources(value: Workbook[]) : void;
19764
20150
  /**
@@ -23788,6 +24174,15 @@ export class DeleteOptions {
23788
24174
  * @param value - The value to set.
23789
24175
  */
23790
24176
  setUpdateReference(value: boolean) : void;
24177
+ /**
24178
+ * Gets/sets the monitor for tracking changes caused by the deletion.
24179
+ */
24180
+ getFormulaChangeMonitor() : AbstractFormulaChangeMonitor;
24181
+ /**
24182
+ * Gets/sets the monitor for tracking changes caused by the deletion.
24183
+ * @param value - The value to set.
24184
+ */
24185
+ setFormulaChangeMonitor(value: AbstractFormulaChangeMonitor) : void;
23791
24186
  /**
23792
24187
  * Checks whether the implementation object is null.
23793
24188
  */
@@ -26305,7 +26700,7 @@ export class WarningInfo {
26305
26700
  /**
26306
26701
  * Get warning type.
26307
26702
  */
26308
- getWarningType() : WarningType;
26703
+ getType() : ExceptionType;
26309
26704
  /**
26310
26705
  * Get description of warning info.
26311
26706
  */
@@ -26331,6 +26726,14 @@ export class WarningInfo {
26331
26726
 
26332
26727
  /**
26333
26728
  * WaringType
26729
+ *
26730
+ * @remarks
26731
+ * NOTE: This enum is now obsolete. Instead,
26732
+ * please use ExceptionType enum, instead.
26733
+ * This property will be removed 12 months later since December 2024.
26734
+ * Aspose apologizes for any inconvenience you may have experienced.
26735
+ * @deprecated
26736
+ * Use ExceptionType enum, instead.
26334
26737
  */
26335
26738
  export enum WarningType {
26336
26739
  /**
@@ -26384,10 +26787,6 @@ export enum WarningType {
26384
26787
  * Specifies write protection settings for a workbook.
26385
26788
  */
26386
26789
  export class WriteProtection {
26387
- /**
26388
- * Default Constructor.
26389
- */
26390
- constructor();
26391
26790
  /**
26392
26791
  * Gets and sets the author.
26393
26792
  */
@@ -27369,6 +27768,15 @@ export class InsertOptions {
27369
27768
  * @param value - The value to set.
27370
27769
  */
27371
27770
  setUpdateReference(value: boolean) : void;
27771
+ /**
27772
+ * Gets/sets the monitor for tracking changes caused by the insertion.
27773
+ */
27774
+ getFormulaChangeMonitor() : AbstractFormulaChangeMonitor;
27775
+ /**
27776
+ * Gets/sets the monitor for tracking changes caused by the insertion.
27777
+ * @param value - The value to set.
27778
+ */
27779
+ setFormulaChangeMonitor(value: AbstractFormulaChangeMonitor) : void;
27372
27780
  /**
27373
27781
  * Checks whether the implementation object is null.
27374
27782
  */
@@ -28984,8 +29392,25 @@ export enum PivotConditionFormatScopeType {
28984
29392
  * Represents a PivotFilter in PivotFilter Collection.
28985
29393
  */
28986
29394
  export class PivotFilter {
29395
+ /**
29396
+ * Indicates whether uses whole days in its filtering criteria.
29397
+ */
29398
+ getUseWholeDay() : boolean;
29399
+ /**
29400
+ * Indicates whether uses whole days in its filtering criteria.
29401
+ * @param value - The value to set.
29402
+ */
29403
+ setUseWholeDay(value: boolean) : void;
28987
29404
  /**
28988
29405
  * Gets the autofilter of the pivot filter.
29406
+ *
29407
+ * @remarks
29408
+ * NOTE: This method is now obsolete. Instead,
29409
+ * please use FilterLabel, FilterValue,FilterDate or FilterTop10 method.
29410
+ * This method will be removed 12 months later since November 2024.
29411
+ * Aspose apologizes for any inconvenience you may have experienced.
29412
+ * @deprecated
29413
+ * Use FilterLabel, FilterValue,FilterDate or FilterTop10 method.
28989
29414
  */
28990
29415
  getAutoFilter() : AutoFilter;
28991
29416
  /**
@@ -28993,9 +29418,13 @@ export class PivotFilter {
28993
29418
  */
28994
29419
  getFilterType() : PivotFilterType;
28995
29420
  /**
28996
- * Gets the field index of the pivot filter.
29421
+ * Gets the index of source field which this pivot filter is applied to.
28997
29422
  */
28998
29423
  getFieldIndex() : number;
29424
+ /**
29425
+ * Gets the category of this filter.
29426
+ */
29427
+ getFilterCategory() : FilterCategory;
28999
29428
  /**
29000
29429
  * Gets the string value1 of the label pivot filter.
29001
29430
  */
@@ -29016,13 +29445,43 @@ export class PivotFilter {
29016
29445
  setValue2(value: string) : void;
29017
29446
  /**
29018
29447
  * Gets the measure field index of the pivot filter.
29448
+ *
29449
+ * @remarks
29450
+ * NOTE: This method is now obsolete. Instead,
29451
+ * please use PivotFilter.ValueFieldIndex property.
29452
+ * This method will be removed 12 months later since November 2024.
29453
+ * Aspose apologizes for any inconvenience you may have experienced.
29454
+ * @deprecated
29455
+ * Use PivotFilter.ValueFieldIndex property.
29019
29456
  */
29020
29457
  getMeasureFldIndex() : number;
29021
29458
  /**
29022
29459
  * Gets the measure field index of the pivot filter.
29023
29460
  * @param value - The value to set.
29461
+ *
29462
+ * @remarks
29463
+ * NOTE: This method is now obsolete. Instead,
29464
+ * please use PivotFilter.ValueFieldIndex property.
29465
+ * This method will be removed 12 months later since November 2024.
29466
+ * Aspose apologizes for any inconvenience you may have experienced.
29467
+ * @deprecated
29468
+ * Use PivotFilter.ValueFieldIndex property.
29024
29469
  */
29025
29470
  setMeasureFldIndex(value: number) : void;
29471
+ /**
29472
+ * Gets the index of value field in the value region.
29473
+ */
29474
+ getValueFieldIndex() : number;
29475
+ /**
29476
+ * Gets the index of value field in the value region.
29477
+ * @param value - The value to set.
29478
+ */
29479
+ setValueFieldIndex(value: number) : void;
29480
+ /**
29481
+ * Specifies the index of the measure cube field.
29482
+ * this property is used only by filters in OLAP pivots and specifies on which measure a value filter should apply.
29483
+ */
29484
+ getMeasureCubeFieldIndex() : number;
29026
29485
  /**
29027
29486
  * Gets the member property field index of the pivot filter.
29028
29487
  */
@@ -29050,6 +29509,22 @@ export class PivotFilter {
29050
29509
  * @param value - The value to set.
29051
29510
  */
29052
29511
  setEvaluationOrder(value: number) : void;
29512
+ /**
29513
+ * Gets top 10 setting of the filter.
29514
+ */
29515
+ getTop10Value() : Top10Filter;
29516
+ /**
29517
+ * Gets labels of the caption filter.
29518
+ */
29519
+ getLabels() : string[];
29520
+ /**
29521
+ * Gets values of the number filter.
29522
+ */
29523
+ getNumberValues() : number[];
29524
+ /**
29525
+ * Gets values of the number filter.
29526
+ */
29527
+ getDateTimeValues() : Date[];
29053
29528
  /**
29054
29529
  * Checks whether the implementation object is null.
29055
29530
  */
@@ -29070,8 +29545,50 @@ export class PivotFilterCollection {
29070
29545
  * @param type - the PivotFilter type
29071
29546
  * @returns
29072
29547
  * the index of the PivotFilter Object in this PivotFilterCollection.
29548
+ *
29549
+ * @remarks
29550
+ * NOTE: This method is now obsolete. Instead,
29551
+ * please use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods.
29552
+ * This method will be removed 12 months later since November 2024.
29553
+ * Aspose apologizes for any inconvenience you may have experienced.
29554
+ * @deprecated
29555
+ * Use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods,instead.
29073
29556
  */
29074
29557
  add(fieldIndex: number, type: PivotFilterType) : number;
29558
+ /**
29559
+ * Filters by values of data pivot field.
29560
+ * @param baseFieldIndex - The index of field in the source.
29561
+ * @param valueFieldIndex - The index of data field in the data region.
29562
+ * @param type - The type of filtering data. Only can be Count,Sum and Percent.
29563
+ * @param isTop - Indicates whether filter from top or bottom
29564
+ * @param itemCount - The item count
29565
+ */
29566
+ addTop10Filter(baseFieldIndex: number, valueFieldIndex: number, type: PivotFilterType, isTop: boolean, itemCount: number) : PivotFilter;
29567
+ /**
29568
+ * Filters by values of data pivot field.
29569
+ * @param baseFieldIndex - The index of field in the source.
29570
+ * @param valueFieldIndex - The index of value field in the value region.
29571
+ * @param type - The type of filtering data.
29572
+ * @param value1 - The value of filter condition
29573
+ * @param value2 - The upper-bound value of between filter condition
29574
+ */
29575
+ addValueFilter(baseFieldIndex: number, valueFieldIndex: number, type: PivotFilterType, value1: number, value2: number) : PivotFilter;
29576
+ /**
29577
+ * Filters by captions of row or column pivot field.
29578
+ * @param baseFieldIndex - The index of field in the source.
29579
+ * @param type - The type of filtering data.
29580
+ * @param label1 - The label of filter condition
29581
+ * @param label2 - The upper-bound label of between filter condition
29582
+ */
29583
+ addLabelFilter(baseFieldIndex: number, type: PivotFilterType, label1: string, label2: string) : PivotFilter;
29584
+ /**
29585
+ * Filters by date setting of row or column pivot field.
29586
+ * @param baseFieldIndex - The index of field in the source.
29587
+ * @param type - The type of filtering data.
29588
+ * @param dateTime1 - The date label of filter condition
29589
+ * @param dateTime2 - The upper-bound date label of between filter condition
29590
+ */
29591
+ addDateFilter(baseFieldIndex: number, type: PivotFilterType, dateTime1: Date, dateTime2: Date) : PivotFilter;
29075
29592
  /**
29076
29593
  * Clear PivotFilter from the specific PivotField
29077
29594
  * @param fieldIndex - the PivotField index
@@ -29160,13 +29677,37 @@ export enum PivotFilterType {
29160
29677
  */
29161
29678
  DateEqual = 16,
29162
29679
  /**
29163
- * Indicates the "newer than" filter for date values.
29680
+ * Indicates the "after" filter for date values.
29681
+ *
29682
+ * @remarks
29683
+ * NOTE: This member is now obsolete. Instead,
29684
+ * please use <see cref="PivotFilterType.DateAfter"/> property.
29685
+ * This property will be removed 6 months later since November 2024.
29686
+ * Aspose apologizes for any inconvenience you may have experienced.
29687
+ * @deprecated
29688
+ * Use PivotFilterType.DateAfter instead.
29164
29689
  */
29165
29690
  DateNewerThan = 17,
29166
29691
  /**
29167
- * Indicates the "newer than or equal to" filter for date values.
29692
+ * Indicates the "after" filter for date values.
29693
+ */
29694
+ DateAfter = 17,
29695
+ /**
29696
+ * Indicates the "after or equal to" filter for date values.
29697
+ *
29698
+ * @remarks
29699
+ * NOTE: This member is now obsolete. Instead,
29700
+ * please use <see cref="PivotFilterType.DateAfterOrEqual"/> property.
29701
+ * This property will be removed 6 months later since November 2024.
29702
+ * Aspose apologizes for any inconvenience you may have experienced.
29703
+ * @deprecated
29704
+ * Use PivotFilterType.DateAfterOrEqual instead.
29168
29705
  */
29169
29706
  DateNewerThanOrEqual = 18,
29707
+ /**
29708
+ * Indicates the "after or equal to" filter for date values.
29709
+ */
29710
+ DateAfterOrEqual = 18,
29170
29711
  /**
29171
29712
  * Indicates the "not between" filter for date values.
29172
29713
  */
@@ -29176,13 +29717,37 @@ export enum PivotFilterType {
29176
29717
  */
29177
29718
  DateNotEqual = 20,
29178
29719
  /**
29179
- * Indicates the "older than" filter for date values.
29720
+ * Indicates the "before" filter for date values.
29721
+ *
29722
+ * @remarks
29723
+ * NOTE: This member is now obsolete. Instead,
29724
+ * please use <see cref="PivotFilterType.DateBefore"/> property.
29725
+ * This property will be removed 6 months later since November 2024.
29726
+ * Aspose apologizes for any inconvenience you may have experienced.
29727
+ * @deprecated
29728
+ * Use PivotFilterType.DateBefore instead.
29180
29729
  */
29181
29730
  DateOlderThan = 21,
29182
29731
  /**
29183
- * Indicates the "older than or equal to" filter for date values.
29732
+ * Indicates the "before" filter for date values.
29733
+ */
29734
+ DateBefore = 21,
29735
+ /**
29736
+ * Indicates the "before or equal to" filter for date values.
29737
+ *
29738
+ * @remarks
29739
+ * NOTE: This member is now obsolete. Instead,
29740
+ * please use <see cref="PivotFilterType.DateBeforeOrEqual"/> property.
29741
+ * This property will be removed 6 months later since November 2024.
29742
+ * Aspose apologizes for any inconvenience you may have experienced.
29743
+ * @deprecated
29744
+ * Use PivotFilterType.DateBeforeOrEqual instead.
29184
29745
  */
29185
29746
  DateOlderThanOrEqual = 22,
29747
+ /**
29748
+ * Indicates the "before or equal to" filter for date values.
29749
+ */
29750
+ DateBeforeOrEqual = 22,
29186
29751
  /**
29187
29752
  * Indicates the "last month" filter for date values.
29188
29753
  */
@@ -29201,52 +29766,196 @@ export enum PivotFilterType {
29201
29766
  LastYear = 26,
29202
29767
  /**
29203
29768
  * Indicates the "January" filter for date values.
29769
+ *
29770
+ * @remarks
29771
+ * NOTE: This member is now obsolete. Instead,
29772
+ * please use <see cref="PivotFilterType.January"/> property.
29773
+ * This property will be removed 6 months later since November 2024.
29774
+ * Aspose apologizes for any inconvenience you may have experienced.
29775
+ * @deprecated
29776
+ * Use PivotFilterType.January instead.
29204
29777
  */
29205
29778
  M1 = 27,
29779
+ /**
29780
+ * Indicates the "January" filter for date values.
29781
+ */
29782
+ January = 27,
29206
29783
  /**
29207
29784
  * Indicates the "February" filter for date values.
29785
+ *
29786
+ * @remarks
29787
+ * NOTE: This member is now obsolete. Instead,
29788
+ * please use <see cref="PivotFilterType.February"/> property.
29789
+ * This property will be removed 6 months later since November 2024.
29790
+ * Aspose apologizes for any inconvenience you may have experienced.
29791
+ * @deprecated
29792
+ * Use PivotFilterType.February instead.
29208
29793
  */
29209
29794
  M2 = 28,
29795
+ /**
29796
+ * Indicates the "February" filter for date values.
29797
+ */
29798
+ February = 28,
29210
29799
  /**
29211
29800
  * Indicates the "March" filter for date values.
29801
+ *
29802
+ * @remarks
29803
+ * NOTE: This member is now obsolete. Instead,
29804
+ * please use <see cref="PivotFilterType.March"/> property.
29805
+ * This property will be removed 6 months later since November 2024.
29806
+ * Aspose apologizes for any inconvenience you may have experienced.
29807
+ * @deprecated
29808
+ * Use PivotFilterType.March instead.
29212
29809
  */
29213
29810
  M3 = 29,
29811
+ /**
29812
+ * Indicates the "March" filter for date values.
29813
+ */
29814
+ March = 29,
29214
29815
  /**
29215
29816
  * Indicates the "April" filter for date values.
29817
+ *
29818
+ * @remarks
29819
+ * NOTE: This member is now obsolete. Instead,
29820
+ * please use <see cref="PivotFilterType.April"/> property.
29821
+ * This property will be removed 6 months later since November 2024.
29822
+ * Aspose apologizes for any inconvenience you may have experienced.
29823
+ * @deprecated
29824
+ * Use PivotFilterType.April instead.
29216
29825
  */
29217
29826
  M4 = 30,
29827
+ /**
29828
+ * Indicates the "April" filter for date values.
29829
+ */
29830
+ April = 30,
29218
29831
  /**
29219
29832
  * Indicates the "May" filter for date values.
29833
+ *
29834
+ * @remarks
29835
+ * NOTE: This member is now obsolete. Instead,
29836
+ * please use <see cref="PivotFilterType.May"/> property.
29837
+ * This property will be removed 6 months later since November 2024.
29838
+ * Aspose apologizes for any inconvenience you may have experienced.
29839
+ * @deprecated
29840
+ * Use PivotFilterType.May instead.
29220
29841
  */
29221
29842
  M5 = 31,
29843
+ /**
29844
+ * Indicates the "May" filter for date values.
29845
+ */
29846
+ May = 31,
29222
29847
  /**
29223
29848
  * Indicates the "June" filter for date values.
29849
+ *
29850
+ * @remarks
29851
+ * NOTE: This member is now obsolete. Instead,
29852
+ * please use <see cref="PivotFilterType.June"/> property.
29853
+ * This property will be removed 6 months later since November 2024.
29854
+ * Aspose apologizes for any inconvenience you may have experienced.
29855
+ * @deprecated
29856
+ * Use PivotFilterType.June instead.
29224
29857
  */
29225
29858
  M6 = 32,
29859
+ /**
29860
+ * Indicates the "June" filter for date values.
29861
+ */
29862
+ June = 32,
29226
29863
  /**
29227
29864
  * Indicates the "July" filter for date values.
29865
+ *
29866
+ * @remarks
29867
+ * NOTE: This member is now obsolete. Instead,
29868
+ * please use <see cref="PivotFilterType.July"/> property.
29869
+ * This property will be removed 6 months later since November 2024.
29870
+ * Aspose apologizes for any inconvenience you may have experienced.
29871
+ * @deprecated
29872
+ * Use PivotFilterType.July instead.
29228
29873
  */
29229
29874
  M7 = 33,
29875
+ /**
29876
+ * Indicates the "July" filter for date values.
29877
+ */
29878
+ July = 33,
29230
29879
  /**
29231
29880
  * Indicates the "August" filter for date values.
29881
+ *
29882
+ * @remarks
29883
+ * NOTE: This member is now obsolete. Instead,
29884
+ * please use <see cref="PivotFilterType.August"/> property.
29885
+ * This property will be removed 6 months later since November 2024.
29886
+ * Aspose apologizes for any inconvenience you may have experienced.
29887
+ * @deprecated
29888
+ * Use PivotFilterType.August instead.
29232
29889
  */
29233
29890
  M8 = 34,
29891
+ /**
29892
+ * Indicates the "August" filter for date values.
29893
+ */
29894
+ August = 34,
29234
29895
  /**
29235
29896
  * Indicates the "September" filter for date values.
29897
+ *
29898
+ * @remarks
29899
+ * NOTE: This member is now obsolete. Instead,
29900
+ * please use <see cref="PivotFilterType.September"/> property.
29901
+ * This property will be removed 6 months later since November 2024.
29902
+ * Aspose apologizes for any inconvenience you may have experienced.
29903
+ * @deprecated
29904
+ * Use PivotFilterType.September instead.
29236
29905
  */
29237
29906
  M9 = 35,
29907
+ /**
29908
+ * Indicates the "September" filter for date values.
29909
+ */
29910
+ September = 35,
29238
29911
  /**
29239
29912
  * Indicates the "October" filter for date values.
29913
+ *
29914
+ * @remarks
29915
+ * NOTE: This member is now obsolete. Instead,
29916
+ * please use <see cref="PivotFilterType.October"/> property.
29917
+ * This property will be removed 6 months later since November 2024.
29918
+ * Aspose apologizes for any inconvenience you may have experienced.
29919
+ * @deprecated
29920
+ * Use PivotFilterType.October instead.
29240
29921
  */
29241
29922
  M10 = 36,
29923
+ /**
29924
+ * Indicates the "October" filter for date values.
29925
+ */
29926
+ October = 36,
29242
29927
  /**
29243
29928
  * Indicates the "November" filter for date values.
29929
+ *
29930
+ * @remarks
29931
+ * NOTE: This member is now obsolete. Instead,
29932
+ * please use <see cref="PivotFilterType.November"/> property.
29933
+ * This property will be removed 6 months later since November 2024.
29934
+ * Aspose apologizes for any inconvenience you may have experienced.
29935
+ * @deprecated
29936
+ * Use PivotFilterType.November instead.
29244
29937
  */
29245
29938
  M11 = 37,
29939
+ /**
29940
+ * Indicates the "November" filter for date values.
29941
+ */
29942
+ November = 37,
29246
29943
  /**
29247
29944
  * Indicates the "December" filter for date values.
29945
+ *
29946
+ * @remarks
29947
+ * NOTE: This member is now obsolete. Instead,
29948
+ * please use <see cref="PivotFilterType.December"/> property.
29949
+ * This property will be removed 6 months later since November 2024.
29950
+ * Aspose apologizes for any inconvenience you may have experienced.
29951
+ * @deprecated
29952
+ * Use PivotFilterType.December instead.
29248
29953
  */
29249
29954
  M12 = 38,
29955
+ /**
29956
+ * Indicates the "December" filter for date values.
29957
+ */
29958
+ December = 38,
29250
29959
  /**
29251
29960
  * Indicates the "next month" filter for date values.
29252
29961
  */
@@ -29269,20 +29978,68 @@ export enum PivotFilterType {
29269
29978
  Percent = 43,
29270
29979
  /**
29271
29980
  * Indicates the "first quarter" filter for date values.
29981
+ *
29982
+ * @remarks
29983
+ * NOTE: This member is now obsolete. Instead,
29984
+ * please use <see cref="PivotFilterType.Quarter1"/> property.
29985
+ * This property will be removed 6 months later since November 2024.
29986
+ * Aspose apologizes for any inconvenience you may have experienced.
29987
+ * @deprecated
29988
+ * Use PivotFilterType.Quarter1 instead.
29272
29989
  */
29273
29990
  Q1 = 44,
29991
+ /**
29992
+ * Indicates the "first quarter" filter for date values.
29993
+ */
29994
+ Quarter1 = 44,
29274
29995
  /**
29275
29996
  * Indicates the "second quarter" filter for date values.
29997
+ *
29998
+ * @remarks
29999
+ * NOTE: This member is now obsolete. Instead,
30000
+ * please use <see cref="PivotFilterType.Quarter2"/> property.
30001
+ * This property will be removed 6 months later since November 2024.
30002
+ * Aspose apologizes for any inconvenience you may have experienced.
30003
+ * @deprecated
30004
+ * Use PivotFilterType.Quarter2 instead.
29276
30005
  */
29277
30006
  Q2 = 45,
30007
+ /**
30008
+ * Indicates the "second quarter" filter for date values.
30009
+ */
30010
+ Quarter2 = 45,
29278
30011
  /**
29279
30012
  * Indicates the "third quarter" filter for date values.
30013
+ *
30014
+ * @remarks
30015
+ * NOTE: This member is now obsolete. Instead,
30016
+ * please use <see cref="PivotFilterType.Quarter3"/> property.
30017
+ * This property will be removed 6 months later since November 2024.
30018
+ * Aspose apologizes for any inconvenience you may have experienced.
30019
+ * @deprecated
30020
+ * Use PivotFilterType.Quarter3 instead.
29280
30021
  */
29281
30022
  Q3 = 46,
30023
+ /**
30024
+ * Indicates the "third quarter" filter for date values.
30025
+ */
30026
+ Quarter3 = 46,
29282
30027
  /**
29283
30028
  * Indicates the "fourth quarter" filter for date values.
30029
+ *
30030
+ * @remarks
30031
+ * NOTE: This member is now obsolete. Instead,
30032
+ * please use <see cref="PivotFilterType.Quarter4"/> property.
30033
+ * This property will be removed 6 months later since November 2024.
30034
+ * Aspose apologizes for any inconvenience you may have experienced.
30035
+ * @deprecated
30036
+ * Use PivotFilterType.Quarter4 instead.
29284
30037
  */
29285
30038
  Q4 = 47,
30039
+ /**
30040
+ * Indicates the "fourth quarter" filter for date values.
30041
+ */
30042
+ Quarter4 = 47,
29286
30043
  /**
29287
30044
  * Indicates the "sum" filter for numeric values.
29288
30045
  */
@@ -29355,18 +30112,30 @@ export enum PivotFilterType {
29355
30112
  * Indicates the "yesterday" filter for date values.
29356
30113
  */
29357
30114
  Yesterday = 65,
30115
+ /**
30116
+ * No filter.
30117
+ */
30118
+ None = 255,
29358
30119
  }
29359
30120
 
29360
30121
  /**
29361
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.
29362
30131
  */
29363
30132
  export class PivotFormatCondition {
29364
30133
  /**
29365
- * Get and set scope type for the pivot table condition format .
30134
+ * Get and set scope type for the pivot table conditional format .
29366
30135
  */
29367
30136
  getScopeType() : PivotConditionFormatScopeType;
29368
30137
  /**
29369
- * Get and set scope type for the pivot table condition format .
30138
+ * Get and set scope type for the pivot table conditional format .
29370
30139
  * @param value - The value to set.
29371
30140
  */
29372
30141
  setScopeType(value: PivotConditionFormatScopeType) : void;
@@ -29380,7 +30149,7 @@ export class PivotFormatCondition {
29380
30149
  */
29381
30150
  setRuleType(value: PivotConditionFormatRuleType) : void;
29382
30151
  /**
29383
- * Get formatconditions for the pivot table condition format .
30152
+ * Get conditions for the pivot table conditional format .
29384
30153
  */
29385
30154
  getFormatConditions() : FormatConditionCollection;
29386
30155
  /**
@@ -29425,6 +30194,14 @@ export class PivotFormatCondition {
29425
30194
 
29426
30195
  /**
29427
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.
29428
30205
  */
29429
30206
  export class PivotFormatConditionCollection {
29430
30207
  /**
@@ -29433,6 +30210,10 @@ export class PivotFormatConditionCollection {
29433
30210
  * pivot FormatCondition object.
29434
30211
  */
29435
30212
  get(index: number) : PivotFormatCondition;
30213
+ /**
30214
+ * Gets the count of conditional formats.
30215
+ */
30216
+ getCount() : number;
29436
30217
  /**
29437
30218
  * Adds a pivot FormatCondition to the collection.
29438
30219
  * @returns
@@ -29443,9 +30224,9 @@ export class PivotFormatConditionCollection {
29443
30224
  */
29444
30225
  add() : number;
29445
30226
  /**
29446
- * Gets the number of elements contained in.
30227
+ * Remove a conditional formats.
29447
30228
  */
29448
- getCount() : number;
30229
+ removeAt(index: number) : void;
29449
30230
  /**
29450
30231
  * Checks whether the implementation object is null.
29451
30232
  */
@@ -31576,6 +32357,22 @@ export class PivotArea {
31576
32357
  * @param selectionType - Specifies what can be selected in a PivotTable during a structured selection.
31577
32358
  */
31578
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[];
31579
32376
  /**
31580
32377
  * Checks whether the implementation object is null.
31581
32378
  */
@@ -33650,6 +34447,28 @@ export class HtmlSaveOptions extends SaveOptions {
33650
34447
  * @param value - The value to set.
33651
34448
  */
33652
34449
  setCellNameAttribute(value: string) : void;
34450
+ /**
34451
+ * Indicates whether only inline styles are applied, without relying on CSS.
34452
+ * The default value is false.
34453
+ */
34454
+ getDisableCss() : boolean;
34455
+ /**
34456
+ * Indicates whether only inline styles are applied, without relying on CSS.
34457
+ * The default value is false.
34458
+ * @param value - The value to set.
34459
+ */
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;
33653
34472
  /**
33654
34473
  * Checks whether the implementation object is null.
33655
34474
  */
@@ -36705,6 +37524,15 @@ export class ReplaceOptions {
36705
37524
  * @param value - The value to set.
36706
37525
  */
36707
37526
  setFontSettings(value: FontSetting[]) : void;
37527
+ /**
37528
+ * Gets and sets flags of applying font settings.
37529
+ */
37530
+ getStyleFlags() : StyleFlag[];
37531
+ /**
37532
+ * Gets and sets flags of applying font settings.
37533
+ * @param value - The value to set.
37534
+ */
37535
+ setStyleFlags(value: StyleFlag[]) : void;
36708
37536
  /**
36709
37537
  * Checks whether the implementation object is null.
36710
37538
  */
@@ -43320,6 +44148,23 @@ export enum ExceptionType {
43320
44148
  * Internal exception.
43321
44149
  */
43322
44150
  Internal = 24,
44151
+ /**
44152
+ * Invalid defined name
44153
+ */
44154
+ DefinedName = 25,
44155
+ /**
44156
+ * Invalid font
44157
+ */
44158
+ Font = 26,
44159
+ /**
44160
+ * Invalid auto filter setting.
44161
+ */
44162
+ AutoFilter = 27,
44163
+ /**
44164
+ * Font substitution warning type
44165
+ * when a font has not been found, this warning type can be get.
44166
+ */
44167
+ FontSubstitution = 28,
43323
44168
  }
43324
44169
 
43325
44170
  /**
@@ -44210,6 +45055,14 @@ export enum FilterOperatorType {
44210
45055
  * Not contains the text.
44211
45056
  */
44212
45057
  NotContains = 10,
45058
+ /**
45059
+ * Not begins with the text.
45060
+ */
45061
+ NotBeginsWith = 11,
45062
+ /**
45063
+ * Not ends with the text.
45064
+ */
45065
+ NotEndsWith = 12,
44213
45066
  }
44214
45067
 
44215
45068
  /**
@@ -49507,25 +50360,6 @@ export class Protection {
49507
50360
  * @param value - The value to set.
49508
50361
  */
49509
50362
  setAllowEditingScenario(value: boolean) : void;
49510
- /**
49511
- * Represents the password to protect the worksheet.
49512
- *
49513
- * @remarks
49514
- * 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.
49515
- */
49516
- getPassword() : string;
49517
- /**
49518
- * Represents the password to protect the worksheet.
49519
- * @param value - The value to set.
49520
- *
49521
- * @remarks
49522
- * 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.
49523
- */
49524
- setPassword(value: string) : void;
49525
- /**
49526
- * Indicates whether the worksheets is protected with password.
49527
- */
49528
- isProtectedWithPassword() : boolean;
49529
50363
  /**
49530
50364
  * Represents if the user is allowed to select locked cells on a protected worksheet.
49531
50365
  */
@@ -49544,20 +50378,43 @@ export class Protection {
49544
50378
  * @param value - The value to set.
49545
50379
  */
49546
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;
49547
50404
  /**
49548
50405
  * Copy protection info.
49549
50406
  * @param source -
49550
50407
  */
49551
50408
  copy(source: Protection) : void;
49552
- /**
49553
- * Gets the hash of current password.
49554
- */
49555
- getPasswordHash() : number;
49556
50409
  /**
49557
50410
  * Verifies password.
49558
50411
  * @param password - The password.
49559
50412
  */
49560
50413
  verifyPassword(password: string) : boolean;
50414
+ /**
50415
+ * Gets the hash of current password.
50416
+ */
50417
+ getPasswordHash() : number;
49561
50418
  /**
49562
50419
  * Checks whether the implementation object is null.
49563
50420
  */
@@ -49790,6 +50647,19 @@ export class SaveOptions {
49790
50647
  * Gets or sets warning callback.
49791
50648
  */
49792
50649
  getWarningCallback() : IWarningCallback;
50650
+ /**
50651
+ * Whether check restriction of excel file when user modify cells related objects.
50652
+ * For example, excel does not allow inputting string value longer than 32K.
50653
+ * When you input a value longer than 32K, it will be truncated.
50654
+ */
50655
+ getCheckExcelRestriction() : boolean;
50656
+ /**
50657
+ * Whether check restriction of excel file when user modify cells related objects.
50658
+ * For example, excel does not allow inputting string value longer than 32K.
50659
+ * When you input a value longer than 32K, it will be truncated.
50660
+ * @param value - The value to set.
50661
+ */
50662
+ setCheckExcelRestriction(value: boolean) : void;
49793
50663
  /**
49794
50664
  * Indicates whether updating smart art setting.
49795
50665
  * The default value is false.