Skip to content

Commit 262b752

Browse files
nickliuasposenickliuaspose
committed
Aspose.Cells for Node.js via C++ v25.9 Api Reference
1 parent 82d3721 commit 262b752

File tree

11 files changed

+460
-3
lines changed

11 files changed

+460
-3
lines changed

‎english/nodejs-cpp/_index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -637,6 +637,7 @@ is_root: true
637637
| [GridlineType](./gridlinetype) | Enumerates grid line Type. |
638638
| [HeaderFooterCommandType](./headerfootercommandtype) | Represents the command type of header and footer. |
639639
| [HtmlCrossType](./htmlcrosstype) | Represents five types of html cross string. |
640+
| [HtmlEmbeddedFontType](./htmlembeddedfonttype) | Represents the embedded font type in html. |
640641
| [HtmlExportDataOptions](./htmlexportdataoptions) | Represents the options for exporting html data. |
641642
| [HtmlFormatHandlingType](./htmlformathandlingtype) | Specifies how to handle formatting from the HTML source |
642643
| [HtmlHiddenColDisplayType](./htmlhiddencoldisplaytype) | Represents two types of showing the hidden columns in html. |
@@ -747,6 +748,7 @@ is_root: true
747748
| [ResourceLoadingType](./resourceloadingtype) | Represents how to loading the linked resource. |
748749
| [RevisionActionType](./revisionactiontype) | Represents the type of revision action. |
749750
| [RevisionType](./revisiontype) | Represents the revision type. |
751+
| [SaveElementType](./saveelementtype) | Represents what kind of elements should be saved. |
750752
| [SaveFormat](./saveformat) | Represents the format in which the workbook is saved. |
751753
| [SelectionType](./selectiontype) | The selection type of list box. |
752754
| [SensitivityLabelAssignmentType](./sensitivitylabelassignmenttype) | Represents the assignment method for the sensitivity label. |

‎english/nodejs-cpp/copyoptions/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ referToDestinationSheet : boolean;
140140
141141
**Remarks**
142142
143-
The default value is false, it works as MS Excel.
143+
The default value is false, it works as MS Excel. For example: if copying a chart with the data source "sheet1!A1:B10" from worksheet "sheet1 to other worksheet "sheet2", The data source will be changed as "sheet2!A1:B10"
144144
145145
### getKeepMacros() {#getKeepMacros--}
146146
@@ -309,7 +309,7 @@ getReferToDestinationSheet() : boolean;
309309
310310
**Remarks**
311311
312-
The default value is false, it works as MS Excel.
312+
The default value is false, it works as MS Excel. For example: if copying a chart with the data source "sheet1!A1:B10" from worksheet "sheet1 to other worksheet "sheet2", The data source will be changed as "sheet2!A1:B10"
313313
314314
### setReferToDestinationSheet(boolean) {#setReferToDestinationSheet-boolean-}
315315
@@ -326,7 +326,7 @@ setReferToDestinationSheet(value: boolean) : void;
326326
327327
**Remarks**
328328
329-
The default value is false, it works as MS Excel.
329+
The default value is false, it works as MS Excel. For example: if copying a chart with the data source "sheet1!A1:B10" from worksheet "sheet1 to other worksheet "sheet2", The data source will be changed as "sheet2!A1:B10"
330330
331331
### isNull() {#isNull--}
332332

‎english/nodejs-cpp/docxsaveoptions/_index.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ class DocxSaveOptions extends PaginatedSaveOptions;
2929
| --- | --- | --- |
3030
| [saveAsEditableShaps](#saveAsEditableShaps--)| boolean | Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. |
3131
| [saveAsEditableShapes](#saveAsEditableShapes--)| boolean | Save all drawing objects as editable shapes in the word file, so you can edit them in Word. |
32+
| [embedXlsxAsChartDataSource](#embedXlsxAsChartDataSource--)| boolean | Indicates whether embedding an xlsx file as data source of the chart. |
33+
| [asFlatOpc](#asFlatOpc--)| boolean | Indicates whether saving as a flat opc file which can be generated by Open XML SDK |
34+
| [saveElementType](#saveElementType--)| SaveElementType | Indicates which elements should be saved. |
3235
| [asNormalView](#asNormalView--)| boolean | Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false. |
3336
| [saveFormat](#saveFormat--)| SaveFormat | Readonly. Gets the save file format. |
3437
| [clearData](#clearData--)| boolean | Make the workbook empty after saving the file. |
@@ -72,6 +75,12 @@ class DocxSaveOptions extends PaginatedSaveOptions;
7275
| [setSaveAsEditableShaps(boolean)](#setSaveAsEditableShaps-boolean-)| <b>@deprecated.</b> Please use the 'saveAsEditableShaps' property instead. Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. |
7376
| [getSaveAsEditableShapes()](#getSaveAsEditableShapes--)| <b>@deprecated.</b> Please use the 'saveAsEditableShapes' property instead. Save all drawing objects as editable shapes in the word file, so you can edit them in Word. |
7477
| [setSaveAsEditableShapes(boolean)](#setSaveAsEditableShapes-boolean-)| <b>@deprecated.</b> Please use the 'saveAsEditableShapes' property instead. Save all drawing objects as editable shapes in the word file, so you can edit them in Word. |
78+
| [getEmbedXlsxAsChartDataSource()](#getEmbedXlsxAsChartDataSource--)| <b>@deprecated.</b> Please use the 'embedXlsxAsChartDataSource' property instead. Indicates whether embedding an xlsx file as data source of the chart. |
79+
| [setEmbedXlsxAsChartDataSource(boolean)](#setEmbedXlsxAsChartDataSource-boolean-)| <b>@deprecated.</b> Please use the 'embedXlsxAsChartDataSource' property instead. Indicates whether embedding an xlsx file as data source of the chart. |
80+
| [getAsFlatOpc()](#getAsFlatOpc--)| <b>@deprecated.</b> Please use the 'asFlatOpc' property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK |
81+
| [setAsFlatOpc(boolean)](#setAsFlatOpc-boolean-)| <b>@deprecated.</b> Please use the 'asFlatOpc' property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK |
82+
| [getSaveElementType()](#getSaveElementType--)| <b>@deprecated.</b> Please use the 'saveElementType' property instead. Indicates which elements should be saved. |
83+
| [setSaveElementType(SaveElementType)](#setSaveElementType-saveelementtype-)| <b>@deprecated.</b> Please use the 'saveElementType' property instead. Indicates which elements should be saved. |
7584
| [getAsNormalView()](#getAsNormalView--)| <b>@deprecated.</b> Please use the 'asNormalView' property instead. Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false. |
7685
| [setAsNormalView(boolean)](#setAsNormalView-boolean-)| <b>@deprecated.</b> Please use the 'asNormalView' property instead. Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false. |
7786
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
@@ -203,6 +212,37 @@ saveAsEditableShapes : boolean;
203212

204213
Only for charts.
205214

215+
### embedXlsxAsChartDataSource {#embedXlsxAsChartDataSource--}
216+
217+
Indicates whether embedding an xlsx file as data source of the chart.
218+
219+
```javascript
220+
embedXlsxAsChartDataSource : boolean;
221+
```
222+
223+
224+
**Remarks**
225+
226+
The default value is true.
227+
228+
### asFlatOpc {#asFlatOpc--}
229+
230+
Indicates whether saving as a flat opc file which can be generated by Open XML SDK
231+
232+
```javascript
233+
asFlatOpc : boolean;
234+
```
235+
236+
237+
### saveElementType {#saveElementType--}
238+
239+
Indicates which elements should be saved.
240+
241+
```javascript
242+
saveElementType : SaveElementType;
243+
```
244+
245+
206246
### asNormalView {#asNormalView--}
207247

208248
Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false.
@@ -637,6 +677,84 @@ setSaveAsEditableShapes(value: boolean) : void;
637677

638678
Only for charts.
639679

680+
### getEmbedXlsxAsChartDataSource() {#getEmbedXlsxAsChartDataSource--}
681+
682+
<b>@deprecated.</b> Please use the 'embedXlsxAsChartDataSource' property instead. Indicates whether embedding an xlsx file as data source of the chart.
683+
684+
```javascript
685+
getEmbedXlsxAsChartDataSource() : boolean;
686+
```
687+
688+
689+
**Remarks**
690+
691+
The default value is true.
692+
693+
### setEmbedXlsxAsChartDataSource(boolean) {#setEmbedXlsxAsChartDataSource-boolean-}
694+
695+
<b>@deprecated.</b> Please use the 'embedXlsxAsChartDataSource' property instead. Indicates whether embedding an xlsx file as data source of the chart.
696+
697+
```javascript
698+
setEmbedXlsxAsChartDataSource(value: boolean) : void;
699+
```
700+
701+
**Parameters:**
702+
| Parameter | Type | Description |
703+
| --- | --- | --- |
704+
| value | boolean | The value to set. |
705+
706+
**Remarks**
707+
708+
The default value is true.
709+
710+
### getAsFlatOpc() {#getAsFlatOpc--}
711+
712+
<b>@deprecated.</b> Please use the 'asFlatOpc' property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK
713+
714+
```javascript
715+
getAsFlatOpc() : boolean;
716+
```
717+
718+
719+
### setAsFlatOpc(boolean) {#setAsFlatOpc-boolean-}
720+
721+
<b>@deprecated.</b> Please use the 'asFlatOpc' property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK
722+
723+
```javascript
724+
setAsFlatOpc(value: boolean) : void;
725+
```
726+
727+
**Parameters:**
728+
| Parameter | Type | Description |
729+
| --- | --- | --- |
730+
| value | boolean | The value to set. |
731+
732+
### getSaveElementType() {#getSaveElementType--}
733+
734+
<b>@deprecated.</b> Please use the 'saveElementType' property instead. Indicates which elements should be saved.
735+
736+
```javascript
737+
getSaveElementType() : SaveElementType;
738+
```
739+
740+
741+
**Returns**
742+
743+
[SaveElementType](../saveelementtype/)
744+
745+
### setSaveElementType(SaveElementType) {#setSaveElementType-saveelementtype-}
746+
747+
<b>@deprecated.</b> Please use the 'saveElementType' property instead. Indicates which elements should be saved.
748+
749+
```javascript
750+
setSaveElementType(value: SaveElementType) : void;
751+
```
752+
753+
**Parameters:**
754+
| Parameter | Type | Description |
755+
| --- | --- | --- |
756+
| value | [SaveElementType](../saveelementtype/) | The value to set. |
757+
640758
### getAsNormalView() {#getAsNormalView--}
641759

642760
<b>@deprecated.</b> Please use the 'asNormalView' property instead. Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false.

‎english/nodejs-cpp/ebooksaveoptions/_index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ 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. |
110111

111112
## Methods
112113

@@ -271,6 +272,8 @@ class EbookSaveOptions extends HtmlSaveOptions;
271272
| [setHtmlVersion(HtmlVersion)](#setHtmlVersion-htmlversion-)| <b>@deprecated.</b> Please use the 'htmlVersion' property instead. Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
272273
| [getSheetSet()](#getSheetSet--)| <b>@deprecated.</b> Please use the 'sheetSet' property instead. 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/). |
273274
| [setSheetSet(SheetSet)](#setSheetSet-sheetset-)| <b>@deprecated.</b> Please use the 'sheetSet' property instead. 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/). |
275+
| [getEmbeddedFontType()](#getEmbeddedFontType--)| <b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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. |
276+
| [setEmbeddedFontType(HtmlEmbeddedFontType)](#setEmbeddedFontType-htmlembeddedfonttype-)| <b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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. |
274277

275278

276279
### constructor() {#constructor--}
@@ -1084,6 +1087,15 @@ sheetSet : SheetSet;
10841087
```
10851088

10861089

1090+
### embeddedFontType {#embeddedFontType--}
1091+
1092+
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.
1093+
1094+
```javascript
1095+
embeddedFontType : HtmlEmbeddedFontType;
1096+
```
1097+
1098+
10871099
### isNull() {#isNull--}
10881100

10891101
Checks whether the implementation object is null.
@@ -3003,4 +3015,30 @@ setSheetSet(value: SheetSet) : void;
30033015
| --- | --- | --- |
30043016
| value | [SheetSet](../sheetset/) | The value to set. |
30053017

3018+
### getEmbeddedFontType() {#getEmbeddedFontType--}
3019+
3020+
<b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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.
3021+
3022+
```javascript
3023+
getEmbeddedFontType() : HtmlEmbeddedFontType;
3024+
```
3025+
3026+
3027+
**Returns**
3028+
3029+
[HtmlEmbeddedFontType](../htmlembeddedfonttype/)
3030+
3031+
### setEmbeddedFontType(HtmlEmbeddedFontType) {#setEmbeddedFontType-htmlembeddedfonttype-}
3032+
3033+
<b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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.
3034+
3035+
```javascript
3036+
setEmbeddedFontType(value: HtmlEmbeddedFontType) : void;
3037+
```
3038+
3039+
**Parameters:**
3040+
| Parameter | Type | Description |
3041+
| --- | --- | --- |
3042+
| value | [HtmlEmbeddedFontType](../htmlembeddedfonttype/) | The value to set. |
3043+
30063044

‎english/nodejs-cpp/fileformattype/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ Represents the file format types.
8080
| Json | `513` | Json |
8181
| SqlScript | `514` | Sql |
8282
| Dbf | `515` | Xbase Data file |
83+
| FlatOpc | `516` | Flat opc file |
8384
| XHtml | `771` | Rrepesents XHtml file. |
8485
| OneNote | `772` | Rrepesents One Note file. |
8586
| MicrosoftCabinet | `773` | Rrepesents Microsoft Cabinet file. |

‎english/nodejs-cpp/htmlembeddedfonttype/_index.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: HtmlEmbeddedFontType
3+
second_title: Aspose.Cells for Node.js via C++ API Reference
4+
description: Represents the embedded font type in html.
5+
type: docs
6+
url: /nodejs-cpp/htmlembeddedfonttype/
7+
---
8+
9+
## HtmlEmbeddedFontType enumeration
10+
Represents the embedded font type in html.
11+
### Values
12+
| Name | Value | Description |
13+
| --- | --- | --- |
14+
| None | `0` | Not embed font. |
15+
| Woff | `1` | Embed WOFF font. |
16+

‎english/nodejs-cpp/htmlsaveoptions/_index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ class HtmlSaveOptions extends SaveOptions;
9494
| [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. |
9595
| [htmlVersion](#htmlVersion--)| HtmlVersion | Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
9696
| [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/). |
97+
| [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. |
9798
| [saveFormat](#saveFormat--)| SaveFormat | Readonly. Gets the save file format. |
9899
| [clearData](#clearData--)| boolean | Make the workbook empty after saving the file. |
99100
| [cachedFileFolder](#cachedFileFolder--)| string | The folder for temporary files that may be used as data cache. |
@@ -245,6 +246,8 @@ class HtmlSaveOptions extends SaveOptions;
245246
| [setHtmlVersion(HtmlVersion)](#setHtmlVersion-htmlversion-)| <b>@deprecated.</b> Please use the 'htmlVersion' property instead. Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
246247
| [getSheetSet()](#getSheetSet--)| <b>@deprecated.</b> Please use the 'sheetSet' property instead. 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/). |
247248
| [setSheetSet(SheetSet)](#setSheetSet-sheetset-)| <b>@deprecated.</b> Please use the 'sheetSet' property instead. 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/). |
249+
| [getEmbeddedFontType()](#getEmbeddedFontType--)| <b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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. |
250+
| [setEmbeddedFontType(HtmlEmbeddedFontType)](#setEmbeddedFontType-htmlembeddedfonttype-)| <b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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. |
248251
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
249252
| [getSaveFormat()](#getSaveFormat--)| <b>@deprecated.</b> Please use the 'saveFormat' property instead. Gets the save file format. |
250253
| [getClearData()](#getClearData--)| <b>@deprecated.</b> Please use the 'clearData' property instead. Make the workbook empty after saving the file. |
@@ -943,6 +946,15 @@ sheetSet : SheetSet;
943946
```
944947

945948

949+
### embeddedFontType {#embeddedFontType--}
950+
951+
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.
952+
953+
```javascript
954+
embeddedFontType : HtmlEmbeddedFontType;
955+
```
956+
957+
946958
### saveFormat {#saveFormat--}
947959

948960
Readonly. Gets the save file format.
@@ -2665,6 +2677,32 @@ setSheetSet(value: SheetSet) : void;
26652677
| --- | --- | --- |
26662678
| value | [SheetSet](../sheetset/) | The value to set. |
26672679

2680+
### getEmbeddedFontType() {#getEmbeddedFontType--}
2681+
2682+
<b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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.
2683+
2684+
```javascript
2685+
getEmbeddedFontType() : HtmlEmbeddedFontType;
2686+
```
2687+
2688+
2689+
**Returns**
2690+
2691+
[HtmlEmbeddedFontType](../htmlembeddedfonttype/)
2692+
2693+
### setEmbeddedFontType(HtmlEmbeddedFontType) {#setEmbeddedFontType-htmlembeddedfonttype-}
2694+
2695+
<b>@deprecated.</b> Please use the 'embeddedFontType' property instead. 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.
2696+
2697+
```javascript
2698+
setEmbeddedFontType(value: HtmlEmbeddedFontType) : void;
2699+
```
2700+
2701+
**Parameters:**
2702+
| Parameter | Type | Description |
2703+
| --- | --- | --- |
2704+
| value | [HtmlEmbeddedFontType](../htmlembeddedfonttype/) | The value to set. |
2705+
26682706
### isNull() {#isNull--}
26692707

26702708
Checks whether the implementation object is null.

0 commit comments

Comments
 (0)