Skip to content

Commit 8a5153d

Browse files
committed
Aspose.Cells for Node.js via C++ v25.11 Api Reference
1 parent 6efd111 commit 8a5153d

File tree

30 files changed

+980
-415
lines changed

30 files changed

+980
-415
lines changed

english/nodejs-cpp/_index.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ is_root: true
7373
| [CheckBoxActiveXControl](./checkboxactivexcontrol) | Represents a CheckBox ActiveX control. |
7474
| [CheckBoxCollection](./checkboxcollection) | Represents a collection of [CheckBox](../nodejs-cpp/checkbox/) objects in a worksheet. |
7575
| [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. |
7777
| [ColorHelper](./colorhelper) | Provides helper functions about color. |
7878
| [ColorScale](./colorscale) | Describe the ColorScale conditional formatting rule. This conditional formatting rule creates a gradated color scale on the cells. |
7979
| [Column](./column) | Represents a single column in a worksheet. |
@@ -102,7 +102,7 @@ is_root: true
102102
| [CustomFunctionDefinition](./customfunctiondefinition) | Definition of custom function for calculating with user's custom engine. |
103103
| [CustomGeometry](./customgeometry) | Represents a custom geometric shape. |
104104
| [CustomPiovtFieldGroupItem](./custompiovtfieldgroupitem) | Represents an item of custom grouped field. |
105-
| [CustomProperty](./customproperty) | Represents identifier information. |
105+
| [CustomProperty](./customproperty) | Represents a custom property which store name and value pairs of arbitrary user-defined data for worksheet. |
106106
| [CustomPropertyCollection](./custompropertycollection) | A collection of [CustomProperty](../nodejs-cpp/customproperty/) objects that represent additional information. |
107107
| [CustomRenderSettings](./customrendersettings) | Represents custom settings during rendering. |
108108
| [CustomXmlPart](./customxmlpart) | Represents a Custom XML Data Storage Part (custom XML data within a package). |
@@ -160,7 +160,7 @@ is_root: true
160160
| [FileFormatInfo](./fileformatinfo) | Contains data returned by [FileFormatUtil](../nodejs-cpp/fileformatutil/) file format detection methods. |
161161
| [FileFormatUtil](./fileformatutil) | Provides utility methods for converting file format enums to strings or file extensions and back. |
162162
| [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. |
164164
| [FilterColumnCollection](./filtercolumncollection) | A collection of Filter objects that represents all the filters in an autofiltered range. |
165165
| [FindOptions](./findoptions) | Represents find options. |
166166
| [Floor](./floor) | Encapsulates the object that represents the floor of a 3-D chart. |
@@ -227,8 +227,8 @@ is_root: true
227227
| [ListBox](./listbox) | Represents a list box object. |
228228
| [ListBoxActiveXControl](./listboxactivexcontrol) | Represents a ListBox ActiveX control. |
229229
| [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. |
232232
| [ListObjectCollection](./listobjectcollection) | Represents a collection of [ListObject](../nodejs-cpp/listobject/) objects in the worksheet. |
233233
| [LoadFilter](./loadfilter) | Represents the filter that provides options for loading data when loading workbook from template. |
234234
| [LoadOptions](./loadoptions) | Represents the options of loading the file. |
@@ -301,20 +301,20 @@ is_root: true
301301
| [PivotField](./pivotfield) | Represents a field in a PivotTable report. |
302302
| [PivotFieldCollection](./pivotfieldcollection) | Represents a collection of all the PivotField objects in the PivotTable's specific PivotFields type. |
303303
| [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. |
305305
| [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. |
307307
| [PivotFormatCondition](./pivotformatcondition) | Represents a PivotTable Format Condition in PivotFormatCondition Collection. |
308308
| [PivotFormatConditionCollection](./pivotformatconditioncollection) | Represents PivotTable Format Conditions. |
309309
| [PivotGlobalizationSettings](./pivotglobalizationsettings) | Represents the globalization settings for pivot tables. |
310310
| [PivotItem](./pivotitem) | Represents a item in a PivotField report. |
311311
| [PivotItemCollection](./pivotitemcollection) | Represents all the [PivotItem](../nodejs-cpp/pivotitem/) objects in the PivotField. |
312312
| [PivotNumbericRangeGroupSettings](./pivotnumbericrangegroupsettings) | Represents the numberic range group of the pivot field. |
313313
| [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. |
315315
| [PivotShowValuesSetting](./pivotshowvaluessetting) | Represents the settings about showing values as when the ShowDataAs calculation is in use. |
316316
| [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. |
318318
| [PivotTableCollection](./pivottablecollection) | Represents the collection of all the PivotTable objects on the specified worksheet. |
319319
| [PivotTableFormat](./pivottableformat) | Represents the format defined in the PivotTable. |
320320
| [PivotTableFormatCollection](./pivottableformatcollection) | Represents the collection of formats applied to PivotTable. |
@@ -430,7 +430,7 @@ is_root: true
430430
| [SubtotalSetting](./subtotalsetting) | Represents the setting of the subtotal . |
431431
| [SvgImageOptions](./svgimageoptions) | Options for generating Svg image. |
432432
| [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. |
434434
| [TableStyleCollection](./tablestylecollection) | Represents all custom table styles. |
435435
| [TableStyleElement](./tablestyleelement) | Represents the element of the table style. |
436436
| [TableStyleElementCollection](./tablestyleelementcollection) | Represents all elements of the table style. |
@@ -463,7 +463,7 @@ is_root: true
463463
| [Title](./title) | Encapsulates the object that represents the title of chart or axis. |
464464
| [ToggleButtonActiveXControl](./togglebuttonactivexcontrol) | Represents a ToggleButton ActiveX control. |
465465
| [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. |
467467
| [Trendline](./trendline) | Represents a trendline in a chart. |
468468
| [TrendlineCollection](./trendlinecollection) | Represents a collection of all the [Trendline](../nodejs-cpp/trendline/) objects for the specified data series. |
469469
| [TwoColorGradient](./twocolorgradient) | Represents two color gradient. |
@@ -642,6 +642,7 @@ is_root: true
642642
| [HtmlFormatHandlingType](./htmlformathandlingtype) | Specifies how to handle formatting from the HTML source |
643643
| [HtmlHiddenColDisplayType](./htmlhiddencoldisplaytype) | Represents two types of showing the hidden columns in html. |
644644
| [HtmlHiddenRowDisplayType](./htmlhiddenrowdisplaytype) | Represents two types of showing the hidden rows in html. |
645+
| [HtmlLayoutMode](./htmllayoutmode) | Represents the layout mode for HTML rendering. |
645646
| [HtmlLinkTargetType](./htmllinktargettype) | Represents the type of target attribute in HTML <a/> tag. |
646647
| [HtmlOfficeMathOutputType](./htmlofficemathoutputtype) | Represents how export OfficeMath to HTML. |
647648
| [HtmlVersion](./htmlversion) | Indicates the version of HTML is used when saving to Html formats. |
@@ -712,7 +713,7 @@ is_root: true
712713
| [PivotFieldGroupType](./pivotfieldgrouptype) | Represents the group type of pivot field. |
713714
| [PivotFieldSubtotalType](./pivotfieldsubtotaltype) | Summary description for PivotFieldSubtotalType. |
714715
| [PivotFieldType](./pivotfieldtype) | Represents PivotTable field type. |
715-
| [PivotFilterType](./pivotfiltertype) | Represents PivotTable Filter type. |
716+
| [PivotFilterType](./pivotfiltertype) | Represents the filter type of the pivot table. |
716717
| [PivotGroupByType](./pivotgroupbytype) | Represents group by type. |
717718
| [PivotItemPosition](./pivotitemposition) | Represents base item Next/Previous/All position in the base field . |
718719
| [PivotItemPositionType](./pivotitempositiontype) | Represents the position type of the pivot base item in the base field when the ShowDataAs calculation is in use. |

english/nodejs-cpp/abstractcalculationengine/_index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,27 @@ User should not modify any part of the Workbook directly in this implementation(
2121

2222
| Method | Description |
2323
| --- | --- |
24+
| [skipCalculation()](#skipCalculation--)| Skips the calculation for the entire formula that references to the function currently under evaluation. |
2425
| abstract [isParamLiteralRequired()](#isParamLiteralRequired--)| Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false. |
2526
| 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. |
2627
| 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. |
2728
| abstract [calculate(CalculationData)](#calculate-calculationdata-)| Calculates one function with given data. |
2829
| abstract [forceRecalculate(string)](#forceRecalculate-string-)| Whether force given function to be recalculated always when calculating shared formulas. |
2930

3031

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.
44+
3145
### isParamLiteralRequired() {#isParamLiteralRequired--}
3246

3347
Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.

english/nodejs-cpp/colorfilter/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: ColorFilter
33
second_title: Aspose.Cells for Node.js via C++ API Reference
4-
description: Represents filtering the range by color.
4+
description: Represents setting for filtering the range by color.
55
type: docs
66
url: /nodejs-cpp/colorfilter/
77
---
88

99
## ColorFilter class
1010

11-
Represents filtering the range by color.
11+
Represents setting for filtering the range by color.
1212

1313
```javascript
1414
class ColorFilter;

english/nodejs-cpp/customproperty/_index.md

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,27 @@
11
---
22
title: CustomProperty
33
second_title: Aspose.Cells for Node.js via C++ API Reference
4-
description: Represents identifier information.
4+
description: Represents a custom property which store name and value pairs of arbitrary userdefined data for worksheet.
55
type: docs
66
url: /nodejs-cpp/customproperty/
77
---
88

99
## CustomProperty class
1010

11-
Represents identifier information.
11+
Represents a custom property which store name and value pairs of arbitrary user-defined data for worksheet.
1212

1313
```javascript
1414
class CustomProperty;
1515
```
1616

1717

18-
## Constructors
19-
20-
| Constructor | Description |
21-
| --- | --- |
22-
| [constructor()](#constructor--)| Default Constructor. |
23-
2418
## Properties
2519

2620
| Property | Type | Description |
2721
| --- | --- | --- |
2822
| [name](#name--)| string | Returns or sets the name of the object. |
2923
| [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. |
3025

3126
## Methods
3227

@@ -36,18 +31,11 @@ class CustomProperty;
3631
| [setName(string)](#setName-string-)| <b>@deprecated.</b> Please use the 'name' property instead. Returns or sets the name of the object. |
3732
| [getValue()](#getValue--)| <b>@deprecated.</b> Please use the 'value' property instead. Returns or sets the value of the custom property. |
3833
| [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. |
3936
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
4037

4138

42-
### constructor() {#constructor--}
43-
44-
Default Constructor.
45-
46-
```javascript
47-
constructor();
48-
```
49-
50-
5139
### name {#name--}
5240

5341
Returns or sets the name of the object.
@@ -66,6 +54,15 @@ value : string;
6654
```
6755

6856

57+
### binaryValue {#binaryValue--}
58+
59+
Gets and sets the binary value of the custom property.
60+
61+
```javascript
62+
binaryValue : Uint8Array;
63+
```
64+
65+
6966
### getName() {#getName--}
7067

7168
<b>@deprecated.</b> Please use the 'name' property instead. Returns or sets the name of the object.
@@ -110,6 +107,28 @@ setValue(value: string) : void;
110107
| --- | --- | --- |
111108
| value | string | The value to set. |
112109

110+
### getBinaryValue() {#getBinaryValue--}
111+
112+
<b>@deprecated.</b> Please use the 'binaryValue' property instead. Gets and sets the binary value of the custom property.
113+
114+
```javascript
115+
getBinaryValue() : Uint8Array;
116+
```
117+
118+
119+
### setBinaryValue(Uint8Array) {#setBinaryValue-uint8array-}
120+
121+
<b>@deprecated.</b> Please use the 'binaryValue' property instead. Gets and sets the binary value of the custom property.
122+
123+
```javascript
124+
setBinaryValue(value: Uint8Array) : void;
125+
```
126+
127+
**Parameters:**
128+
| Parameter | Type | Description |
129+
| --- | --- | --- |
130+
| value | number[] | The value to set. |
131+
113132
### isNull() {#isNull--}
114133

115134
Checks whether the implementation object is null.

0 commit comments

Comments
 (0)