Skip to content

Commit fc46ac3

Browse files
committed
Aspose.Cells for JavaScript via C++ v26.3
1 parent 263616f commit fc46ac3

41 files changed

Lines changed: 326 additions & 67 deletions

File tree

Some content is hidden

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

english/javascript-cpp/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,7 @@ is_root: true
648648
| [HtmlLayoutMode](./htmllayoutmode) | Represents the layout mode for HTML rendering. |
649649
| [HtmlLinkTargetType](./htmllinktargettype) | Represents the type of target attribute in HTML <a/> tag. |
650650
| [HtmlOfficeMathOutputType](./htmlofficemathoutputtype) | Represents how to export OfficeMath to HTML. |
651+
| [HtmlParagraphLayoutMode](./htmlparagraphlayoutmode) | Specifies how HTML &lt;p&gt; elements are rendered when loading HTML. |
651652
| [HtmlVersion](./htmlversion) | Indicates the version of HTML is used when saving to Html formats. |
652653
| [IconSetType](./iconsettype) | Icon set type for conditional formatting. The threshold values for triggering the different icons within a set are configurable, and the icon order is reversible. |
653654
| [ImageBinarizationMethod](./imagebinarizationmethod) | Specifies the method used to binarize image. |

english/javascript-cpp/axis/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ baseUnitScale : TimeUnit;
427427

428428
**Remarks**
429429

430-
Setting this property only takes effect when the CategoryType property is set to TimeScale.
430+
Only takes effect when the CategoryType property is set to TimeScale.
431431

432432
### majorUnitScale {#majorUnitScale--}
433433

@@ -588,6 +588,10 @@ bins : AxisBins;
588588
```
589589

590590

591+
**Remarks**
592+
593+
Only for Histogram or Pareto chart.
594+
591595
### getAxisTexts() {#getAxisTexts--}
592596

593597
Gets the labels of the axis after call Chart.Calculate() method.

english/javascript-cpp/axisbins/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ isAutomatic : boolean;
5252
```
5353

5454

55+
**Remarks**
56+
57+
If [Width](../width/) or [Count](../count/) is called, the value will be false.
58+
5559
### width {#width--}
5660

5761
Gets or sets the width of axis bin

english/javascript-cpp/chart/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1217,7 +1217,7 @@ The data source.
12171217

12181218
**Remarks**
12191219

1220-
Only supports range.
1220+
Only supports range. If the Series.Values, Name, and XValues are in a continuous range, a range contains them will be returned.
12211221

12221222
### setChartDataRange(string, boolean) {#setChartDataRange-string-boolean-}
12231223

english/javascript-cpp/chartarea/_index.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ var uint8Array = workbook.save(SaveFormat.Xlsx);
6161
| Property | Type | Description |
6262
| --- | --- | --- |
6363
| [isInnerMode](#isInnerMode--)| boolean | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. |
64-
| [backgroundMode](#backgroundMode--)| BackgroundMode | Gets and sets the display mode of the background |
64+
| [backgroundMode](#backgroundMode--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
65+
| [background](#background--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
6566
| [shadow](#shadow--)| boolean | True if the frame has a shadow. |
6667
| [shapeProperties](#shapeProperties--)| ShapePropertyCollection | Readonly. Gets the [ShapeProperties](../shapeproperties/) object. |
6768
| [isDefaultPosBeSet](#isDefaultPosBeSet--)| boolean | Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
@@ -141,13 +142,30 @@ Only for Xlsx file.
141142

142143
### backgroundMode {#backgroundMode--}
143144

144-
Gets and sets the display mode of the background
145+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
145146

146147
```javascript
147148
backgroundMode : BackgroundMode;
148149
```
149150

150151

152+
**Remarks**
153+
154+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since February 2026. Aspose apologizes for any inconvenience you may have experienced.
155+
156+
### background {#background--}
157+
158+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
159+
160+
```javascript
161+
background : BackgroundMode;
162+
```
163+
164+
165+
**Remarks**
166+
167+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
168+
151169
### shadow {#shadow--}
152170

153171
True if the frame has a shadow.
@@ -157,6 +175,10 @@ shadow : boolean;
157175
```
158176

159177

178+
**Remarks**
179+
180+
Only for charts in xls file.
181+
160182
### shapeProperties {#shapeProperties--}
161183

162184
Readonly. Gets the [ShapeProperties](../shapeproperties/) object.

english/javascript-cpp/chartframe/_index.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ class ChartFrame;
2020
| Property | Type | Description |
2121
| --- | --- | --- |
2222
| [isInnerMode](#isInnerMode--)| boolean | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. |
23-
| [backgroundMode](#backgroundMode--)| BackgroundMode | Gets and sets the display mode of the background |
23+
| [backgroundMode](#backgroundMode--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
24+
| [background](#background--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
2425
| [shadow](#shadow--)| boolean | True if the frame has a shadow. |
2526
| [shapeProperties](#shapeProperties--)| ShapePropertyCollection | Readonly. Gets the [ShapeProperties](../shapeproperties/) object. |
2627
| [isDefaultPosBeSet](#isDefaultPosBeSet--)| boolean | Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
@@ -87,13 +88,30 @@ Only for Xlsx file.
8788

8889
### backgroundMode {#backgroundMode--}
8990

90-
Gets and sets the display mode of the background
91+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
9192

9293
```javascript
9394
backgroundMode : BackgroundMode;
9495
```
9596

9697

98+
**Remarks**
99+
100+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since February 2026. Aspose apologizes for any inconvenience you may have experienced.
101+
102+
### background {#background--}
103+
104+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
105+
106+
```javascript
107+
background : BackgroundMode;
108+
```
109+
110+
111+
**Remarks**
112+
113+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
114+
97115
### shadow {#shadow--}
98116

99117
True if the frame has a shadow.
@@ -103,6 +121,10 @@ shadow : boolean;
103121
```
104122

105123

124+
**Remarks**
125+
126+
Only for charts in xls file.
127+
106128
### shapeProperties {#shapeProperties--}
107129

108130
Readonly. Gets the [ShapeProperties](../shapeproperties/) object.

english/javascript-cpp/charttextframe/_index.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ class ChartTextFrame extends ChartFrame;
3333
| [readingOrder](#readingOrder--)| TextDirectionType | Represents text reading order. |
3434
| [isResizeShapeToFitText](#isResizeShapeToFitText--)| boolean | Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside. |
3535
| [isInnerMode](#isInnerMode--)| boolean | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. |
36-
| [backgroundMode](#backgroundMode--)| BackgroundMode | Gets and sets the display mode of the background |
36+
| [backgroundMode](#backgroundMode--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
37+
| [background](#background--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
3738
| [shadow](#shadow--)| boolean | True if the frame has a shadow. |
3839
| [shapeProperties](#shapeProperties--)| ShapePropertyCollection | Readonly. Gets the [ShapeProperties](../shapeproperties/) object. |
3940
| [isDefaultPosBeSet](#isDefaultPosBeSet--)| boolean | Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
@@ -191,13 +192,30 @@ Only for Xlsx file.
191192

192193
### backgroundMode {#backgroundMode--}
193194

194-
Gets and sets the display mode of the background
195+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
195196

196197
```javascript
197198
backgroundMode : BackgroundMode;
198199
```
199200

200201

202+
**Remarks**
203+
204+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since February 2026. Aspose apologizes for any inconvenience you may have experienced.
205+
206+
### background {#background--}
207+
208+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
209+
210+
```javascript
211+
background : BackgroundMode;
212+
```
213+
214+
215+
**Remarks**
216+
217+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
218+
201219
### shadow {#shadow--}
202220

203221
True if the frame has a shadow.
@@ -207,6 +225,10 @@ shadow : boolean;
207225
```
208226

209227

228+
**Remarks**
229+
230+
Only for charts in xls file.
231+
210232
### shapeProperties {#shapeProperties--}
211233

212234
Readonly. Gets the [ShapeProperties](../shapeproperties/) object.

english/javascript-cpp/datalabels/_index.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,10 @@ for (var i = 0; i < chart.nSeries.count; i++) {
8181
| [separatorType](#separatorType--)| DataLabelsSeparatorType | Gets or sets the separator type used for the data labels on a chart. |
8282
| [separatorValue](#separatorValue--)| string | Gets or sets the separator value used for the data labels on a chart. |
8383
| [position](#position--)| LabelPositionType | Represents the position of the data label. |
84-
| [isNeverOverlap](#isNeverOverlap--)| boolean | Indicates whether the datalabels display never overlap. (For Pie chart) |
84+
| [isNeverOverlap](#isNeverOverlap--)| boolean | Indicates whether datalabels never overlap when performing Pie Chart to image. Note: this property is only meaningful when Pie Chart to image. |
8585
| [shapeType](#shapeType--)| DataLabelShapeType | Gets or sets shape type of data label. |
8686
| [isInnerMode](#isInnerMode--)| boolean | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. |
87+
| [background](#background--)| BackgroundMode | Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions. |
8788
| [shadow](#shadow--)| boolean | True if the frame has a shadow. |
8889
| [shapeProperties](#shapeProperties--)| ShapePropertyCollection | Readonly. Gets the [ShapeProperties](../shapeproperties/) object. |
8990
| [isDefaultPosBeSet](#isDefaultPosBeSet--)| boolean | Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
@@ -299,7 +300,7 @@ position : LabelPositionType;
299300
300301
### isNeverOverlap {#isNeverOverlap--}
301302
302-
Indicates whether the datalabels display never overlap. (For Pie chart)
303+
Indicates whether datalabels never overlap when performing Pie Chart to image. Note: this property is only meaningful when Pie Chart to image.
303304
304305
```javascript
305306
isNeverOverlap : boolean;
@@ -328,6 +329,19 @@ isInnerMode : boolean;
328329
329330
Only for Xlsx file.
330331
332+
### background {#background--}
333+
334+
Gets and sets the display mode of the background. This property is only valid in Excel 2003 or earlier versions.
335+
336+
```javascript
337+
background : BackgroundMode;
338+
```
339+
340+
341+
**Remarks**
342+
343+
NOTE: This member is now obsolete. Instead, please use ChartFrame.Area.FillFormat.FillType property. For example, If you need to set the BackgroundMode to Opaque, you can use the following code: Area.FillFormat.FillType = FillType.Solid; Area.FillFormat.SolidFill.Color = Color.Red; This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
344+
331345
### shadow {#shadow--}
332346
333347
True if the frame has a shadow.
@@ -337,6 +351,10 @@ shadow : boolean;
337351
```
338352
339353
354+
**Remarks**
355+
356+
Only for charts in xls file.
357+
340358
### shapeProperties {#shapeProperties--}
341359
342360
Readonly. Gets the [ShapeProperties](../shapeproperties/) object.
@@ -620,6 +638,10 @@ getText() : string;
620638
```
621639
622640
641+
**Remarks**
642+
643+
Only works when this is a data label of a chart point.
644+
623645
### setText(string) {#setText-string-}
624646
625647
Gets or sets the text of data label.
@@ -633,6 +655,10 @@ setText(value: string) : void;
633655
| --- | --- | --- |
634656
| value | string | The value to set. |
635657
658+
**Remarks**
659+
660+
Only works when this is a data label of a chart point.
661+
636662
### isTextWrapped() {#isTextWrapped--}
637663
638664
Gets or sets a value indicating whether the text is wrapped.

english/javascript-cpp/dbfsaveoptions/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class DbfSaveOptions extends SaveOptions;
3535
| [createDirectory](#createDirectory--)| boolean | If true and the directory does not exist, the directory will be automatically created before saving the file. |
3636
| [sortNames](#sortNames--)| boolean | Indicates whether sorting defined names before saving file. |
3737
| [sortExternalNames](#sortExternalNames--)| boolean | Indicates whether sorting external defined names before saving file. |
38-
| [refreshChartCache](#refreshChartCache--)| boolean | Indicates whether refreshing chart cache data |
38+
| [refreshChartCache](#refreshChartCache--)| boolean | Indicates whether to cache the latest data of the chart. |
3939
| [warningCallback](#warningCallback--)| IWarningCallback | Gets or sets warning callback. |
4040
| [checkExcelRestriction](#checkExcelRestriction--)| boolean | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
4141
| [updateSmartArt](#updateSmartArt--)| boolean | Indicates whether updating smart art setting. The default value is false. |
@@ -163,7 +163,7 @@ sortExternalNames : boolean;
163163

164164
### refreshChartCache {#refreshChartCache--}
165165

166-
Indicates whether refreshing chart cache data
166+
Indicates whether to cache the latest data of the chart.
167167

168168
```javascript
169169
refreshChartCache : boolean;

english/javascript-cpp/difsaveoptions/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class DifSaveOptions extends SaveOptions;
3434
| [createDirectory](#createDirectory--)| boolean | If true and the directory does not exist, the directory will be automatically created before saving the file. |
3535
| [sortNames](#sortNames--)| boolean | Indicates whether sorting defined names before saving file. |
3636
| [sortExternalNames](#sortExternalNames--)| boolean | Indicates whether sorting external defined names before saving file. |
37-
| [refreshChartCache](#refreshChartCache--)| boolean | Indicates whether refreshing chart cache data |
37+
| [refreshChartCache](#refreshChartCache--)| boolean | Indicates whether to cache the latest data of the chart. |
3838
| [warningCallback](#warningCallback--)| IWarningCallback | Gets or sets warning callback. |
3939
| [checkExcelRestriction](#checkExcelRestriction--)| boolean | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
4040
| [updateSmartArt](#updateSmartArt--)| boolean | Indicates whether updating smart art setting. The default value is false. |
@@ -153,7 +153,7 @@ sortExternalNames : boolean;
153153

154154
### refreshChartCache {#refreshChartCache--}
155155

156-
Indicates whether refreshing chart cache data
156+
Indicates whether to cache the latest data of the chart.
157157

158158
```javascript
159159
refreshChartCache : boolean;

0 commit comments

Comments
 (0)