Skip to content

Commit 3579d6d

Browse files
committed
Aspose.Cells for JavaScript via C++ v25.11 Api Reference
1 parent 8a5153d commit 3579d6d

File tree

30 files changed

+437
-210
lines changed

30 files changed

+437
-210
lines changed

english/javascript-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](../javascript-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](../javascript-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](../javascript-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](../javascript-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](../javascript-cpp/listcolumn/) objects in the table. |
231+
| [ListObject](./listobject) | Represents a table in a worksheet. |
232232
| [ListObjectCollection](./listobjectcollection) | Represents a collection of [ListObject](../javascript-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](../javascript-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](../javascript-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](../javascript-cpp/trendline/) objects for the specified data series. |
469469
| [TwoColorGradient](./twocolorgradient) | Represents two color gradient. |
@@ -643,6 +643,7 @@ is_root: true
643643
| [HtmlFormatHandlingType](./htmlformathandlingtype) | Specifies how to handle formatting from the HTML source |
644644
| [HtmlHiddenColDisplayType](./htmlhiddencoldisplaytype) | Represents two types of showing the hidden columns in html. |
645645
| [HtmlHiddenRowDisplayType](./htmlhiddenrowdisplaytype) | Represents two types of showing the hidden rows in html. |
646+
| [HtmlLayoutMode](./htmllayoutmode) | Represents the layout mode for HTML rendering. |
646647
| [HtmlLinkTargetType](./htmllinktargettype) | Represents the type of target attribute in HTML <a/> tag. |
647648
| [HtmlOfficeMathOutputType](./htmlofficemathoutputtype) | Represents how export OfficeMath to HTML. |
648649
| [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/javascript-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/javascript-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 JavaScript 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: /javascript-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;
Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,27 @@
11
---
22
title: CustomProperty
33
second_title: Aspose.Cells for JavaScript 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: /javascript-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-
| Name | 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. |
30-
31-
32-
### constructor() {#constructor--}
33-
34-
Default Constructor.
35-
36-
```javascript
37-
constructor();
38-
```
24+
| [binaryValue](#binaryValue--)| Uint8Array | Gets and sets the binary value of the custom property. |
3925

4026

4127
### name {#name--}
@@ -56,4 +42,13 @@ value : string;
5642
```
5743

5844

45+
### binaryValue {#binaryValue--}
46+
47+
Gets and sets the binary value of the custom property.
48+
49+
```javascript
50+
binaryValue : Uint8Array;
51+
```
52+
53+
5954

english/javascript-cpp/delimiterequationnode/_index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class DelimiterEquationNode extends EquationNode;
2727
| --- | --- | --- |
2828
| [beginChar](#beginChar--)| string | Delimiter beginning character. |
2929
| [endChar](#endChar--)| string | Delimiter ending character. |
30-
| [naryGrow](#naryGrow--)| boolean | |
30+
| [naryGrow](#naryGrow--)| boolean | Specifies whether the delimiter should automatically expand and contract with the height of the formula. |
3131
| [separatorChar](#separatorChar--)| string | Delimiter separator character. |
3232
| [delimiterShape](#delimiterShape--)| EquationDelimiterShapeType | Specifies the shape of delimiters in the delimiter object. |
3333
| [startIndex](#startIndex--)| number | Readonly. Gets the start index of the characters. |
@@ -100,13 +100,17 @@ It should be noted that this property only accepts one character, and if multipl
100100

101101
### naryGrow {#naryGrow--}
102102

103-
103+
Specifies whether the delimiter should automatically expand and contract with the height of the formula.
104104

105105
```javascript
106106
naryGrow : boolean;
107107
```
108108

109109

110+
**Remarks**
111+
112+
This property specifies the growth property of the delimiter at the document level. When off, the delimiter will not grow to match the size of its component height. When enabled, the delimiter grows vertically to match its component height.
113+
110114
### separatorChar {#separatorChar--}
111115

112116
Delimiter separator character.

english/javascript-cpp/dynamicfilter/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class DynamicFilter;
2525

2626
| Property | Type | Description |
2727
| --- | --- | --- |
28-
| [dynamicFilterType](#dynamicFilterType--)| DynamicFilterType | Gets and sets the dynamic filter type. |
28+
| [dynamicFilterType](#dynamicFilterType--)| DynamicFilterType | Gets and sets the type of this dynamic filter. |
2929
| [value](#value--)| VObject | Gets and sets the dynamic filter value. |
3030
| [maxValue](#maxValue--)| VObject | Gets and sets the dynamic filter max value. |
3131

@@ -51,7 +51,7 @@ constructor(vobj: VObject);
5151

5252
### dynamicFilterType {#dynamicFilterType--}
5353

54-
Gets and sets the dynamic filter type.
54+
Gets and sets the type of this dynamic filter.
5555

5656
```javascript
5757
dynamicFilterType : DynamicFilterType;

english/javascript-cpp/ebooksaveoptions/_index.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ class EbookSaveOptions extends HtmlSaveOptions;
107107
| [enableCssCustomProperties](#enableCssCustomProperties--)| boolean | 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. The default value is false. |
108108
| [htmlVersion](#htmlVersion--)| HtmlVersion | Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
109109
| [sheetSet](#sheetSet--)| SheetSet | Gets or sets the sheets to render. Default is all visible sheets in the workbook: [Aspose.Cells.Rendering.SheetSet.Visible](../aspose.cells.rendering.sheetset.visible/). |
110-
| [embeddedFontType](#embeddedFontType--)| HtmlEmbeddedFontType | Gets or sets the type of font that embedded in html. Default value is [HtmlEmbeddedFontType.None](../htmlembeddedfonttype.none/) which indicates that it will not embed font in html. |
110+
| [layoutMode](#layoutMode--)| HtmlLayoutMode | Gets or sets the layout mode when saving to HTML. The default value is [HtmlLayoutMode.Normal](../htmllayoutmode.normal/) |
111+
| [embeddedFontType](#embeddedFontType--)| HtmlEmbeddedFontType | Gets or sets the type of embedding font file into html file. Default value is [HtmlEmbeddedFontType.None](../htmlembeddedfonttype.none/) which indicates that no font will be embedded in html. |
111112

112113

113114
### constructor() {#constructor--}
@@ -921,9 +922,18 @@ sheetSet : SheetSet;
921922
```
922923

923924

925+
### layoutMode {#layoutMode--}
926+
927+
Gets or sets the layout mode when saving to HTML. The default value is [HtmlLayoutMode.Normal](../htmllayoutmode.normal/)
928+
929+
```javascript
930+
layoutMode : HtmlLayoutMode;
931+
```
932+
933+
924934
### embeddedFontType {#embeddedFontType--}
925935

926-
Gets or sets the type of font that embedded in html. Default value is [HtmlEmbeddedFontType.None](../htmlembeddedfonttype.none/) which indicates that it will not embed font in html.
936+
Gets or sets the type of embedding font file into html file. Default value is [HtmlEmbeddedFontType.None](../htmlembeddedfonttype.none/) which indicates that no font will be embedded in html.
927937

928938
```javascript
929939
embeddedFontType : HtmlEmbeddedFontType;

0 commit comments

Comments
 (0)