asposeslidescloud 22.3.0 → 22.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,97 +1,131 @@
1
- ![](https://img.shields.io/badge/api-v3.0-lightgrey) ![npm](https://img.shields.io/npm/v/asposeslidescloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/asposeslidescloud) ![node-current](https://img.shields.io/node/v/asposeslidescloud) ![npm type definitions](https://img.shields.io/npm/types/asposeslidescloud) [![GitHub license](https://img.shields.io/github/license/aspose-slides-cloud/aspose-slides-cloud-nodejs)](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs/blob/master/LICENSE)
2
-
3
- # Nodejs REST API to Process Presentation in Cloud
4
- This repository contains Aspose.Slides Cloud SDK for Nodejs source code. This SDK allows you to [process & manipulate PPT, PPTX, ODP, OTP](https://products.aspose.cloud/slides/nodejs) using Aspose.slides Cloud REST APIs in your Nodejs applications.
5
-
6
- You may want to check out Aspose free [PPT to PDF](https://products.aspose.app/slides/conversion), [PPT to Word](https://products.aspose.app/slides/conversion/ppt-to-word), and [PPT to JPG](https://products.aspose.app/slides/conversion/ppt-to-jpg) converters because they are live implementations of popular conversion processes.
7
-
8
- ## Presentation Processing Features
9
-
10
- - Fetch presentation images in any of the supported file formats.
11
- - Copy the layout side or clone the master slide from the source presentation.
12
- - Process slides shapes, slides notes, placeholders, colors & font theme info.
13
- - Programmatically create a presentation from HTML & export it to various formats.
14
- - Merge multiple presentations or split the single presentation into multiple ones.
15
- - Extract and replace text from a specific slide or an entire presentation.
16
-
17
- ## Read & Write Presentation Formats
18
-
19
- **Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX, PPTM, PPSM, POTX, POTM
20
- **OpenOffice:** ODP, OTP, FODP
21
- **Other**: PDF, PDF/A
22
-
23
- ## Save Presentation As
24
-
25
- **Fixed Layout:** XPS
26
- **Images:** JPEG, PNG, BMP, TIFF, GIF, SVG
27
- **Web:** HTML/HTML5
28
- **Other:** MPEG4, SWF (export whole presentations)
29
-
30
- ## Enhancements in Version 22.3
31
- * Added **ModernSlideComment** class to support modern comments. Also added **SlideCommentBase** as base class for comments.
32
- * Added optional **shapeIndex** parameter to **CreateComment** and **CreateCommentOnline** methods.
33
- * Added **GetParagraphRectangle**, **GetPortionRectangle** method and new **TextBounds** class to get paragraph or portion bounds.
34
- * Added optional **shapeType** parameter for **GetShapes** method. You can now get list of shapes of a particular type (e.g. charts or tables).
35
- * Added **FontFallbackRules** class and **FontFallbackRules** property to **ExportOptions** class.
36
- * Added **LatinFont**, **EastAsianFont** and **ComplexScriptFont** properties to **Portion** class to enable getting and seting portion font name.
37
- * Added **ChartLinesFormat** class; added **MajorGridLinesFormat** and **MinorGridLinesFormat** properties to Axis class.
38
- * Added **HideLegend** boolean property to **Legend** class.
39
-
40
- ## Enhancements in Version 22.2
41
- * Added **Mpeg4** to the list of allowed values for **ExportFormat** type. You can now convert presentations to video.
42
- * New **HighlightShapeText** and **HighlightShapeRegex** methods.
43
- * New **DeleteUnusedLayoutSlides** and **DeleteUnusedLayoutSlides** methods.
44
- * New **ZoomFrame** and **ZoomObject** classes with a number of subclasses.
45
- * Added **TextFrameFormat** property to **Shape** class to support WordArt.
46
- * Added **XYSeries** class as a supercalss for **ScatterSeries** and **BubbleSeries** methods.
47
- * Added **None** to the list of allowed values for **TimeUnitType** enum type.
48
- * **Level** property of **Category** class is deprecated and will be removed after v22.4.
49
-
50
- ## Enhancements in Version 22.1
51
- * New **MathParagraph** property of **Portion** class allows to get and set math formulas. A set of **MathElement** subclasses allows to specify complex mathematical expressions.
52
- * New **DownloadPortionAsMathMl** and **SavePortionAsMathMl** methods allow to export math formulas to MathML format.
53
- * New **HyperlinkClick** and **HyperlinkMouseOver** methods of **ShapeBase** and **Portion** classes enable creation and manipulating hyperlinks for shapes and portions.
54
- * New methods **GetShapeGeometryPath** and **SetShapeGeometryPath** can be used to get or set geometry paths for shapes. You can use lines, arcs and curves to specify custom shape boundaries.
55
- * New **AlignSubshapes** method enables aligning shapes within a shape group.
56
- * New **PlayAcrossSlides** and **RewindAudio** properties are added to **AudioFrame** class.
57
- * Added **InClickSequence** to the list of allowable values for **AudioPlayModePreset** and **AudioPlayModePreset** enum types.
58
-
59
- ## Licensing
60
- All Aspose.Slides Cloud SDKs are licensed under MIT License.
61
-
62
- ## How to use the SDK?
63
- The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [NPM package](https://www.npmjs.com/package/asposeslidescloud) (recommended).
64
-
65
- ## Prerequisites
66
- To use Aspose Slides Cloud NodeJS SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
67
-
68
- ### Installation
69
-
70
- From the command line:
71
-
72
- npm install asposeslidescloud --save
73
-
74
- ### Sample usage
75
-
76
- The example code below converts a PowerPoint document to PDF format using asposeslidescloud library:
77
- ```js
78
- const api = require("asposeslidescloud");
79
- const fs = require('fs');
80
-
81
- const slidesApi = new api.SlidesApi("MyClientId", "MyClientSecret");
82
- slidesApi.convert(fs.createReadStream("MyPresentation.pptx"), 'pdf').then((response) => {
83
- fs.writeFile("MyPresentation.pdf", response.body, (err) => {
84
- if (err) throw err;
85
- });
86
- });
87
- ```
88
- You can check more [Examples](Examples) of using the SDK.
89
-
90
- ## Aspose.Slides Cloud SDKs in Popular Languages
91
-
92
- | .NET | Java | PHP | Python | Ruby | Node.js | Android | Swift|Perl|Go|
93
- |---|---|---|---|---|---|---|--|--|--|
94
- | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-dotnet) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-java) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-php) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-python) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-ruby) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-android) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-swift)|[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-perl) |[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-go) |
95
- | [NuGet](https://www.nuget.org/packages/Aspose.slides-Cloud/) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Composer](https://packagist.org/packages/aspose/slides-sdk-php) | [PIP](https://pypi.org/project/asposeslidescloud/) | [GEM](https://rubygems.org/gems/aspose_slides_cloud) | [NPM](https://www.npmjs.com/package/asposeslidescloud) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Cocoapods](https://cocoapods.org/pods/AsposeslidesCloud)|[Meta Cpan](https://metacpan.org/release/AsposeSlidesCloud-SlidesApi) | [Go.Dev](https://pkg.go.dev/github.com/aspose-slides-cloud/aspose-slides-cloud-go/) |
96
-
97
- [Product Page](https://products.aspose.cloud/slides/nodejs) | [Documentation](https://docs.aspose.cloud/display/slidescloud/Home) | [API Reference](https://apireference.aspose.cloud/slides/) | [Code Samples](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [Blog](https://blog.aspose.cloud/category/slides/) | [Free Support](https://forum.aspose.cloud/c/slides) | [Free Trial](https://dashboard.aspose.cloud/#/apps)
1
+ ![](https://img.shields.io/badge/api-v3.0-lightgrey) ![npm](https://img.shields.io/npm/v/asposeslidescloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/asposeslidescloud) ![node-current](https://img.shields.io/node/v/asposeslidescloud) ![npm type definitions](https://img.shields.io/npm/types/asposeslidescloud) [![GitHub license](https://img.shields.io/github/license/aspose-slides-cloud/aspose-slides-cloud-nodejs)](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs/blob/master/LICENSE)
2
+
3
+ # Nodejs REST API to Process Presentation in Cloud
4
+ This repository contains Aspose.Slides Cloud SDK for Nodejs source code. This SDK allows you to [process & manipulate PPT, PPTX, ODP, OTP](https://products.aspose.cloud/slides/nodejs) using Aspose.slides Cloud REST APIs in your Nodejs applications.
5
+
6
+ You may want to check out Aspose free [PPT to PDF](https://products.aspose.app/slides/conversion), [PPT to Word](https://products.aspose.app/slides/conversion/ppt-to-word), and [PPT to JPG](https://products.aspose.app/slides/conversion/ppt-to-jpg) converters because they are live implementations of popular conversion processes.
7
+
8
+ ## Presentation Processing Features
9
+
10
+ - Fetch presentation images in any of the supported file formats.
11
+ - Copy the layout side or clone the master slide from the source presentation.
12
+ - Process slides shapes, slides notes, placeholders, colors & font theme info.
13
+ - Programmatically create a presentation from HTML & export it to various formats.
14
+ - Merge multiple presentations or split the single presentation into multiple ones.
15
+ - Extract and replace text from a specific slide or an entire presentation.
16
+
17
+ ## Read & Write Presentation Formats
18
+
19
+ **Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX, PPTM, PPSM, POTX, POTM
20
+ **OpenOffice:** ODP, OTP, FODP
21
+ **Other**: PDF, PDF/A
22
+
23
+ ## Save Presentation As
24
+
25
+ **Fixed Layout:** XPS
26
+ **Images:** JPEG, PNG, BMP, TIFF, GIF, SVG
27
+ **Web:** HTML/HTML5
28
+ **Other:** MPEG4, SWF (export whole presentations)
29
+
30
+ ## Enhancements in Version 22.7
31
+
32
+ * Added **Html**, **Pdf**, **Xps**, **Pptx**, **Odp**, **Otp**, **Ppt**, **Pps**, **Ppsx**, **Pptm**, **Ppsm**, **Potx**, **Pot**, **Potm**, **Svg**, **Fodp**, **Xaml**, **Html5** to the list of allowed values for **SlideExportFormat** enum. You can now export slide notes to those formats.
33
+ * Added **Html5** to the list of allowed values for **SlideExportFormat** enum. You can now export individual slides to HTML5.
34
+ * Added **Url** to the list of allowed values for **PresentationToMerge.SourceEnum** enum. You can now merge presentations from external URLs.
35
+ * New **DeleteUnusedMasterSlides** and **DeleteUnusedMasterSlidesOnline** methods.
36
+ * New **SetChartAxis**, **SetChartLegend**, **SetChartWall** methods allow to moduly chart elements more conveniently.
37
+ * **UpdateChartSeriesGroup** method was renamed to **SetChartSeriesGroup**.
38
+
39
+ ## Enhancements in Version 22.6
40
+ * Added ned **GetSubshapeParagraphEffective**, **GetParagraphEffective** and **GetSubshapePortionEffective**, **GetPortionEffective** methods to retrieve actual format values for paragraphs and portions, whether they are inherited from parent entities or not.
41
+ * Password parameter is now optional for **GetProtectionProperties** method. So, you don't need to specify the password to check whether a presentation has a password.
42
+ * Added new **ChartSeriesGroup** class and **SeriesGroups** property to **Chart** class to enable managing chart series groups. Added new **UpdateChartSeriesGroup** method.
43
+ * Added **HasRoundedCorners** property to **Chart** class.
44
+ * Added **InvertIfNegative** property to **OneValueChartDataPoint** class.
45
+ * Changed **FormatScheme** class to return actual format values instead of resource links.
46
+
47
+ ## Enhancements in Version 22.5
48
+ * Added **Paragraphs** property to **SmartArtNode** class to enable getting and setting text for SmartArt nodes.
49
+ * Added **ImageTransformList** property to **PictureFill** class to enable setting image transform effects. Added **ImageTransformEffect** class and subclasses for different kind of of effects.
50
+ * Added **PictureFillFormat** property to **VideoFrame** class to enable setting poster image for video frames.
51
+ * Added **SlideIndex** and **ShapeIndex** properties to **ResourceUri** class to simplify retrieveing slide & shape indexes for resources.
52
+ * Removed redundant **BoxAndWhiskersSeries**, **WaterfallSeries** and **WaterfallChartDataPoint** classes.
53
+
54
+ ## Enhancements in Version 22.4
55
+ * Added **TransitionType** and **SlidesTransitionDuration** properties to **VideoExportOptions** class to enable creation videos with transitions.
56
+ * Added **DefaultPortionFormat** property to **Paragraph** class. Added new **PortionFormat** class.
57
+ * Added **EmbeddedFileBase64Data** and a number of other properties to **OleObjectFrame** class to enable creation of OLE Object frames.
58
+ * Added **AccessPermissions** class to support access permissions for PDF export.
59
+ * Added **PictureFillformat** property to **AudioFrame** class.
60
+ * Added **RowIndex** and **ColumnIndex** properties to **TableCell** class.
61
+ * Moved **Width** and **Height** properties from **ExportOptions** base class to the new **ImageExportOptionsBase class**. This is a superclass for **ImageExportOptions**, **GifExportOptions** and **TiffExportOptions** classes.
62
+ * Removed redundant **Shapes** property from **ShapeBase** class. It is only left for **GroupShape** class.
63
+
64
+ ## Enhancements in Version 22.3
65
+ * Added **ModernSlideComment** class to support modern comments. Also added **SlideCommentBase** as base class for comments.
66
+ * Added optional **shapeIndex** parameter to **CreateComment** and **CreateCommentOnline** methods.
67
+ * Added **GetParagraphRectangle**, **GetPortionRectangle** method and new **TextBounds** class to get paragraph or portion bounds.
68
+ * Added optional **shapeType** parameter for **GetShapes** method. You can now get list of shapes of a particular type (e.g. charts or tables).
69
+ * Added **FontFallbackRules** class and **FontFallbackRules** property to **ExportOptions** class.
70
+ * Added **LatinFont**, **EastAsianFont** and **ComplexScriptFont** properties to **Portion** class to enable getting and seting portion font name.
71
+ * Added **ChartLinesFormat** class; added **MajorGridLinesFormat** and **MinorGridLinesFormat** properties to Axis class.
72
+ * Added **HideLegend** boolean property to **Legend** class.
73
+
74
+ ## Enhancements in Version 22.2
75
+ * Added **Mpeg4** to the list of allowed values for **ExportFormat** type. You can now convert presentations to video.
76
+ * New **HighlightShapeText** and **HighlightShapeRegex** methods.
77
+ * New **DeleteUnusedLayoutSlides** and **DeleteUnusedLayoutSlides** methods.
78
+ * New **ZoomFrame** and **ZoomObject** classes with a number of subclasses.
79
+ * Added **TextFrameFormat** property to **Shape** class to support WordArt.
80
+ * Added **XYSeries** class as a supercalss for **ScatterSeries** and **BubbleSeries** methods.
81
+ * Added **None** to the list of allowed values for **TimeUnitType** enum type.
82
+ * **Level** property of **Category** class is deprecated and will be removed after v22.4.
83
+
84
+ ## Enhancements in Version 22.1
85
+ * New **MathParagraph** property of **Portion** class allows to get and set math formulas. A set of **MathElement** subclasses allows to specify complex mathematical expressions.
86
+ * New **DownloadPortionAsMathMl** and **SavePortionAsMathMl** methods allow to export math formulas to MathML format.
87
+ * New **HyperlinkClick** and **HyperlinkMouseOver** methods of **ShapeBase** and **Portion** classes enable creation and manipulating hyperlinks for shapes and portions.
88
+ * New methods **GetShapeGeometryPath** and **SetShapeGeometryPath** can be used to get or set geometry paths for shapes. You can use lines, arcs and curves to specify custom shape boundaries.
89
+ * New **AlignSubshapes** method enables aligning shapes within a shape group.
90
+ * New **PlayAcrossSlides** and **RewindAudio** properties are added to **AudioFrame** class.
91
+ * Added **InClickSequence** to the list of allowable values for **AudioPlayModePreset** and **AudioPlayModePreset** enum types.
92
+
93
+ ## Licensing
94
+ All Aspose.Slides Cloud SDKs are licensed under MIT License.
95
+
96
+ ## How to use the SDK?
97
+ The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [NPM package](https://www.npmjs.com/package/asposeslidescloud) (recommended).
98
+
99
+ ## Prerequisites
100
+ To use Aspose Slides Cloud NodeJS SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
101
+
102
+ ### Installation
103
+
104
+ From the command line:
105
+
106
+ npm install asposeslidescloud --save
107
+
108
+ ### Sample usage
109
+
110
+ The example code below converts a PowerPoint document to PDF format using asposeslidescloud library:
111
+ ```js
112
+ const api = require("asposeslidescloud");
113
+ const fs = require('fs');
114
+
115
+ const slidesApi = new api.SlidesApi("MyClientId", "MyClientSecret");
116
+ slidesApi.convert(fs.createReadStream("MyPresentation.pptx"), 'pdf').then((response) => {
117
+ fs.writeFile("MyPresentation.pdf", response.body, (err) => {
118
+ if (err) throw err;
119
+ });
120
+ });
121
+ ```
122
+ You can check more [Examples](Examples) of using the SDK.
123
+
124
+ ## Aspose.Slides Cloud SDKs in Popular Languages
125
+
126
+ | .NET | Java | PHP | Python | Ruby | Node.js | Android | Swift|Perl|Go|
127
+ |---|---|---|---|---|---|---|--|--|--|
128
+ | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-dotnet) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-java) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-php) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-python) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-ruby) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-android) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-swift)|[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-perl) |[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-go) |
129
+ | [NuGet](https://www.nuget.org/packages/Aspose.slides-Cloud/) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Composer](https://packagist.org/packages/aspose/slides-sdk-php) | [PIP](https://pypi.org/project/asposeslidescloud/) | [GEM](https://rubygems.org/gems/aspose_slides_cloud) | [NPM](https://www.npmjs.com/package/asposeslidescloud) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Cocoapods](https://cocoapods.org/pods/AsposeslidesCloud)|[Meta Cpan](https://metacpan.org/release/AsposeSlidesCloud-SlidesApi) | [Go.Dev](https://pkg.go.dev/github.com/aspose-slides-cloud/aspose-slides-cloud-go/) |
130
+
131
+ [Product Page](https://products.aspose.cloud/slides/nodejs) | [Documentation](https://docs.aspose.cloud/display/slidescloud/Home) | [API Reference](https://apireference.aspose.cloud/slides/) | [Code Samples](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [Blog](https://blog.aspose.cloud/category/slides/) | [Free Support](https://forum.aspose.cloud/c/slides) | [Free Trial](https://dashboard.aspose.cloud/#/apps)
package/api.d.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  /// <reference types="node" />
2
+ /// <reference types="node" />
3
+ /// <reference types="node" />
2
4
  import http = require("http");
3
5
  import { Readable } from 'stream';
4
6
  import { Configuration } from "./internal/configuration";
@@ -1410,6 +1412,28 @@ export declare class SlidesApi {
1410
1412
  response: http.ServerResponse;
1411
1413
  body: Buffer;
1412
1414
  }>;
1415
+ /**
1416
+ * Removes unused master slides.
1417
+ * @param name Document name.
1418
+ * @param ignorePreserveField Determines, whether this method should remove unused master even if its preserve property is set to true.
1419
+ * @param password Document password.
1420
+ * @param folder Document folder.
1421
+ * @param storage Document storage.
1422
+ */
1423
+ deleteUnusedMasterSlides(name: string, ignorePreserveField?: boolean, password?: string, folder?: string, storage?: string): Promise<{
1424
+ response: http.ServerResponse;
1425
+ body: model.MasterSlides;
1426
+ }>;
1427
+ /**
1428
+ * Removes unused master slides.
1429
+ * @param document Document data
1430
+ * @param ignorePreserveField Determines, whether this method should remove unused master even if its preserve property is set to true.
1431
+ * @param password Document password.
1432
+ */
1433
+ deleteUnusedMasterSlidesOnline(document: Readable, ignorePreserveField?: boolean, password?: string): Promise<{
1434
+ response: http.ServerResponse;
1435
+ body: Buffer;
1436
+ }>;
1413
1437
  /**
1414
1438
  * Removes shapes with name \&quot;watermark\&quot; from the presentation.
1415
1439
  * @param name Document name.
@@ -1632,8 +1656,8 @@ export declare class SlidesApi {
1632
1656
  * @param slideIndex Slide index.
1633
1657
  * @param format Output file format.
1634
1658
  * @param options Export options.
1635
- * @param width Output file width; 0 to not adjust the size. Default is 0.
1636
- * @param height Output file height; 0 to not adjust the size. Default is 0.
1659
+ * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
1660
+ * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
1637
1661
  * @param password Document password.
1638
1662
  * @param folder Document folder.
1639
1663
  * @param storage Document storage.
@@ -1648,8 +1672,8 @@ export declare class SlidesApi {
1648
1672
  * @param document Document data.
1649
1673
  * @param slideIndex Slide index.
1650
1674
  * @param format Output file format.
1651
- * @param width Output file width; 0 to not adjust the size. Default is 0.
1652
- * @param height Output file height; 0 to not adjust the size. Default is 0.
1675
+ * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
1676
+ * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
1653
1677
  * @param password Document password.
1654
1678
  * @param storage Document storage.
1655
1679
  * @param fontsFolder Storage folder containing custom fonts to be used with the document.
@@ -1932,6 +1956,20 @@ export declare class SlidesApi {
1932
1956
  response: http.ServerResponse;
1933
1957
  body: model.Paragraph;
1934
1958
  }>;
1959
+ /**
1960
+ * Read effective paragraph info.
1961
+ * @param name Document name.
1962
+ * @param slideIndex Slide index.
1963
+ * @param shapeIndex Shape index.
1964
+ * @param paragraphIndex Paragraph index.
1965
+ * @param password Document password.
1966
+ * @param folder Document folder.
1967
+ * @param storage Document storage.
1968
+ */
1969
+ getParagraphEffective(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, password?: string, folder?: string, storage?: string): Promise<{
1970
+ response: http.ServerResponse;
1971
+ body: model.Paragraph;
1972
+ }>;
1935
1973
  /**
1936
1974
  * Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.
1937
1975
  * @param name Document name.
@@ -1999,6 +2037,21 @@ export declare class SlidesApi {
1999
2037
  response: http.ServerResponse;
2000
2038
  body: model.Portion;
2001
2039
  }>;
2040
+ /**
2041
+ * Read effective portion info.
2042
+ * @param name Document name.
2043
+ * @param slideIndex Slide index.
2044
+ * @param shapeIndex Shape index.
2045
+ * @param paragraphIndex Paragraph index.
2046
+ * @param portionIndex Portion index.
2047
+ * @param password Document password.
2048
+ * @param folder Document folder.
2049
+ * @param storage Document storage.
2050
+ */
2051
+ getPortionEffective(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, portionIndex: number, password?: string, folder?: string, storage?: string): Promise<{
2052
+ response: http.ServerResponse;
2053
+ body: model.Portion;
2054
+ }>;
2002
2055
  /**
2003
2056
  * Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.
2004
2057
  * @param name Document name.
@@ -2430,6 +2483,21 @@ export declare class SlidesApi {
2430
2483
  response: http.ServerResponse;
2431
2484
  body: model.Paragraph;
2432
2485
  }>;
2486
+ /**
2487
+ * Read effective paragraph info (for smart art and group shapes).
2488
+ * @param name Document name.
2489
+ * @param slideIndex Slide index.
2490
+ * @param path Shape path.
2491
+ * @param shapeIndex Shape index.
2492
+ * @param paragraphIndex Paragraph index.
2493
+ * @param password Document password.
2494
+ * @param folder Document folder.
2495
+ * @param storage Document storage.
2496
+ */
2497
+ getSubshapeParagraphEffective(name: string, slideIndex: number, path: string, shapeIndex: number, paragraphIndex: number, password?: string, folder?: string, storage?: string): Promise<{
2498
+ response: http.ServerResponse;
2499
+ body: model.Paragraph;
2500
+ }>;
2433
2501
  /**
2434
2502
  * Read shape paragraphs info (for smart art and group shapes).
2435
2503
  * @param name Document name.
@@ -2460,6 +2528,22 @@ export declare class SlidesApi {
2460
2528
  response: http.ServerResponse;
2461
2529
  body: model.Portion;
2462
2530
  }>;
2531
+ /**
2532
+ * Read effective portion info (for smart art and group shapes).
2533
+ * @param name Document name.
2534
+ * @param slideIndex Slide index.
2535
+ * @param path Shape path.
2536
+ * @param shapeIndex Shape index.
2537
+ * @param paragraphIndex Paragraph index.
2538
+ * @param portionIndex Portion index.
2539
+ * @param password Document password.
2540
+ * @param folder Document folder.
2541
+ * @param storage Document storage.
2542
+ */
2543
+ getSubshapePortionEffective(name: string, slideIndex: number, path: string, shapeIndex: number, paragraphIndex: number, portionIndex: number, password?: string, folder?: string, storage?: string): Promise<{
2544
+ response: http.ServerResponse;
2545
+ body: model.Portion;
2546
+ }>;
2463
2547
  /**
2464
2548
  * Read paragraph portions info (for smart art and group shapes).
2465
2549
  * @param name Document name.
@@ -2842,8 +2926,8 @@ export declare class SlidesApi {
2842
2926
  * @param format Output file format.
2843
2927
  * @param outPath Path to upload the output file to.
2844
2928
  * @param options Export options.
2845
- * @param width Output file width; 0 to not adjust the size. Default is 0.
2846
- * @param height Output file height; 0 to not adjust the size. Default is 0.
2929
+ * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
2930
+ * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
2847
2931
  * @param password Document password.
2848
2932
  * @param folder Document folder.
2849
2933
  * @param storage Document storage.
@@ -2858,8 +2942,8 @@ export declare class SlidesApi {
2858
2942
  * @param slideIndex Slide index.
2859
2943
  * @param format Output file format.
2860
2944
  * @param outPath Path to save result.
2861
- * @param width Output file width; 0 to not adjust the size. Default is 0.
2862
- * @param height Output file height; 0 to not adjust the size. Default is 0.
2945
+ * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
2946
+ * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
2863
2947
  * @param password Document password.
2864
2948
  * @param storage Document storage.
2865
2949
  * @param fontsFolder Storage folder containing custom fonts to be used with the document.
@@ -2968,6 +3052,65 @@ export declare class SlidesApi {
2968
3052
  response: http.ServerResponse;
2969
3053
  body: model.SlideBackground;
2970
3054
  }>;
3055
+ /**
3056
+ * Set chart axis.
3057
+ * @param name Document name.
3058
+ * @param slideIndex Slide index.
3059
+ * @param shapeIndex Shape index.
3060
+ * @param axisType Axis type. Horizontal, Vertical, SecondaryHorizontal or SecondaryVertical.
3061
+ * @param axis Axis DTO.
3062
+ * @param password Document password.
3063
+ * @param folder Document folder.
3064
+ * @param storage Document storage.
3065
+ */
3066
+ setChartAxis(name: string, slideIndex: number, shapeIndex: number, axisType: model.AxisType, axis: model.Axis, password?: string, folder?: string, storage?: string): Promise<{
3067
+ response: http.ServerResponse;
3068
+ body: model.Axis;
3069
+ }>;
3070
+ /**
3071
+ * Set chart axis.
3072
+ * @param name Document name.
3073
+ * @param slideIndex Slide index.
3074
+ * @param shapeIndex Shape index.
3075
+ * @param legend Chart legend DTO.
3076
+ * @param password Document password.
3077
+ * @param folder Document folder.
3078
+ * @param storage Document storage.
3079
+ */
3080
+ setChartLegend(name: string, slideIndex: number, shapeIndex: number, legend: model.Legend, password?: string, folder?: string, storage?: string): Promise<{
3081
+ response: http.ServerResponse;
3082
+ body: model.Legend;
3083
+ }>;
3084
+ /**
3085
+ * Set a series group in a chart.
3086
+ * @param name Document name.
3087
+ * @param slideIndex Slide index.
3088
+ * @param shapeIndex Shape index (must be a chart).
3089
+ * @param seriesGroupIndex Series group index.
3090
+ * @param seriesGroup Series group DTO.
3091
+ * @param password Document password.
3092
+ * @param folder Document folder.
3093
+ * @param storage Document storage.
3094
+ */
3095
+ setChartSeriesGroup(name: string, slideIndex: number, shapeIndex: number, seriesGroupIndex: number, seriesGroup: model.ChartSeriesGroup, password?: string, folder?: string, storage?: string): Promise<{
3096
+ response: http.ServerResponse;
3097
+ body: model.Chart;
3098
+ }>;
3099
+ /**
3100
+ * Set 3D chart wall.
3101
+ * @param name Document name.
3102
+ * @param slideIndex Slide index.
3103
+ * @param shapeIndex Shape index.
3104
+ * @param chartWallType Chart wall type: floor, sideWall or backWall.
3105
+ * @param chartWall Chart wall DTO.
3106
+ * @param password Document password.
3107
+ * @param folder Document folder.
3108
+ * @param storage Document storage.
3109
+ */
3110
+ setChartWall(name: string, slideIndex: number, shapeIndex: number, chartWallType: model.ChartWallType, chartWall: model.ChartWall, password?: string, folder?: string, storage?: string): Promise<{
3111
+ response: http.ServerResponse;
3112
+ body: model.ChartWall;
3113
+ }>;
2971
3114
  /**
2972
3115
  * Set document properties.
2973
3116
  * @param name Document name.