asposeslidescloud 22.4.0 → 22.8.0

package/README.md

@@ -27,6 +27,36 @@ You may want to check out Aspose free [PPT to PDF](https://products.aspose.app/s
 **Web:** HTML/HTML5
 **Other:** MPEG4, SWF (export whole presentations)
 
+## Enhancements in Version 22.8
+
+* With new **GetFonts** and **GetFontsOnline** methods you can get a list for fonts used in the presentation.
+* Added new **SetEmbeddedFont**, **SetEmbeddedFontOnline**, **DeleteEmbeddedFont** and **DeleteEmbeddedFontOnline** methods to embed/unembed presentation fonts.
+* Added new **ImportImagesFromSvg** method to import SVG images as individual geometry shapes.
+
+## Enhancements in Version 22.7
+
+* 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.
+* Added **Html5** to the list of allowed values for **SlideExportFormat** enum. You can now export individual slides to HTML5.
+* Added **Url** to the list of allowed values for **PresentationToMerge.SourceEnum** enum. You can now merge presentations from external URLs.
+* New **DeleteUnusedMasterSlides** and **DeleteUnusedMasterSlidesOnline** methods.
+* New **SetChartAxis**, **SetChartLegend**, **SetChartWall** methods allow to moduly chart elements more conveniently.
+* **UpdateChartSeriesGroup** method was renamed to **SetChartSeriesGroup**.
+
+## Enhancements in Version 22.6
+* 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.
+* 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.
+* Added new **ChartSeriesGroup** class and **SeriesGroups** property to **Chart** class to enable managing chart series groups. Added new **UpdateChartSeriesGroup** method.
+* Added **HasRoundedCorners** property to **Chart** class.
+* Added **InvertIfNegative** property to **OneValueChartDataPoint** class.
+* Changed **FormatScheme** class to return actual format values instead of resource links.
+
+## Enhancements in Version 22.5
+* Added **Paragraphs** property to **SmartArtNode** class to enable getting and setting text for SmartArt nodes.
+* Added **ImageTransformList** property to **PictureFill** class to enable setting image transform effects. Added **ImageTransformEffect** class and subclasses for different kind of of effects.
+* Added **PictureFillFormat** property to **VideoFrame** class to enable setting poster image for video frames.
+* Added **SlideIndex** and **ShapeIndex** properties to **ResourceUri** class to simplify retrieveing slide & shape indexes for resources.
+* Removed redundant **BoxAndWhiskersSeries**, **WaterfallSeries** and **WaterfallChartDataPoint** classes.
+
 ## Enhancements in Version 22.4
 * Added **TransitionType** and **SlidesTransitionDuration** properties to **VideoExportOptions** class to enable creation videos with transitions.
 * Added **DefaultPortionFormat** property to **Paragraph** class. Added new **PortionFormat** class.

package/api.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import http = require("http");
 import { Readable } from 'stream';
 import { Configuration } from "./internal/configuration";
@@ -824,6 +826,28 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.DocumentProperties;
     }>;
+    /**
+     * Removes specified embedded font and returns presentation fonts info.
+     * @param name Document name.
+     * @param fontName Font name.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    deleteEmbeddedFont(name: string, fontName: string, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.FontsData;
+    }>;
+    /**
+     * Removes specified embedded font and returns presentation.
+     * @param document Document data.
+     * @param fontName Document name.
+     * @param password Document password.
+     */
+    deleteEmbeddedFontOnline(document: Readable, fontName: string, password?: string): Promise<{
+        response: http.ServerResponse;
+        body: Buffer;
+    }>;
     /**
      * Delete file
      * @param path File path e.g. '/folder/file.ext'
@@ -1410,6 +1434,28 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: Buffer;
     }>;
+    /**
+     * Removes unused master slides.
+     * @param name Document name.
+     * @param ignorePreserveField Determines, whether this method should remove unused master even if its             preserve property is set to true.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    deleteUnusedMasterSlides(name: string, ignorePreserveField?: boolean, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.MasterSlides;
+    }>;
+    /**
+     * Removes unused master slides.
+     * @param document Document data
+     * @param ignorePreserveField Determines, whether this method should remove unused master even if its             preserve property is set to true.
+     * @param password Document password.
+     */
+    deleteUnusedMasterSlidesOnline(document: Readable, ignorePreserveField?: boolean, password?: string): Promise<{
+        response: http.ServerResponse;
+        body: Buffer;
+    }>;
     /**
      * Removes shapes with name \&quot;watermark\&quot; from the presentation.
      * @param name Document name.
@@ -1632,8 +1678,8 @@ export declare class SlidesApi {
      * @param slideIndex Slide index.
      * @param format Output file format.
      * @param options Export options.
-     * @param width Output file width; 0 to not adjust the size. Default is 0.
-     * @param height Output file height; 0 to not adjust the size. Default is 0.
+     * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
+     * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
      * @param password Document password.
      * @param folder Document folder.
      * @param storage Document storage.
@@ -1648,8 +1694,8 @@ export declare class SlidesApi {
      * @param document Document data.
      * @param slideIndex Slide index.
      * @param format Output file format.
-     * @param width Output file width; 0 to not adjust the size. Default is 0.
-     * @param height Output file height; 0 to not adjust the size. Default is 0.
+     * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
+     * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
      * @param password Document password.
      * @param storage Document storage.
      * @param fontsFolder Storage folder containing custom fonts to be used with the document.
@@ -1826,6 +1872,26 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.FontScheme;
     }>;
+    /**
+     * Returns presentation fonts info.
+     * @param name Document name.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    getFonts(name: string, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.FontsData;
+    }>;
+    /**
+     * Returns presentation fonts info.
+     * @param document Document data.
+     * @param password Document password.
+     */
+    getFontsOnline(document: Readable, password?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.FontsData;
+    }>;
     /**
      * Read slide theme format scheme info.
      * @param name Document name.
@@ -1932,6 +1998,20 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.Paragraph;
     }>;
+    /**
+     * Read effective paragraph info.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param shapeIndex Shape index.
+     * @param paragraphIndex Paragraph index.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    getParagraphEffective(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Paragraph;
+    }>;
     /**
      * Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.
      * @param name Document name.
@@ -1999,6 +2079,21 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.Portion;
     }>;
+    /**
+     * Read effective portion info.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param shapeIndex Shape index.
+     * @param paragraphIndex Paragraph index.
+     * @param portionIndex Portion index.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    getPortionEffective(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, portionIndex: number, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Portion;
+    }>;
     /**
      * Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.
      * @param name Document name.
@@ -2430,6 +2525,21 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.Paragraph;
     }>;
+    /**
+     * Read effective paragraph info (for smart art and group shapes).
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param path Shape path.
+     * @param shapeIndex Shape index.
+     * @param paragraphIndex Paragraph index.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    getSubshapeParagraphEffective(name: string, slideIndex: number, path: string, shapeIndex: number, paragraphIndex: number, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Paragraph;
+    }>;
     /**
      * Read shape paragraphs info (for smart art and group shapes).
      * @param name Document name.
@@ -2460,6 +2570,22 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.Portion;
     }>;
+    /**
+     * Read effective portion info (for smart art and group shapes).
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param path Shape path.
+     * @param shapeIndex Shape index.
+     * @param paragraphIndex Paragraph index.
+     * @param portionIndex Portion index.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    getSubshapePortionEffective(name: string, slideIndex: number, path: string, shapeIndex: number, paragraphIndex: number, portionIndex: number, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Portion;
+    }>;
     /**
      * Read paragraph portions info (for smart art and group shapes).
      * @param name Document name.
@@ -2569,6 +2695,24 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.Document;
     }>;
+    /**
+     * Imports shapes from SVG file.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param image SVG image data.
+     * @param x The X coordinate of the imported group of shapes (0 is default if not specified).
+     * @param y The Y coordinate of the imported group of shapes (0 is default if not specified).
+     * @param width The width of the imported group of shapes (default is SVG image width).
+     * @param height The height of the imported group of shapes (default is SVG image width).
+     * @param shapes Indexes of shapes to import. All shapes are imported if not specified.
+     * @param password Document password.
+     * @param folder Presentation folder.
+     * @param storage Presentation storage.
+     */
+    importShapesFromSvg(name: string, slideIndex: number, image?: Readable, x?: number, y?: number, width?: number, height?: number, shapes?: Array<number>, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Shapes;
+    }>;
     /**
      * Merge the presentation with other presentations specified in the request parameter.
      * @param name Document name.
@@ -2842,8 +2986,8 @@ export declare class SlidesApi {
      * @param format Output file format.
      * @param outPath Path to upload the output file to.
      * @param options Export options.
-     * @param width Output file width; 0 to not adjust the size. Default is 0.
-     * @param height Output file height; 0 to not adjust the size. Default is 0.
+     * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
+     * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
      * @param password Document password.
      * @param folder Document folder.
      * @param storage Document storage.
@@ -2858,8 +3002,8 @@ export declare class SlidesApi {
      * @param slideIndex Slide index.
      * @param format Output file format.
      * @param outPath Path to save result.
-     * @param width Output file width; 0 to not adjust the size. Default is 0.
-     * @param height Output file height; 0 to not adjust the size. Default is 0.
+     * @param width The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.
+     * @param height The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.
      * @param password Document password.
      * @param storage Document storage.
      * @param fontsFolder Storage folder containing custom fonts to be used with the document.
@@ -2968,6 +3112,65 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.SlideBackground;
     }>;
+    /**
+     * Set chart axis.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param shapeIndex Shape index.
+     * @param axisType Axis type. Horizontal, Vertical, SecondaryHorizontal or SecondaryVertical.
+     * @param axis Axis DTO.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    setChartAxis(name: string, slideIndex: number, shapeIndex: number, axisType: model.AxisType, axis: model.Axis, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Axis;
+    }>;
+    /**
+     * Set chart axis.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param shapeIndex Shape index.
+     * @param legend Chart legend DTO.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    setChartLegend(name: string, slideIndex: number, shapeIndex: number, legend: model.Legend, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Legend;
+    }>;
+    /**
+     * Set a series group in a chart.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param shapeIndex Shape index (must be a chart).
+     * @param seriesGroupIndex Series group index.
+     * @param seriesGroup Series group DTO.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    setChartSeriesGroup(name: string, slideIndex: number, shapeIndex: number, seriesGroupIndex: number, seriesGroup: model.ChartSeriesGroup, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.Chart;
+    }>;
+    /**
+     * Set 3D chart wall.
+     * @param name Document name.
+     * @param slideIndex Slide index.
+     * @param shapeIndex Shape index.
+     * @param chartWallType Chart wall type: floor, sideWall or backWall.
+     * @param chartWall Chart wall DTO.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    setChartWall(name: string, slideIndex: number, shapeIndex: number, chartWallType: model.ChartWallType, chartWall: model.ChartWall, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.ChartWall;
+    }>;
     /**
      * Set document properties.
      * @param name Document name.
@@ -2993,6 +3196,30 @@ export declare class SlidesApi {
         response: http.ServerResponse;
         body: model.DocumentProperty;
     }>;
+    /**
+     * Embeds specified font and returns presentation fonts info.
+     * @param name Document name.
+     * @param fontName Document name.
+     * @param onlyUsed Only used characters will be embedded.
+     * @param password Document password.
+     * @param folder Document folder.
+     * @param storage Document storage.
+     */
+    setEmbeddedFont(name: string, fontName: string, onlyUsed?: boolean, password?: string, folder?: string, storage?: string): Promise<{
+        response: http.ServerResponse;
+        body: model.FontsData;
+    }>;
+    /**
+     * Embeds specified font and returns presentation.
+     * @param document Document data.
+     * @param fontName Font name.
+     * @param onlyUsed Only used characters will be embedded.
+     * @param password Document password.
+     */
+    setEmbeddedFontOnline(document: Readable, fontName: string, onlyUsed?: boolean, password?: string): Promise<{
+        response: http.ServerResponse;
+        body: Buffer;
+    }>;
     /**
      * Set header/footer the notes slide.
      * @param name Document name.