Skip to content

Commit bb115c5

Browse files
peytonxuasposepeytonxuaspose
authored
Merge pull request #20 from aspose-cells/main
Aspose.Cells for JavaScript via C++ v25.7 Api Reference
2 parents d16c854 + 5cd6186 commit bb115c5

File tree

801 files changed

+150566
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

801 files changed

+150566
-0
lines changed

‎english/js-cpp/_index.md‎

Lines changed: 834 additions & 0 deletions
Large diffs are not rendered by default.

‎english/js-cpp/aboveaverage/_index.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: AboveAverage
3+
second_title: Aspose.Cells for JavaScript via C++ API Reference
4+
description: Describe the AboveAverage conditional formatting rule. This conditional formatting rule highlights cells that are above or below the average for all values in the range.
5+
type: docs
6+
url: /js-cpp/aboveaverage/
7+
---
8+
9+
## AboveAverage class
10+
11+
Describe the AboveAverage conditional formatting rule. This conditional formatting rule highlights cells that are above or below the average for all values in the range.
12+
13+
```javascript
14+
class AboveAverage;
15+
```
16+
17+
18+
## Constructors
19+
20+
| Name | Description |
21+
| --- | --- |
22+
| [constructor()](#constructor--)| Default Constructor. |
23+
24+
## Properties
25+
26+
| Property | Type | Description |
27+
| --- | --- | --- |
28+
| [isAboveAverage](#isAboveAverage--)| boolean | Get or set the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true. |
29+
| [isEqualAverage](#isEqualAverage--)| boolean | Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value. 'true' indicates to include the average value in the criteria. Default value is false. |
30+
| [stdDev](#stdDev--)| number | Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0. |
31+
32+
33+
### constructor() {#constructor--}
34+
35+
Default Constructor.
36+
37+
```javascript
38+
constructor();
39+
```
40+
41+
42+
### isAboveAverage {#isAboveAverage--}
43+
44+
Get or set the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.
45+
46+
```javascript
47+
isAboveAverage : boolean;
48+
```
49+
50+
51+
### isEqualAverage {#isEqualAverage--}
52+
53+
Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value. 'true' indicates to include the average value in the criteria. Default value is false.
54+
55+
```javascript
56+
isEqualAverage : boolean;
57+
```
58+
59+
60+
### stdDev {#stdDev--}
61+
62+
Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0.
63+
64+
```javascript
65+
stdDev : number;
66+
```
67+
68+
69+

‎english/js-cpp/abstractcalculationengine/_index.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
title: AbstractCalculationEngine
3+
second_title: Aspose.Cells for JavaScript via C++ API Reference
4+
description: Represents users custom calculation engine to extend the default calculation engine of Aspose.Cells.
5+
type: docs
6+
url: /js-cpp/abstractcalculationengine/
7+
---
8+
9+
## AbstractCalculationEngine class
10+
11+
Represents user's custom calculation engine to extend the default calculation engine of Aspose.Cells.
12+
13+
```javascript
14+
abstract class AbstractCalculationEngine;
15+
```
16+
17+
### Remarks
18+
User should not modify any part of the Workbook directly in this implementation(except the calculated result of the custom function, which can be set by CalculationData.CalculatedValue property). Otherwise unexpected result or Exception may be caused. If user needs to change other data than calculated result in the implementation for some custom functions, for example, change cell's formula, style, ...etc., user should gather those data in this implementation and change them out of the scope of formula calculation.
19+
20+
## Methods
21+
22+
| Method | Description |
23+
| --- | --- |
24+
| abstract [isParamLiteralRequired()](#isParamLiteralRequired--)| Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false. |
25+
| abstract [isParamArrayModeRequired()](#isParamArrayModeRequired--)| Indicates whether this engine needs the parameter to be calculated in array mode. Default value is false. If [CalculationData.GetParamValueInArrayMode(int, int, int)](../calculationdata.getparamvalueinarraymode(int, int, int)/) is required when calculating custom functions and user has not updated the definition for them (by [Workbook.UpdateCustomFunctionDefinition(CustomFunctionDefinition)](../workbook.updatecustomfunctiondefinition(customfunctiondefinition)/)), this property needs to be set as true. |
26+
| abstract [getProcessBuiltInFunctions()](#getProcessBuiltInFunctions--)| Whether built-in functions that have been supported by the built-in engine should be checked and processed by this implementation. Default is false. |
27+
| abstract [calculate(CalculationData)](#calculate-calculationdata-)| Calculates one function with given data. |
28+
| abstract [forceRecalculate(string)](#forceRecalculate-string-)| Whether force given function to be recalculated always when calculating shared formulas. |
29+
30+
31+
### isParamLiteralRequired() {#isParamLiteralRequired--}
32+
33+
Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.
34+
35+
```javascript
36+
abstract isParamLiteralRequired() : boolean;
37+
```
38+
39+
40+
**Remarks**
41+
42+
If this custom calculation engine needs the parameter's literal text, more stacks will be required to cache the literal text for parameters and Calculate() method may be called recursively to calculate the parameter's value. Generally the literal text is not needed for calculating formulas and this property should be kept as false for most implementations to get better performance.
43+
44+
### isParamArrayModeRequired() {#isParamArrayModeRequired--}
45+
46+
Indicates whether this engine needs the parameter to be calculated in array mode. Default value is false. If [CalculationData.GetParamValueInArrayMode(int, int, int)](../calculationdata.getparamvalueinarraymode(int, int, int)/) is required when calculating custom functions and user has not updated the definition for them (by [Workbook.UpdateCustomFunctionDefinition(CustomFunctionDefinition)](../workbook.updatecustomfunctiondefinition(customfunctiondefinition)/)), this property needs to be set as true.
47+
48+
```javascript
49+
abstract isParamArrayModeRequired() : boolean;
50+
```
51+
52+
53+
**Remarks**
54+
55+
If this custom calculation engine needs the parameter to be calculated in array mode, more stacks will be required to cache the tree for parameters and Calculate() method may be called recursively to calculate the parameter's value. For performance consideration, please keep this property as the default value(false) if there is no special requirement.
56+
57+
### getProcessBuiltInFunctions() {#getProcessBuiltInFunctions--}
58+
59+
Whether built-in functions that have been supported by the built-in engine should be checked and processed by this implementation. Default is false.
60+
61+
```javascript
62+
abstract getProcessBuiltInFunctions() : boolean;
63+
```
64+
65+
66+
**Remarks**
67+
68+
If user needs to change the calculation logic of some built-in functions, this property should be set as true. Otherwise please leave this property as false for performance consideration.
69+
70+
### calculate(CalculationData) {#calculate-calculationdata-}
71+
72+
Calculates one function with given data.
73+
74+
```javascript
75+
abstract calculate(data: CalculationData) : void;
76+
```
77+
78+
**Parameters:**
79+
| Parameter | Type | Description |
80+
| --- | --- | --- |
81+
| data | [CalculationData](../calculationdata/) | the required data to calculate function such as function name, parameters, ...etc. |
82+
83+
**Remarks**
84+
85+
User should set the calculated value for given data for all functions(including excel native functions) that he wants to calculate by himself in this implementation.
86+
87+
### forceRecalculate(string) {#forceRecalculate-string-}
88+
89+
Whether force given function to be recalculated always when calculating shared formulas.
90+
91+
```javascript
92+
abstract forceRecalculate(functionName: string) : boolean;
93+
```
94+
95+
**Parameters:**
96+
| Parameter | Type | Description |
97+
| --- | --- | --- |
98+
| functionName | string | name of the function. Generally it is custom function's name. /// If [ProcessBuiltInFunctions](../processbuiltinfunctions/) is true, then built-in functions will also be checked here. |
99+
100+
**Returns**
101+
102+
true if the specified function needs to be recalculated always.
103+
104+
**Remarks**
105+
106+
For shared formulas, multiple cells share the same function. If the function's parameters keep same for those cells too, then generally this function needs to be calculated only once. So for performance consideration we only calculate such kind of function once too([Calculate(CalculationData)](../calculate(calculationdata)/) is called only once, instead of being called repeatedly for every cell). However, for user's custom implementation, maybe the function, especially the custom function, needs to be calculated differently for different cells. If so, user needs to override this method to make it return true for the function. And for [Calculate(CalculationData)](../calculate(calculationdata)/), the given [CalculationData.CalculatedValue](../calculationdata.calculatedvalue/) may have been initialized with the cached value of previous calculation.
107+
108+

‎english/js-cpp/abstractformulachangemonitor/_index.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: AbstractFormulaChangeMonitor
3+
second_title: Aspose.Cells for JavaScript via C++ API Reference
4+
description: Monitor for user to track the change of formulas during certain operations.
5+
type: docs
6+
url: /js-cpp/abstractformulachangemonitor/
7+
---
8+
9+
## AbstractFormulaChangeMonitor class
10+
11+
Monitor for user to track the change of formulas during certain operations.
12+
13+
```javascript
14+
abstract class AbstractFormulaChangeMonitor;
15+
```
16+
17+
### Remarks
18+
For example, while deleting/inserting range of cells, formulas of other cells may be changed because of the shift of references. Please note, methods in the monitor may be invoked multiple times for one object which contains the formula.
19+
20+
## Methods
21+
22+
| Method | Description |
23+
| --- | --- |
24+
| abstract [onCellFormulaChanged(number, number, number)](#onCellFormulaChanged-number-number-number-)| The event that will be triggered when the formula in a cell is changed. |
25+
| abstract [onFormatConditionFormulaChanged(FormatCondition)](#onFormatConditionFormulaChanged-formatcondition-)| The event that will be triggered when the formula of FormatCondition is changed. |
26+
27+
28+
### onCellFormulaChanged(number, number, number) {#onCellFormulaChanged-number-number-number-}
29+
30+
The event that will be triggered when the formula in a cell is changed.
31+
32+
```javascript
33+
abstract onCellFormulaChanged(sheetIndex: number, rowIndex: number, columnIndex: number) : void;
34+
```
35+
36+
**Parameters:**
37+
| Parameter | Type | Description |
38+
| --- | --- | --- |
39+
| sheetIndex | number | The sheet index of the changed cell |
40+
| rowIndex | number | The row index of the changed cell |
41+
| columnIndex | number | The column index of the changed cell |
42+
43+
### onFormatConditionFormulaChanged(FormatCondition) {#onFormatConditionFormulaChanged-formatcondition-}
44+
45+
The event that will be triggered when the formula of FormatCondition is changed.
46+
47+
```javascript
48+
abstract onFormatConditionFormulaChanged(fc: FormatCondition) : void;
49+
```
50+
51+
**Parameters:**
52+
| Parameter | Type | Description |
53+
| --- | --- | --- |
54+
| fc | [FormatCondition](../formatcondition/) | The FormatCondition object whose formula is changed |
55+
56+

‎english/js-cpp/abstractinterruptmonitor/_index.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: AbstractInterruptMonitor
3+
second_title: Aspose.Cells for JavaScript via C++ API Reference
4+
description: Monitor for interruption requests in all timeconsuming operations.
5+
type: docs
6+
url: /js-cpp/abstractinterruptmonitor/
7+
---
8+
9+
## AbstractInterruptMonitor class
10+
11+
Monitor for interruption requests in all time-consuming operations.
12+
13+
```javascript
14+
abstract class AbstractInterruptMonitor;
15+
```
16+
17+
18+
## Methods
19+
20+
| Method | Description |
21+
| --- | --- |
22+
| abstract [isInterruptionRequested()](#isInterruptionRequested--)| Indicates whether interruption is requested for current operation. If true then current operation will be interrupted. Implementation should perform fast and efficient check here, otherwise it may become another bottleneck for the procedure. |
23+
| abstract [getTerminateWithoutException()](#getTerminateWithoutException--)| When procedure is interrupted, whether terminate the procedure quietly or throw an Exception. Default is false, that is, when [IsInterruptionRequested](../isinterruptionrequested/) is true, a [CellsException](../cellsexception/) with code [ExceptionType.Interrupted](../exceptiontype.interrupted/) will be thrown. |
24+
25+
26+
### isInterruptionRequested() {#isInterruptionRequested--}
27+
28+
Indicates whether interruption is requested for current operation. If true then current operation will be interrupted. Implementation should perform fast and efficient check here, otherwise it may become another bottleneck for the procedure.
29+
30+
```javascript
31+
abstract isInterruptionRequested() : boolean;
32+
```
33+
34+
35+
### getTerminateWithoutException() {#getTerminateWithoutException--}
36+
37+
When procedure is interrupted, whether terminate the procedure quietly or throw an Exception. Default is false, that is, when [IsInterruptionRequested](../isinterruptionrequested/) is true, a [CellsException](../cellsexception/) with code [ExceptionType.Interrupted](../exceptiontype.interrupted/) will be thrown.
38+
39+
```javascript
40+
abstract getTerminateWithoutException() : boolean;
41+
```
42+
43+
44+

‎english/js-cpp/abstractlowcodeloadoptionsprovider/_index.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: AbstractLowCodeLoadOptionsProvider
3+
second_title: Aspose.Cells for JavaScript via C++ API Reference
4+
description: Implementation to provide multiple load options for processes that use multiple inputssuch as template files.
5+
type: docs
6+
url: /js-cpp/abstractlowcodeloadoptionsprovider/
7+
---
8+
9+
## AbstractLowCodeLoadOptionsProvider class
10+
11+
Implementation to provide multiple load options for processes that use multiple inputs(such as template files).
12+
13+
```javascript
14+
class AbstractLowCodeLoadOptionsProvider;
15+
```
16+
17+
### Remarks
18+
For example, [SpreadsheetMerger](../spreadsheetmerger/) feature requires multiple template files to merge.
19+
20+
## Methods
21+
22+
| Method | Description |
23+
| --- | --- |
24+
| [getCurrent()](#getCurrent--)| Gets the load options from which to load data of currently processed part. |
25+
| [moveNext()](#moveNext--)| Checks whether there is more input. |
26+
| [finish(LowCodeLoadOptions)](#finish-lowcodeloadoptions-)| Releases resources after processing currently part of input. |
27+
28+
29+
### getCurrent() {#getCurrent--}
30+
31+
Gets the load options from which to load data of currently processed part.
32+
33+
```javascript
34+
getCurrent() : LowCodeLoadOptions;
35+
```
36+
37+
38+
**Returns**
39+
40+
[LowCodeLoadOptions](../lowcodeloadoptions/)
41+
42+
### moveNext() {#moveNext--}
43+
44+
Checks whether there is more input.
45+
46+
```javascript
47+
moveNext() : boolean;
48+
```
49+
50+
51+
### finish(LowCodeLoadOptions) {#finish-lowcodeloadoptions-}
52+
53+
Releases resources after processing currently part of input.
54+
55+
```javascript
56+
finish(part: LowCodeLoadOptions) : void;
57+
```
58+
59+
**Parameters:**
60+
| Parameter | Type | Description |
61+
| --- | --- | --- |
62+
| part | [LowCodeLoadOptions](../lowcodeloadoptions/) | the load options used for currently split part. |
63+
64+
**Remarks**
65+
66+
By default this method just closes the stream specified by the [LowCodeLoadOptions.InputStream](../lowcodeloadoptions.inputstream/) directly(if the load options specified a Stream as source). User may overwrite this method to control how to release resources according to their requirement and the implementation of [Current](../current/).
67+
68+

0 commit comments

Comments
 (0)