You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: english/nodejs-cpp/_index.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ is_root: true
73
73
|[CheckBoxActiveXControl](./checkboxactivexcontrol)| Represents a CheckBox ActiveX control. |
74
74
|[CheckBoxCollection](./checkboxcollection)| Represents a collection of [CheckBox](../nodejs-cpp/checkbox/) objects in a worksheet. |
75
75
|[Color](./color)| Represents an ARGB (alpha, red, green, blue) color. |
76
-
|[ColorFilter](./colorfilter)| Represents filtering the range by color. |
76
+
|[ColorFilter](./colorfilter)| Represents setting for filtering the range by color. |
77
77
|[ColorHelper](./colorhelper)| Provides helper functions about color. |
78
78
|[ColorScale](./colorscale)| Describe the ColorScale conditional formatting rule. This conditional formatting rule creates a gradated color scale on the cells. |
79
79
|[Column](./column)| Represents a single column in a worksheet. |
@@ -102,7 +102,7 @@ is_root: true
102
102
|[CustomFunctionDefinition](./customfunctiondefinition)| Definition of custom function for calculating with user's custom engine. |
103
103
|[CustomGeometry](./customgeometry)| Represents a custom geometric shape. |
104
104
|[CustomPiovtFieldGroupItem](./custompiovtfieldgroupitem)| Represents an item of custom grouped field. |
|[CustomProperty](./customproperty)| Represents a custom property which store name and value pairs of arbitrary user-defined data for worksheet. |
106
106
|[CustomPropertyCollection](./custompropertycollection)| A collection of [CustomProperty](../nodejs-cpp/customproperty/) objects that represent additional information. |
107
107
|[CustomRenderSettings](./customrendersettings)| Represents custom settings during rendering. |
108
108
|[CustomXmlPart](./customxmlpart)| Represents a Custom XML Data Storage Part (custom XML data within a package). |
@@ -160,7 +160,7 @@ is_root: true
160
160
|[FileFormatInfo](./fileformatinfo)| Contains data returned by [FileFormatUtil](../nodejs-cpp/fileformatutil/) file format detection methods. |
161
161
|[FileFormatUtil](./fileformatutil)| Provides utility methods for converting file format enums to strings or file extensions and back. |
162
162
|[FillFormat](./fillformat)| Encapsulates the object that represents fill formatting for a shape. |
163
-
|[FilterColumn](./filtercolumn)| Represents a filter for a single column. The Filter object is a member of the Filters collection |
163
+
|[FilterColumn](./filtercolumn)| Represents a filter for a single column. |
164
164
|[FilterColumnCollection](./filtercolumncollection)| A collection of Filter objects that represents all the filters in an autofiltered range. |
|[Floor](./floor)| Encapsulates the object that represents the floor of a 3-D chart. |
@@ -227,8 +227,8 @@ is_root: true
227
227
|[ListBox](./listbox)| Represents a list box object. |
228
228
|[ListBoxActiveXControl](./listboxactivexcontrol)| Represents a ListBox ActiveX control. |
229
229
|[ListColumn](./listcolumn)| Represents a column in a Table. |
230
-
|[ListColumnCollection](./listcolumncollection)| Represents A collection of all the [ListColumn](../nodejs-cpp/listcolumn/) objects in the specified ListObject object. |
231
-
|[ListObject](./listobject)| Represents a list object on a worksheet. The ListObject object is a member of the ListObjects collection. The ListObjects collection contains all the list objects on a worksheet. |
230
+
|[ListColumnCollection](./listcolumncollection)| Represents a list of all the [ListColumn](../nodejs-cpp/listcolumn/) objects in the table. |
231
+
|[ListObject](./listobject)| Represents a table in a worksheet. |
232
232
|[ListObjectCollection](./listobjectcollection)| Represents a collection of [ListObject](../nodejs-cpp/listobject/) objects in the worksheet. |
233
233
|[LoadFilter](./loadfilter)| Represents the filter that provides options for loading data when loading workbook from template. |
234
234
|[LoadOptions](./loadoptions)| Represents the options of loading the file. |
@@ -301,20 +301,20 @@ is_root: true
301
301
|[PivotField](./pivotfield)| Represents a field in a PivotTable report. |
302
302
|[PivotFieldCollection](./pivotfieldcollection)| Represents a collection of all the PivotField objects in the PivotTable's specific PivotFields type. |
303
303
|[PivotFieldGroupSettings](./pivotfieldgroupsettings)| Represents the group setting of pivot field. |
304
-
|[PivotFieldSortSetting](./pivotfieldsortsetting)| Represents the setting of sorting pivot fields. |
304
+
|[PivotFieldSortSetting](./pivotfieldsortsetting)| Represents the setting for sorting pivot fields. |
305
305
|[PivotFilter](./pivotfilter)| Represents a PivotFilter in PivotFilter Collection. |
306
-
|[PivotFilterCollection](./pivotfiltercollection)| Represents a collection of all the PivotFilter objects|
306
+
|[PivotFilterCollection](./pivotfiltercollection)| Represents a collection of all the PivotFilters.|
307
307
|[PivotFormatCondition](./pivotformatcondition)| Represents a PivotTable Format Condition in PivotFormatCondition Collection. |
308
308
|[PivotFormatConditionCollection](./pivotformatconditioncollection)| Represents PivotTable Format Conditions. |
309
309
|[PivotGlobalizationSettings](./pivotglobalizationsettings)| Represents the globalization settings for pivot tables. |
310
310
|[PivotItem](./pivotitem)| Represents a item in a PivotField report. |
311
311
|[PivotItemCollection](./pivotitemcollection)| Represents all the [PivotItem](../nodejs-cpp/pivotitem/) objects in the PivotField. |
312
312
|[PivotNumbericRangeGroupSettings](./pivotnumbericrangegroupsettings)| Represents the numberic range group of the pivot field. |
313
313
|[PivotOptions](./pivotoptions)| Represents a complex type that specifies the pivot controls that appear on the chart |
314
-
|[PivotPageFields](./pivotpagefields)| Represents the pivot page field items if the pivot table data source is consolidation ranges. It only can contain up to 4 fields. |
314
+
|[PivotPageFields](./pivotpagefields)| Represents the pivot page items if the pivot table data source is consolidation ranges. It only can contain up to 4 items. |
315
315
|[PivotShowValuesSetting](./pivotshowvaluessetting)| Represents the settings about showing values as when the ShowDataAs calculation is in use. |
316
316
|[PivotTable](./pivottable)| Summary description for PivotTable. |
317
-
|[PivotTableCalculateOption](./pivottablecalculateoption)| Rerepsents the options of calcuating the pivot table. |
317
+
|[PivotTableCalculateOption](./pivottablecalculateoption)| Rerepsents the options of calculating data of the pivot table. |
318
318
|[PivotTableCollection](./pivottablecollection)| Represents the collection of all the PivotTable objects on the specified worksheet. |
319
319
|[PivotTableFormat](./pivottableformat)| Represents the format defined in the PivotTable. |
320
320
|[PivotTableFormatCollection](./pivottableformatcollection)| Represents the collection of formats applied to PivotTable. |
@@ -430,7 +430,7 @@ is_root: true
430
430
|[SubtotalSetting](./subtotalsetting)| Represents the setting of the subtotal . |
431
431
|[SvgImageOptions](./svgimageoptions)| Options for generating Svg image. |
432
432
|[SystemTimeInterruptMonitor](./systemtimeinterruptmonitor)| Simple implementation of [AbstractInterruptMonitor](../nodejs-cpp/abstractinterruptmonitor/) by checking and comparing current system time with user specified limit. |
433
-
|[TableStyle](./tablestyle)| Represents the table style. |
433
+
|[TableStyle](./tablestyle)| Represents the style of the table. |
434
434
|[TableStyleCollection](./tablestylecollection)| Represents all custom table styles. |
435
435
|[TableStyleElement](./tablestyleelement)| Represents the element of the table style. |
436
436
|[TableStyleElementCollection](./tablestyleelementcollection)| Represents all elements of the table style. |
@@ -463,7 +463,7 @@ is_root: true
463
463
|[Title](./title)| Encapsulates the object that represents the title of chart or axis. |
464
464
|[ToggleButtonActiveXControl](./togglebuttonactivexcontrol)| Represents a ToggleButton ActiveX control. |
465
465
|[Top10](./top10)| Describe the Top10 conditional formatting rule. This conditional formatting rule highlights cells whose values fall in the top N or bottom N bracket, as specified. |
466
-
|[Top10Filter](./top10filter)| Represents the top 10 filter. |
466
+
|[Top10Filter](./top10filter)| Represents the top N (percent or number of items) to filter by. |
467
467
|[Trendline](./trendline)| Represents a trendline in a chart. |
468
468
|[TrendlineCollection](./trendlinecollection)| Represents a collection of all the [Trendline](../nodejs-cpp/trendline/) objects for the specified data series. |
469
469
|[TwoColorGradient](./twocolorgradient)| Represents two color gradient. |
@@ -642,6 +642,7 @@ is_root: true
642
642
|[HtmlFormatHandlingType](./htmlformathandlingtype)| Specifies how to handle formatting from the HTML source |
643
643
|[HtmlHiddenColDisplayType](./htmlhiddencoldisplaytype)| Represents two types of showing the hidden columns in html. |
644
644
|[HtmlHiddenRowDisplayType](./htmlhiddenrowdisplaytype)| Represents two types of showing the hidden rows in html. |
645
+
|[HtmlLayoutMode](./htmllayoutmode)| Represents the layout mode for HTML rendering. |
645
646
|[HtmlLinkTargetType](./htmllinktargettype)| Represents the type of target attribute in HTML <a/> tag. |
646
647
|[HtmlOfficeMathOutputType](./htmlofficemathoutputtype)| Represents how export OfficeMath to HTML. |
647
648
|[HtmlVersion](./htmlversion)| Indicates the version of HTML is used when saving to Html formats. |
@@ -712,7 +713,7 @@ is_root: true
712
713
|[PivotFieldGroupType](./pivotfieldgrouptype)| Represents the group type of pivot field. |
713
714
|[PivotFieldSubtotalType](./pivotfieldsubtotaltype)| Summary description for PivotFieldSubtotalType. |
714
715
|[PivotFieldType](./pivotfieldtype)| Represents PivotTable field type. |
|[PivotFilterType](./pivotfiltertype)| Represents the filter type of the pivot table. |
716
717
|[PivotGroupByType](./pivotgroupbytype)| Represents group by type. |
717
718
|[PivotItemPosition](./pivotitemposition)| Represents base item Next/Previous/All position in the base field . |
718
719
|[PivotItemPositionType](./pivotitempositiontype)| Represents the position type of the pivot base item in the base field when the ShowDataAs calculation is in use. |
Copy file name to clipboardExpand all lines: english/nodejs-cpp/abstractcalculationengine/_index.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,13 +21,27 @@ User should not modify any part of the Workbook directly in this implementation(
21
21
22
22
| Method | Description |
23
23
| --- | --- |
24
+
|[skipCalculation()](#skipCalculation--)| Skips the calculation for the entire formula that references to the function currently under evaluation. |
24
25
| abstract [isParamLiteralRequired()](#isParamLiteralRequired--)| Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false. |
25
26
| 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
27
| 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
28
| abstract [calculate(CalculationData)](#calculate-calculationdata-)| Calculates one function with given data. |
28
29
| abstract [forceRecalculate(string)](#forceRecalculate-string-)| Whether force given function to be recalculated always when calculating shared formulas. |
29
30
30
31
32
+
### skipCalculation() {#skipCalculation--}
33
+
34
+
Skips the calculation for the entire formula that references to the function currently under evaluation.
35
+
36
+
```javascript
37
+
skipCalculation() :void;
38
+
```
39
+
40
+
41
+
**Remarks**
42
+
43
+
This method can be invoked in the implementation of [Calculate(CalculationData)](../calculate(calculationdata)/) to skip the calculation for the entire formula and the original value of the formula will be kept without change.
|[name](#name--)| string | Returns or sets the name of the object. |
29
23
|[value](#value--)| string | Returns or sets the value of the custom property. |
24
+
|[binaryValue](#binaryValue--)| Uint8Array | Gets and sets the binary value of the custom property. |
30
25
31
26
## Methods
32
27
@@ -36,18 +31,11 @@ class CustomProperty;
36
31
|[setName(string)](#setName-string-)| <b>@deprecated.</b> Please use the 'name' property instead. Returns or sets the name of the object. |
37
32
|[getValue()](#getValue--)| <b>@deprecated.</b> Please use the 'value' property instead. Returns or sets the value of the custom property. |
38
33
|[setValue(string)](#setValue-string-)| <b>@deprecated.</b> Please use the 'value' property instead. Returns or sets the value of the custom property. |
34
+
|[getBinaryValue()](#getBinaryValue--)| <b>@deprecated.</b> Please use the 'binaryValue' property instead. Gets and sets the binary value of the custom property. |
35
+
|[setBinaryValue(Uint8Array)](#setBinaryValue-uint8array-)| <b>@deprecated.</b> Please use the 'binaryValue' property instead. Gets and sets the binary value of the custom property. |
39
36
|[isNull()](#isNull--)| Checks whether the implementation object is null. |
40
37
41
38
42
-
### constructor() {#constructor--}
43
-
44
-
Default Constructor.
45
-
46
-
```javascript
47
-
constructor();
48
-
```
49
-
50
-
51
39
### name {#name--}
52
40
53
41
Returns or sets the name of the object.
@@ -66,6 +54,15 @@ value : string;
66
54
```
67
55
68
56
57
+
### binaryValue {#binaryValue--}
58
+
59
+
Gets and sets the binary value of the custom property.
60
+
61
+
```javascript
62
+
binaryValue :Uint8Array;
63
+
```
64
+
65
+
69
66
### getName() {#getName--}
70
67
71
68
<b>@deprecated.</b> Please use the 'name' property instead. Returns or sets the name of the object.
0 commit comments