aspose.cells.node 25.4.0 → 25.5.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/package.json +6 -6
- package/types.d.ts +202 -74
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aspose.cells.node",
|
|
3
|
-
"version": "25.
|
|
3
|
+
"version": "25.5.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,10 +35,10 @@
|
|
|
35
35
|
"license": "Commercial",
|
|
36
36
|
"homepage": "https://www.aspose.com",
|
|
37
37
|
"optionalDependencies": {
|
|
38
|
-
"aspose.cells.node.win32.x64": "~25.
|
|
39
|
-
"aspose.cells.node.linux.x64": "~25.
|
|
40
|
-
"aspose.cells.node.linux.arm64": "~25.
|
|
41
|
-
"aspose.cells.node.darwin.x64": "~25.
|
|
42
|
-
"aspose.cells.node.darwin.arm64": "~25.
|
|
38
|
+
"aspose.cells.node.win32.x64": "~25.5.0",
|
|
39
|
+
"aspose.cells.node.linux.x64": "~25.5.0",
|
|
40
|
+
"aspose.cells.node.linux.arm64": "~25.5.0",
|
|
41
|
+
"aspose.cells.node.darwin.x64": "~25.5.0",
|
|
42
|
+
"aspose.cells.node.darwin.arm64": "~25.5.0"
|
|
43
43
|
}
|
|
44
44
|
}
|
package/types.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ export abstract class AbstractInterruptMonitor {
|
|
|
15
15
|
* Default is false, that is, when <see cref="IsInterruptionRequested"/> is true,
|
|
16
16
|
* a <see cref="CellsException"/> with code <see cref="ExceptionType.Interrupted"/> will be thrown.
|
|
17
17
|
*/
|
|
18
|
-
|
|
18
|
+
getTerminateWithoutException() : boolean;
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
/**
|
|
@@ -464,12 +464,12 @@ export abstract class AbstractFormulaChangeMonitor {
|
|
|
464
464
|
* @param rowIndex - The row index of the changed cell
|
|
465
465
|
* @param columnIndex - The column index of the changed cell
|
|
466
466
|
*/
|
|
467
|
-
|
|
467
|
+
onCellFormulaChanged(sheetIndex: number, rowIndex: number, columnIndex: number) : void;
|
|
468
468
|
/**
|
|
469
469
|
* The event that will be triggered when the formula of FormatCondition is changed.
|
|
470
470
|
* @param fc - The FormatCondition object whose formula is changed
|
|
471
471
|
*/
|
|
472
|
-
|
|
472
|
+
onFormatConditionFormulaChanged(fc: FormatCondition) : void;
|
|
473
473
|
}
|
|
474
474
|
|
|
475
475
|
/**
|
|
@@ -708,7 +708,7 @@ export class ChartCalculateOptions {
|
|
|
708
708
|
/**
|
|
709
709
|
* Represents the globalization settings for chart.
|
|
710
710
|
*/
|
|
711
|
-
export
|
|
711
|
+
export class ChartGlobalizationSettings {
|
|
712
712
|
/**
|
|
713
713
|
* Default Constructor.
|
|
714
714
|
*/
|
|
@@ -716,35 +716,35 @@ export abstract class ChartGlobalizationSettings {
|
|
|
716
716
|
/**
|
|
717
717
|
* Gets the name of Series in the Chart.
|
|
718
718
|
*/
|
|
719
|
-
|
|
719
|
+
getSeriesName() : string;
|
|
720
720
|
/**
|
|
721
721
|
* Gets the name of Chart Title.
|
|
722
722
|
*/
|
|
723
|
-
|
|
723
|
+
getChartTitleName() : string;
|
|
724
724
|
/**
|
|
725
725
|
* Gets the name of increase for Legend.
|
|
726
726
|
*/
|
|
727
|
-
|
|
727
|
+
getLegendIncreaseName() : string;
|
|
728
728
|
/**
|
|
729
729
|
* Gets the name of Decrease for Legend.
|
|
730
730
|
*/
|
|
731
|
-
|
|
731
|
+
getLegendDecreaseName() : string;
|
|
732
732
|
/**
|
|
733
733
|
* Gets the name of Total for Legend.
|
|
734
734
|
*/
|
|
735
|
-
|
|
735
|
+
getLegendTotalName() : string;
|
|
736
736
|
/**
|
|
737
737
|
* Gets the name of Title for Axis.
|
|
738
738
|
*/
|
|
739
|
-
|
|
739
|
+
getAxisTitleName() : string;
|
|
740
740
|
/**
|
|
741
741
|
* Gets the name of "Other" labels for Chart.
|
|
742
742
|
*/
|
|
743
|
-
|
|
743
|
+
getOtherName() : string;
|
|
744
744
|
/**
|
|
745
745
|
* Gets the Name of Axis Unit.
|
|
746
746
|
*/
|
|
747
|
-
|
|
747
|
+
getAxisUnitName(type: DisplayUnitType) : string;
|
|
748
748
|
}
|
|
749
749
|
|
|
750
750
|
/**
|
|
@@ -2075,7 +2075,7 @@ export enum ExternalConnectionClassType {
|
|
|
2075
2075
|
/**
|
|
2076
2076
|
* Definition of custom function for calculating with user's custom engine.
|
|
2077
2077
|
*/
|
|
2078
|
-
export
|
|
2078
|
+
export class CustomFunctionDefinition {
|
|
2079
2079
|
/**
|
|
2080
2080
|
* Default Constructor.
|
|
2081
2081
|
*/
|
|
@@ -2092,7 +2092,7 @@ export abstract class CustomFunctionDefinition {
|
|
|
2092
2092
|
* Generally in value mode it will be calculated to a single value according to current cell base.
|
|
2093
2093
|
* But in array mode, all values of A1+B1,A2+B2,A3+B3,... will be calculated and used for the calculation.
|
|
2094
2094
|
*/
|
|
2095
|
-
|
|
2095
|
+
getArrayModeParameters(functionName: string) : number[];
|
|
2096
2096
|
}
|
|
2097
2097
|
|
|
2098
2098
|
/**
|
|
@@ -4507,6 +4507,21 @@ export class PaginatedSaveOptions extends SaveOptions {
|
|
|
4507
4507
|
* Default is Dotted type.
|
|
4508
4508
|
*/
|
|
4509
4509
|
setGridlineType(value: GridlineType) : void;
|
|
4510
|
+
/**
|
|
4511
|
+
* Gets or sets gridline colr.
|
|
4512
|
+
*
|
|
4513
|
+
* @remarks
|
|
4514
|
+
* It will ignore the gridline color settings in the source file.
|
|
4515
|
+
*/
|
|
4516
|
+
getGridlineColor() : Color;
|
|
4517
|
+
/**
|
|
4518
|
+
* Gets or sets gridline colr.
|
|
4519
|
+
* @param value - The value to set.
|
|
4520
|
+
*
|
|
4521
|
+
* @remarks
|
|
4522
|
+
* It will ignore the gridline color settings in the source file.
|
|
4523
|
+
*/
|
|
4524
|
+
setGridlineColor(value: Color) : void;
|
|
4510
4525
|
/**
|
|
4511
4526
|
* Gets or sets displaying text type when the text width is larger than cell width.
|
|
4512
4527
|
*/
|
|
@@ -8155,7 +8170,7 @@ export class XmlSaveOptions extends SaveOptions {
|
|
|
8155
8170
|
/**
|
|
8156
8171
|
* Represents the globalization settings for pivot tables.
|
|
8157
8172
|
*/
|
|
8158
|
-
export
|
|
8173
|
+
export class PivotGlobalizationSettings {
|
|
8159
8174
|
/**
|
|
8160
8175
|
* Default Constructor.
|
|
8161
8176
|
*/
|
|
@@ -8166,25 +8181,25 @@ export abstract class PivotGlobalizationSettings {
|
|
|
8166
8181
|
* @returns
|
|
8167
8182
|
* The text of "Total" label
|
|
8168
8183
|
*/
|
|
8169
|
-
|
|
8184
|
+
getTextOfTotal() : string;
|
|
8170
8185
|
/**
|
|
8171
8186
|
* Gets the text of "Grand Total" label in the PivotTable.
|
|
8172
8187
|
* @returns
|
|
8173
8188
|
* The text of "Grand Total" label
|
|
8174
8189
|
*/
|
|
8175
|
-
|
|
8190
|
+
getTextOfGrandTotal() : string;
|
|
8176
8191
|
/**
|
|
8177
8192
|
* Gets the text of "(Multiple Items)" label in the PivotTable.
|
|
8178
8193
|
* @returns
|
|
8179
8194
|
* The text of "(Multiple Items)" label
|
|
8180
8195
|
*/
|
|
8181
|
-
|
|
8196
|
+
getTextOfMultipleItems() : string;
|
|
8182
8197
|
/**
|
|
8183
8198
|
* Gets the text of "(All)" label in the PivotTable.
|
|
8184
8199
|
* @returns
|
|
8185
8200
|
* The text of "(All)" label
|
|
8186
8201
|
*/
|
|
8187
|
-
|
|
8202
|
+
getTextOfAll() : string;
|
|
8188
8203
|
/**
|
|
8189
8204
|
* Gets the text for specified protected name.
|
|
8190
8205
|
* @param protectedName - The protected name in PivotTable.
|
|
@@ -8195,78 +8210,78 @@ export abstract class PivotGlobalizationSettings {
|
|
|
8195
8210
|
* In Ms Excel, some names are not allowed to be used as the name of PivotFields in PivotTable.
|
|
8196
8211
|
* They are different in different region, user may specify them explicitly according to the used region.
|
|
8197
8212
|
*/
|
|
8198
|
-
|
|
8213
|
+
getTextOfProtectedName(protectedName: string) : string;
|
|
8199
8214
|
/**
|
|
8200
8215
|
* Gets the text of "Column Labels" label in the PivotTable.
|
|
8201
8216
|
* @returns
|
|
8202
8217
|
* The text of column labels
|
|
8203
8218
|
*/
|
|
8204
|
-
|
|
8219
|
+
getTextOfColumnLabels() : string;
|
|
8205
8220
|
/**
|
|
8206
8221
|
* Gets the text of "Row Labels" label in the PivotTable.
|
|
8207
8222
|
* @returns
|
|
8208
8223
|
* The text of row labels
|
|
8209
8224
|
*/
|
|
8210
|
-
|
|
8225
|
+
getTextOfRowLabels() : string;
|
|
8211
8226
|
/**
|
|
8212
8227
|
* Gets the text of "(blank)" label in the PivotTable.
|
|
8213
8228
|
* @returns
|
|
8214
8229
|
* The text of empty data
|
|
8215
8230
|
*/
|
|
8216
|
-
|
|
8231
|
+
getTextOfEmptyData() : string;
|
|
8217
8232
|
/**
|
|
8218
8233
|
* Gets the the text of the value area field header in the PivotTable.
|
|
8219
8234
|
* @returns
|
|
8220
8235
|
* The text of data field header name
|
|
8221
8236
|
*/
|
|
8222
|
-
|
|
8237
|
+
getTextOfDataFieldHeader() : string;
|
|
8223
8238
|
/**
|
|
8224
8239
|
* Gets all short formatted string of 12 months.
|
|
8225
8240
|
*/
|
|
8226
|
-
|
|
8241
|
+
getShortTextOf12Months() : string[];
|
|
8227
8242
|
/**
|
|
8228
8243
|
* Gets the local text of 4 Quaters.
|
|
8229
8244
|
*/
|
|
8230
|
-
|
|
8245
|
+
getTextOf4Quaters() : string[];
|
|
8231
8246
|
/**
|
|
8232
8247
|
* Gets the local text of "Years".
|
|
8233
8248
|
*/
|
|
8234
|
-
|
|
8249
|
+
getTextOfYears() : string;
|
|
8235
8250
|
/**
|
|
8236
8251
|
* Get the local text of "Quarters".
|
|
8237
8252
|
*/
|
|
8238
|
-
|
|
8253
|
+
getTextOfQuarters() : string;
|
|
8239
8254
|
/**
|
|
8240
8255
|
* Gets the local text of "Months".
|
|
8241
8256
|
*/
|
|
8242
|
-
|
|
8257
|
+
getTextOfMonths() : string;
|
|
8243
8258
|
/**
|
|
8244
8259
|
* Gets the local text of "Days".
|
|
8245
8260
|
*/
|
|
8246
|
-
|
|
8261
|
+
getTextOfDays() : string;
|
|
8247
8262
|
/**
|
|
8248
8263
|
* Gets the local text of "Hours".
|
|
8249
8264
|
*/
|
|
8250
|
-
|
|
8265
|
+
getTextOfHours() : string;
|
|
8251
8266
|
/**
|
|
8252
8267
|
* Gets the local text of "Minutes".
|
|
8253
8268
|
*/
|
|
8254
|
-
|
|
8269
|
+
getTextOfMinutes() : string;
|
|
8255
8270
|
/**
|
|
8256
8271
|
* Gets the local text of "Seconds"
|
|
8257
8272
|
*/
|
|
8258
|
-
|
|
8273
|
+
getTextOfSeconds() : string;
|
|
8259
8274
|
/**
|
|
8260
8275
|
* Gets the local text of "Range"
|
|
8261
8276
|
*/
|
|
8262
|
-
|
|
8277
|
+
getTextOfRange() : string;
|
|
8263
8278
|
/**
|
|
8264
8279
|
* Gets the text of <see cref="PivotFieldSubtotalType"/> type in the PivotTable.
|
|
8265
8280
|
* @param subTotalType - The <see cref="PivotFieldSubtotalType"/>
|
|
8266
8281
|
* @returns
|
|
8267
8282
|
* The text of given type
|
|
8268
8283
|
*/
|
|
8269
|
-
|
|
8284
|
+
getTextOfSubTotal(subTotalType: PivotFieldSubtotalType) : string;
|
|
8270
8285
|
}
|
|
8271
8286
|
|
|
8272
8287
|
/**
|
|
@@ -8737,7 +8752,7 @@ export abstract class AbstractCalculationEngine {
|
|
|
8737
8752
|
* Generally the literal text is not needed for calculating formulas
|
|
8738
8753
|
* and this property should be kept as false for most implementations to get better performance.
|
|
8739
8754
|
*/
|
|
8740
|
-
|
|
8755
|
+
isParamLiteralRequired() : boolean;
|
|
8741
8756
|
/**
|
|
8742
8757
|
* Indicates whether this engine needs the parameter to be calculated in array mode. Default value is false.
|
|
8743
8758
|
* If <see cref="CalculationData.GetParamValueInArrayMode(int, int, int)"/> is required when calculating custom
|
|
@@ -8752,7 +8767,7 @@ export abstract class AbstractCalculationEngine {
|
|
|
8752
8767
|
* For performance consideration, please keep this property as the default value(false)
|
|
8753
8768
|
* if there is no special requirement.
|
|
8754
8769
|
*/
|
|
8755
|
-
|
|
8770
|
+
isParamArrayModeRequired() : boolean;
|
|
8756
8771
|
/**
|
|
8757
8772
|
* Whether built-in functions that have been supported by the built-in engine
|
|
8758
8773
|
* should be checked and processed by this implementation.
|
|
@@ -8762,7 +8777,7 @@ export abstract class AbstractCalculationEngine {
|
|
|
8762
8777
|
* If user needs to change the calculation logic of some built-in functions, this property should be set as true.
|
|
8763
8778
|
* Otherwise please leave this property as false for performance consideration.
|
|
8764
8779
|
*/
|
|
8765
|
-
|
|
8780
|
+
getProcessBuiltInFunctions() : boolean;
|
|
8766
8781
|
/**
|
|
8767
8782
|
* Calculates one function with given data.
|
|
8768
8783
|
* @param data - the required data to calculate function such as function name, parameters, ...etc.
|
|
@@ -8789,7 +8804,7 @@ export abstract class AbstractCalculationEngine {
|
|
|
8789
8804
|
* And for <see cref="Calculate(CalculationData)"/>, the given <see cref="CalculationData.CalculatedValue"/>
|
|
8790
8805
|
* may have been initialized with the cached value of previous calculation.
|
|
8791
8806
|
*/
|
|
8792
|
-
|
|
8807
|
+
forceRecalculate(functionName: string) : boolean;
|
|
8793
8808
|
}
|
|
8794
8809
|
|
|
8795
8810
|
/**
|
|
@@ -8921,7 +8936,7 @@ export class CalculationData {
|
|
|
8921
8936
|
/**
|
|
8922
8937
|
* Represents the globalization settings.
|
|
8923
8938
|
*/
|
|
8924
|
-
export
|
|
8939
|
+
export class GlobalizationSettings {
|
|
8925
8940
|
/**
|
|
8926
8941
|
* Default Constructor.
|
|
8927
8942
|
*/
|
|
@@ -8947,29 +8962,29 @@ export abstract class GlobalizationSettings {
|
|
|
8947
8962
|
/**
|
|
8948
8963
|
* Gets the separator for list, parameters of function, ...etc.
|
|
8949
8964
|
*/
|
|
8950
|
-
|
|
8965
|
+
getListSeparator() : string;
|
|
8951
8966
|
/**
|
|
8952
8967
|
* Gets the separator for rows in array data in formula.
|
|
8953
8968
|
*/
|
|
8954
|
-
|
|
8969
|
+
getRowSeparatorOfFormulaArray() : string;
|
|
8955
8970
|
/**
|
|
8956
8971
|
* Gets the separator for the items in array's row data in formula.
|
|
8957
8972
|
*/
|
|
8958
|
-
|
|
8973
|
+
getColumnSeparatorOfFormulaArray() : string;
|
|
8959
8974
|
/**
|
|
8960
8975
|
* Gets the total name of the function.
|
|
8961
8976
|
* @param functionType - The function type.
|
|
8962
8977
|
* @returns
|
|
8963
8978
|
* The total name of the function.
|
|
8964
8979
|
*/
|
|
8965
|
-
|
|
8980
|
+
getTotalName(functionType: ConsolidationFunction) : string;
|
|
8966
8981
|
/**
|
|
8967
8982
|
* Gets the grand total name of the function.
|
|
8968
8983
|
* @param functionType - The function type.
|
|
8969
8984
|
* @returns
|
|
8970
8985
|
* The grand total name of the function.
|
|
8971
8986
|
*/
|
|
8972
|
-
|
|
8987
|
+
getGrandTotalName(functionType: ConsolidationFunction) : string;
|
|
8973
8988
|
/**
|
|
8974
8989
|
* Gets the default sheet name for adding worksheet automatically.
|
|
8975
8990
|
* Default is "Sheet".
|
|
@@ -8982,96 +8997,96 @@ export abstract class GlobalizationSettings {
|
|
|
8982
8997
|
* For example, for Germany user maybe wants the sheet name to be "Tabellenblatt2" instead of "Sheet2".
|
|
8983
8998
|
* Then user may implement this method to return "Tabellenblatt".
|
|
8984
8999
|
*/
|
|
8985
|
-
|
|
9000
|
+
getDefaultSheetName() : string;
|
|
8986
9001
|
/**
|
|
8987
9002
|
* Gets the type name of table rows that consists of the table header.
|
|
8988
9003
|
* Default is "Headers", so in formula "#Headers" represents the table header.
|
|
8989
9004
|
* @returns
|
|
8990
9005
|
* the type name of table rows
|
|
8991
9006
|
*/
|
|
8992
|
-
|
|
9007
|
+
getTableRowTypeOfHeaders() : string;
|
|
8993
9008
|
/**
|
|
8994
9009
|
* Gets the type name of table rows that consists of data region of referenced table.
|
|
8995
9010
|
* Default is "Data", so in formula "#Data" represents the data region of the table.
|
|
8996
9011
|
* @returns
|
|
8997
9012
|
* the type name of table rows
|
|
8998
9013
|
*/
|
|
8999
|
-
|
|
9014
|
+
getTableRowTypeOfData() : string;
|
|
9000
9015
|
/**
|
|
9001
9016
|
* Gets the type name of table rows that consists of all rows in referenced table.
|
|
9002
9017
|
* Default is "All", so in formula "#All" represents all rows in referenced table.
|
|
9003
9018
|
* @returns
|
|
9004
9019
|
* the type name of table rows
|
|
9005
9020
|
*/
|
|
9006
|
-
|
|
9021
|
+
getTableRowTypeOfAll() : string;
|
|
9007
9022
|
/**
|
|
9008
9023
|
* Gets the type name of table rows that consists of the total row of referenced table.
|
|
9009
9024
|
* Default is "Totals", so in formula "#Totals" represents the total row of referenced table.
|
|
9010
9025
|
* @returns
|
|
9011
9026
|
* the type name of table rows
|
|
9012
9027
|
*/
|
|
9013
|
-
|
|
9028
|
+
getTableRowTypeOfTotals() : string;
|
|
9014
9029
|
/**
|
|
9015
9030
|
* Gets the type name of table rows that consists of the current row in referenced table.
|
|
9016
9031
|
* Default is "This Row", so in formula "#This Row" represents the current row in referenced table.
|
|
9017
9032
|
* @returns
|
|
9018
9033
|
* the type name of table rows
|
|
9019
9034
|
*/
|
|
9020
|
-
|
|
9035
|
+
getTableRowTypeOfCurrent() : string;
|
|
9021
9036
|
/**
|
|
9022
9037
|
* Gets the display string value for cell's error value
|
|
9023
9038
|
* @param err - error values such as #VALUE!,#NAME?
|
|
9024
9039
|
* @returns
|
|
9025
9040
|
* By default returns the error value itself
|
|
9026
9041
|
*/
|
|
9027
|
-
|
|
9042
|
+
getErrorValueString(err: string) : string;
|
|
9028
9043
|
/**
|
|
9029
9044
|
* Gets the display string value for cell's boolean value
|
|
9030
9045
|
* @param bv - boolean value
|
|
9031
9046
|
* @returns
|
|
9032
9047
|
* By default returns "TRUE" for true value and "FALSE" for false value.
|
|
9033
9048
|
*/
|
|
9034
|
-
|
|
9049
|
+
getBooleanValueString(bv: boolean) : string;
|
|
9035
9050
|
/**
|
|
9036
9051
|
* Gets the locale dependent function name according to given standard function name.
|
|
9037
9052
|
* @param standardName - Standard(en-US locale) function name.
|
|
9038
9053
|
* @returns
|
|
9039
9054
|
* Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
|
|
9040
9055
|
*/
|
|
9041
|
-
|
|
9056
|
+
getLocalFunctionName(standardName: string) : string;
|
|
9042
9057
|
/**
|
|
9043
9058
|
* Gets the standard function name according to given locale dependent function name.
|
|
9044
9059
|
* @param localName - Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
|
|
9045
9060
|
* @returns
|
|
9046
9061
|
* Standard(en-US locale) function name.
|
|
9047
9062
|
*/
|
|
9048
|
-
|
|
9063
|
+
getStandardFunctionName(localName: string) : string;
|
|
9049
9064
|
/**
|
|
9050
9065
|
* Gets the locale dependent text for built-in Name according to given standard text.
|
|
9051
9066
|
* @param standardName - Standard(en-US locale) text of built-in Name.
|
|
9052
9067
|
* @returns
|
|
9053
9068
|
* Locale dependent text. The locale was specified by the Workbook for which this settings is used.
|
|
9054
9069
|
*/
|
|
9055
|
-
|
|
9070
|
+
getLocalBuiltInName(standardName: string) : string;
|
|
9056
9071
|
/**
|
|
9057
9072
|
* Gets the standard text of built-in Name according to given locale dependent text.
|
|
9058
9073
|
* @param localName - Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used.
|
|
9059
9074
|
* @returns
|
|
9060
9075
|
* Standard(en-US locale) text.
|
|
9061
9076
|
*/
|
|
9062
|
-
|
|
9077
|
+
getStandardBuiltInName(localName: string) : string;
|
|
9063
9078
|
/**
|
|
9064
9079
|
* Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
|
|
9065
9080
|
* @param localfontStyleName - Locale font style name for Header/Footer.
|
|
9066
9081
|
* @returns
|
|
9067
9082
|
* Standard English font style name(Regular, Bold, Italic)
|
|
9068
9083
|
*/
|
|
9069
|
-
|
|
9084
|
+
getStandardHeaderFooterFontStyleName(localfontStyleName: string) : string;
|
|
9070
9085
|
/**
|
|
9071
9086
|
* Gets the locale dependent comment title name according to comment title type.
|
|
9072
9087
|
* @param type -
|
|
9073
9088
|
*/
|
|
9074
|
-
|
|
9089
|
+
getCommentTitleName(type: CommentTitleType) : string;
|
|
9075
9090
|
/**
|
|
9076
9091
|
* Compares two string values according to certain collation rules.
|
|
9077
9092
|
* @param v1 - the first string
|
|
@@ -9080,7 +9095,7 @@ export abstract class GlobalizationSettings {
|
|
|
9080
9095
|
* @returns
|
|
9081
9096
|
* Integer that indicates the lexical relationship between the two comparands
|
|
9082
9097
|
*/
|
|
9083
|
-
|
|
9098
|
+
compare(v1: string, v2: string, ignoreCase: boolean) : number;
|
|
9084
9099
|
}
|
|
9085
9100
|
|
|
9086
9101
|
/**
|
|
@@ -10602,6 +10617,13 @@ export class Cells {
|
|
|
10602
10617
|
* last row index.
|
|
10603
10618
|
*/
|
|
10604
10619
|
getLastDataRow(column: number) : number;
|
|
10620
|
+
/**
|
|
10621
|
+
* Gets the first row index of cell which contains data in the specified column.
|
|
10622
|
+
* @param column - Column index.
|
|
10623
|
+
* @returns
|
|
10624
|
+
* first row index.
|
|
10625
|
+
*/
|
|
10626
|
+
getFirstDataRow(column: number) : number;
|
|
10605
10627
|
/**
|
|
10606
10628
|
* Applies formats for a whole column.
|
|
10607
10629
|
* @param column - The column index.
|
|
@@ -12650,6 +12672,27 @@ export class Range {
|
|
|
12650
12672
|
* @param saveOptions - Options for coverting range to html.
|
|
12651
12673
|
*/
|
|
12652
12674
|
toHtml(saveOptions: HtmlSaveOptions) : Uint8Array;
|
|
12675
|
+
/**
|
|
12676
|
+
* Clears this range.
|
|
12677
|
+
*/
|
|
12678
|
+
clear() : void;
|
|
12679
|
+
/**
|
|
12680
|
+
* Clears the contents of this range.
|
|
12681
|
+
*/
|
|
12682
|
+
clearContents() : void;
|
|
12683
|
+
/**
|
|
12684
|
+
* Clears the formats of this range.
|
|
12685
|
+
*/
|
|
12686
|
+
clearFormats() : void;
|
|
12687
|
+
/**
|
|
12688
|
+
* Clears the comments of this range.
|
|
12689
|
+
*/
|
|
12690
|
+
clearComments() : void;
|
|
12691
|
+
/**
|
|
12692
|
+
* Only removes hyperlinks.
|
|
12693
|
+
* @param clearFormat - Indicates whether to clear the format of hyperlinks.
|
|
12694
|
+
*/
|
|
12695
|
+
clearHyperlinks(clearFormat: boolean) : void;
|
|
12653
12696
|
/**
|
|
12654
12697
|
* Checks whether the implementation object is null.
|
|
12655
12698
|
*/
|
|
@@ -13027,6 +13070,27 @@ export class MarkdownSaveOptions extends SaveOptions {
|
|
|
13027
13070
|
* The set is ignored when it is used in <see cref="SheetRender"/>
|
|
13028
13071
|
*/
|
|
13029
13072
|
setSheetSet(value: SheetSet) : void;
|
|
13073
|
+
/**
|
|
13074
|
+
* Get the ImageOrPrintOptions object before exporting
|
|
13075
|
+
*/
|
|
13076
|
+
getImageOptions() : ImageOrPrintOptions;
|
|
13077
|
+
/**
|
|
13078
|
+
* Specifies whether images are saved in Base64 format to Markdown.
|
|
13079
|
+
*
|
|
13080
|
+
* @remarks
|
|
13081
|
+
* When this property is set to true image data is exported directly on the
|
|
13082
|
+
* img elements and separate files are not created.
|
|
13083
|
+
*/
|
|
13084
|
+
getExportImagesAsBase64() : boolean;
|
|
13085
|
+
/**
|
|
13086
|
+
* Specifies whether images are saved in Base64 format to Markdown.
|
|
13087
|
+
* @param value - The value to set.
|
|
13088
|
+
*
|
|
13089
|
+
* @remarks
|
|
13090
|
+
* When this property is set to true image data is exported directly on the
|
|
13091
|
+
* img elements and separate files are not created.
|
|
13092
|
+
*/
|
|
13093
|
+
setExportImagesAsBase64(value: boolean) : void;
|
|
13030
13094
|
/**
|
|
13031
13095
|
* Checks whether the implementation object is null.
|
|
13032
13096
|
*/
|
|
@@ -14374,9 +14438,9 @@ export class Workbook {
|
|
|
14374
14438
|
*/
|
|
14375
14439
|
saveAsync(saveOptions: SaveOptions) : Promise<Uint8Array>;
|
|
14376
14440
|
/**
|
|
14377
|
-
* Saves Excel file to a MemoryStream object and returns it.
|
|
14441
|
+
* Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it.
|
|
14378
14442
|
* @returns
|
|
14379
|
-
* MemoryStream object which contains an Excel file.
|
|
14443
|
+
* MemoryStream object which contains an xls Excel file.
|
|
14380
14444
|
*
|
|
14381
14445
|
* @remarks
|
|
14382
14446
|
* This method provides same function as Save method and only save the workbook as Excel97-2003 xls file.
|
|
@@ -14384,9 +14448,9 @@ export class Workbook {
|
|
|
14384
14448
|
*/
|
|
14385
14449
|
saveToStream() : Uint8Array;
|
|
14386
14450
|
/**
|
|
14387
|
-
* Saves Excel file to a MemoryStream object and returns it.
|
|
14451
|
+
* Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it.
|
|
14388
14452
|
* @returns
|
|
14389
|
-
* MemoryStream object which contains an Excel file.
|
|
14453
|
+
* MemoryStream object which contains an xls Excel file.
|
|
14390
14454
|
*
|
|
14391
14455
|
* @remarks
|
|
14392
14456
|
* This method provides same function as Save method and only save the workbook as Excel97-2003 xls file.
|
|
@@ -17292,7 +17356,7 @@ export class Worksheet {
|
|
|
17292
17356
|
* @remarks
|
|
17293
17357
|
* User may specify the filter options or implement their own LoadFilter to specify how to load data.
|
|
17294
17358
|
*/
|
|
17295
|
-
export
|
|
17359
|
+
export class LoadFilter {
|
|
17296
17360
|
/**
|
|
17297
17361
|
* Default Constructor.
|
|
17298
17362
|
*/
|
|
@@ -17316,14 +17380,14 @@ export abstract class LoadFilter {
|
|
|
17316
17380
|
* Default is null, that denotes to load all sheets in the default order in template file.
|
|
17317
17381
|
* If not null and some sheet's index is not in the returned array, then the sheet will not be loaded.
|
|
17318
17382
|
*/
|
|
17319
|
-
|
|
17383
|
+
getSheetsInLoadingOrder() : number[];
|
|
17320
17384
|
/**
|
|
17321
17385
|
* Prepares filter options before loading given worksheet.
|
|
17322
17386
|
* User's implementation of LoadFilter can change the LoadDataFilterOptions here
|
|
17323
17387
|
* to denote how to load data for this worksheet.
|
|
17324
17388
|
* @param sheet - The worksheet to be loaded. /// There are only few properties can be used for the given worksheet object here /// because most data and properties have not been loaded. The available properties are: /// Name, Index, VisibilityType
|
|
17325
17389
|
*/
|
|
17326
|
-
|
|
17390
|
+
startSheet(sheet: Worksheet) : void;
|
|
17327
17391
|
}
|
|
17328
17392
|
|
|
17329
17393
|
/**
|
|
@@ -28875,7 +28939,7 @@ export abstract class DrawObjectEventHandler {
|
|
|
28875
28939
|
* @param width - Width of DrawObject
|
|
28876
28940
|
* @param height - Height of DrawObject
|
|
28877
28941
|
*/
|
|
28878
|
-
|
|
28942
|
+
draw(drawObject: DrawObject, x: number, y: number, width: number, height: number) : void;
|
|
28879
28943
|
}
|
|
28880
28944
|
|
|
28881
28945
|
/**
|
|
@@ -29079,20 +29143,38 @@ export class ImageOrPrintOptions {
|
|
|
29079
29143
|
/**
|
|
29080
29144
|
* Indicate the filename of embedded image in svg.
|
|
29081
29145
|
* This should be full path with directory like "c:\\xpsEmbedded"
|
|
29146
|
+
*
|
|
29147
|
+
* @remarks
|
|
29148
|
+
* NOTE: This member is now obsolete. Instead,
|
|
29149
|
+
* please remove this property because images are now always embedded in Svg with base64 format.
|
|
29150
|
+
* This property will be removed 12 months later since April 2025.
|
|
29151
|
+
* Aspose apologizes for any inconvenience you may have experienced.
|
|
29082
29152
|
* @deprecated
|
|
29083
|
-
* Images are always embedded in Svg with base64 format, please remove this property.
|
|
29153
|
+
* Images are now always embedded in Svg with base64 format, please remove this property.
|
|
29084
29154
|
*/
|
|
29085
29155
|
getEmbededImageNameInSvg() : string;
|
|
29086
29156
|
/**
|
|
29087
29157
|
* Indicate the filename of embedded image in svg.
|
|
29088
29158
|
* This should be full path with directory like "c:\\xpsEmbedded"
|
|
29089
29159
|
* @param value - The value to set.
|
|
29160
|
+
*
|
|
29161
|
+
* @remarks
|
|
29162
|
+
* NOTE: This member is now obsolete. Instead,
|
|
29163
|
+
* please remove this property because images are now always embedded in Svg with base64 format.
|
|
29164
|
+
* This property will be removed 12 months later since April 2025.
|
|
29165
|
+
* Aspose apologizes for any inconvenience you may have experienced.
|
|
29090
29166
|
* @deprecated
|
|
29091
|
-
* Images are always embedded in Svg with base64 format, please remove this property.
|
|
29167
|
+
* Images are now always embedded in Svg with base64 format, please remove this property.
|
|
29092
29168
|
*/
|
|
29093
29169
|
setEmbededImageNameInSvg(value: string) : void;
|
|
29094
29170
|
/**
|
|
29095
29171
|
* if this property is true, the generated svg will fit to view port.
|
|
29172
|
+
*
|
|
29173
|
+
* @remarks
|
|
29174
|
+
* NOTE: This member is now obsolete. Instead,
|
|
29175
|
+
* please use <see cref="SvgImageOptions.FitToViewPort"/>.
|
|
29176
|
+
* This property will be removed 12 months later since April 2025.
|
|
29177
|
+
* Aspose apologizes for any inconvenience you may have experienced.
|
|
29096
29178
|
* @deprecated
|
|
29097
29179
|
* Use SvgImageOptions.FitToViewPort property instead.
|
|
29098
29180
|
*/
|
|
@@ -29100,12 +29182,24 @@ export class ImageOrPrintOptions {
|
|
|
29100
29182
|
/**
|
|
29101
29183
|
* if this property is true, the generated svg will fit to view port.
|
|
29102
29184
|
* @param value - The value to set.
|
|
29185
|
+
*
|
|
29186
|
+
* @remarks
|
|
29187
|
+
* NOTE: This member is now obsolete. Instead,
|
|
29188
|
+
* please use <see cref="SvgImageOptions.FitToViewPort"/>.
|
|
29189
|
+
* This property will be removed 12 months later since April 2025.
|
|
29190
|
+
* Aspose apologizes for any inconvenience you may have experienced.
|
|
29103
29191
|
* @deprecated
|
|
29104
29192
|
* Use SvgImageOptions.FitToViewPort property instead.
|
|
29105
29193
|
*/
|
|
29106
29194
|
setSVGFitToViewPort(value: boolean) : void;
|
|
29107
29195
|
/**
|
|
29108
29196
|
* Gets and sets the prefix of the css name in svg,the default value is empty string.
|
|
29197
|
+
*
|
|
29198
|
+
* @remarks
|
|
29199
|
+
* NOTE: This member is now obsolete. Instead,
|
|
29200
|
+
* please use <see cref="SvgImageOptions.CssPrefix"/>.
|
|
29201
|
+
* This property will be removed 12 months later since April 2025.
|
|
29202
|
+
* Aspose apologizes for any inconvenience you may have experienced.
|
|
29109
29203
|
* @deprecated
|
|
29110
29204
|
* Use SvgImageOptions.CssPrefix property instead.
|
|
29111
29205
|
*/
|
|
@@ -29113,6 +29207,12 @@ export class ImageOrPrintOptions {
|
|
|
29113
29207
|
/**
|
|
29114
29208
|
* Gets and sets the prefix of the css name in svg,the default value is empty string.
|
|
29115
29209
|
* @param value - The value to set.
|
|
29210
|
+
*
|
|
29211
|
+
* @remarks
|
|
29212
|
+
* NOTE: This member is now obsolete. Instead,
|
|
29213
|
+
* please use <see cref="SvgImageOptions.CssPrefix"/>.
|
|
29214
|
+
* This property will be removed 12 months later since April 2025.
|
|
29215
|
+
* Aspose apologizes for any inconvenience you may have experienced.
|
|
29116
29216
|
* @deprecated
|
|
29117
29217
|
* Use SvgImageOptions.CssPrefix property instead.
|
|
29118
29218
|
*/
|
|
@@ -29289,6 +29389,21 @@ export class ImageOrPrintOptions {
|
|
|
29289
29389
|
* Default is Dotted type.
|
|
29290
29390
|
*/
|
|
29291
29391
|
setGridlineType(value: GridlineType) : void;
|
|
29392
|
+
/**
|
|
29393
|
+
* Gets or sets gridline colr.
|
|
29394
|
+
*
|
|
29395
|
+
* @remarks
|
|
29396
|
+
* It will ignore the gridline color settings in the source file.
|
|
29397
|
+
*/
|
|
29398
|
+
getGridlineColor() : Color;
|
|
29399
|
+
/**
|
|
29400
|
+
* Gets or sets gridline colr.
|
|
29401
|
+
* @param value - The value to set.
|
|
29402
|
+
*
|
|
29403
|
+
* @remarks
|
|
29404
|
+
* It will ignore the gridline color settings in the source file.
|
|
29405
|
+
*/
|
|
29406
|
+
setGridlineColor(value: Color) : void;
|
|
29292
29407
|
/**
|
|
29293
29408
|
* Gets or sets displaying text type when the text width is larger than cell width.
|
|
29294
29409
|
*/
|
|
@@ -49823,6 +49938,10 @@ export class ListColumn {
|
|
|
49823
49938
|
* Gets the range of this list column.
|
|
49824
49939
|
*/
|
|
49825
49940
|
getRange() : Range;
|
|
49941
|
+
/**
|
|
49942
|
+
* Indicates whether the fomula is array formula.
|
|
49943
|
+
*/
|
|
49944
|
+
isArrayFormula() : boolean;
|
|
49826
49945
|
/**
|
|
49827
49946
|
* Gets and sets the formula of the list column.
|
|
49828
49947
|
*/
|
|
@@ -52845,6 +52964,13 @@ export class PictureCollection {
|
|
|
52845
52964
|
* The element at the specified index.
|
|
52846
52965
|
*/
|
|
52847
52966
|
get(index: number) : Picture;
|
|
52967
|
+
/**
|
|
52968
|
+
* Takes a photo of the range.
|
|
52969
|
+
* @param row - The row index of this picture.
|
|
52970
|
+
* @param column - The column index of this picture.
|
|
52971
|
+
* @param range - The area that requires photography
|
|
52972
|
+
*/
|
|
52973
|
+
camera(row: number, column: number, range: string) : number;
|
|
52848
52974
|
/**
|
|
52849
52975
|
* Adds a picture to the collection.
|
|
52850
52976
|
* @param upperLeftRow - Upper left row index.
|
|
@@ -57731,20 +57857,22 @@ export class TickLabels {
|
|
|
57731
57857
|
*/
|
|
57732
57858
|
getDisplayNumberFormat() : string;
|
|
57733
57859
|
/**
|
|
57734
|
-
* Gets and sets the distance
|
|
57860
|
+
* Gets and sets the distance of labels from the category axis.
|
|
57861
|
+
* Only for category (x) axis.
|
|
57735
57862
|
*
|
|
57736
57863
|
* @remarks
|
|
57737
57864
|
* The default distance is 100 percent, which represents the default spacing between the axis labels and the axis line.
|
|
57738
|
-
* The value can be an integer percentage from 0 through 1000, relative to the axis label
|
|
57865
|
+
* The value can be an integer percentage from 0 through 1000, relative to the axis label''s font size.
|
|
57739
57866
|
*/
|
|
57740
57867
|
getOffset() : number;
|
|
57741
57868
|
/**
|
|
57742
|
-
* Gets and sets the distance
|
|
57869
|
+
* Gets and sets the distance of labels from the category axis.
|
|
57870
|
+
* Only for category (x) axis.
|
|
57743
57871
|
* @param value - The value to set.
|
|
57744
57872
|
*
|
|
57745
57873
|
* @remarks
|
|
57746
57874
|
* The default distance is 100 percent, which represents the default spacing between the axis labels and the axis line.
|
|
57747
|
-
* The value can be an integer percentage from 0 through 1000, relative to the axis label
|
|
57875
|
+
* The value can be an integer percentage from 0 through 1000, relative to the axis label''s font size.
|
|
57748
57876
|
*/
|
|
57749
57877
|
setOffset(value: number) : void;
|
|
57750
57878
|
/**
|