@cesdk/engine 1.11.0-preview.0 → 1.11.0-preview.2

package/index.d.ts

@@ -903,6 +903,24 @@ export declare class BlockAPI {
      * @returns The position and size of the bounding box.
      */
     getScreenSpaceBoundingBoxXYWH(ids: DesignBlockId[]): XYWH;
+    /**
+     * Align multiple blocks horizontally within their bounding box (or group) or a single block to its parent.
+     * @param ids - A non-empty array of block ids.
+     * @param alignment - How they should be aligned: left, right, or center
+     */
+    alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment: HorizontalBlockAlignment): void;
+    /**
+     * Align multiple blocks vertically within their bounding box (or group) or a single block to its parent.
+     * @param ids - A non-empty array of block ids.
+     * @param alignment - How they should be aligned: top, bottom, or center
+     */
+    alignVertically(ids: DesignBlockId[], verticalBlockAlignment: VerticalBlockAlignment): void;
+    /**
+     * Confirms that a given set of blocks can be aligned.
+     * @param ids - A non-empty array of block ids.
+     * @returns Whether the blocks can be aligned.
+     */
+    isAlignable(ids: DesignBlockId[]): boolean;
     /**
      * Scales the block and all of its children proportionally around the specified
      * relative anchor point.
@@ -2266,7 +2284,6 @@ export declare interface Configuration {
      */
     extensions: ConfigTypes.Extensions;
     core: ConfigTypes.Core;
-    scene: ConfigTypes.Scene;
     assetSources: ConfigTypes.AssetSources;
     presets: ConfigTypes.Presets;
     variables: ConfigTypes.Variables;
@@ -2355,12 +2372,11 @@ declare class CreativeEngine {
      * `base_url` defaults to 'https://cdn.img.ly/assets/v1'.
      * Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
      * assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
-     *
-     * @param baseURL - The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v1'`.
-     * @param excludeAssetSourceIds - A list of IDs, that will be ignored during load.
      */
     addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
+        /** The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v1'`. */
         baseURL?: string;
+        /** A list of IDs, that will be ignored during load. */
         excludeAssetSourceIds?: DefaultAssetSourceId[];
     }): Promise<void>;
     /**
@@ -2375,14 +2391,13 @@ declare class CreativeEngine {
      * - `'ly.img.audio.upload'` - Demo source to upload audio assets
      * - `'ly.img.video'` - Sample videos
      * - `'ly.img.video.upload'` - Demo source to upload video assets
-     *
-     * @param excludeAssetSourceIds - A list of IDs, that will be ignored during load.
-     * @param sceneMode - if 'Video' video specific demo asset sources will be loaded as well (default 'Design')
-     * @param withUploadAssetSources - if 'true' asset sources for uploads are added (default false)
      */
     addDemoAssetSources({ excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
+        /** A list of IDs, that will be ignored during load */
         excludeAssetSourceIds?: DemoAssetSourceId[];
+        /** If 'Video' video specific demo asset sources will be loaded as well (default 'Design') */
         sceneMode?: SceneMode;
+        /** If 'true' asset sources for uploads are added (default false) */
         withUploadAssetSources?: boolean;
     }): Promise<void>;
 
@@ -2793,7 +2808,7 @@ declare type Extensions = {
 /**
  * @public
  */
-export declare type FillType = 'Solid' | 'Gradient' | 'Video';
+export declare type FillType = 'Solid' | 'Gradient' | 'Video' | 'Image';
 
 /** @public */
 declare interface FindAssetsQuery {
@@ -2869,6 +2884,15 @@ declare type HexColorString = string;
  */
 export declare type HistoryId = number;
 
+/**
+ * - Left: The blocks get left aligned.
+ * - Right: The blocks get right aligned.
+ * - Center: The blocks get center aligned.
+ *
+ * @public
+ */
+export declare type HorizontalBlockAlignment = 'Left' | 'Right' | 'Center';
+
 /** @public */
 export declare type HorizontalTextAlignment = 'Left' | 'Right' | 'Center';
 
@@ -2921,6 +2945,7 @@ declare enum MimeType_2 {
     Jpeg = "image/jpeg",
     Tga = "image/x-tga",
     Mp4 = "video/mp4",
+    QuickTime = "video/quicktime",
     Binary = "application/octet-stream",
     Pdf = "application/pdf",
     Zip = "application/zip"
@@ -2948,6 +2973,13 @@ export declare interface OldConfiguration {
      * - `setSettingBool('page/title/dimOutOfPageAreas', dim)`
      */
     page?: Page;
+    /**
+     * @deprecated This type definition has been removed
+     * The settings that were configured here can be set via the
+     * BlockApi on the scene block
+     * @public
+     */
+    scene?: Scene;
 }
 
 /**
@@ -3129,23 +3161,26 @@ export declare interface RGBColor {
 export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
 
 /**
- * Export Settings
+ * @deprecated This type definition is not used anymore and will be removed
+ * in the future. The settings that were configured here can be set via the
+ * BlockApi on the scene block:
+ *
+ * ```ts
+ * engine.block.setInt(sceneId, 'scene/dpi', dpi);
+ * engine.block.setInt(sceneId, 'scene/pixelScaleFactor', factor);
+ * ```
+ *
  * @public
  */
 declare type Scene = {
     /**
-     * The DPI value to use when exporting and when converting between pixels and inches or millimeter units.
-     * (In the CESDK, this value is synonymous with PPI).
-     *
-     * This is only relevant for new scenes that are created in the editor. Loaded scenes will use the
-     * value stored in their serialization file.
+     * @deprecated Setting this value has no effect. You can change the dpi of the
+     * current scene via `engine.block.setInt(sceneId, 'scene/dpi', dpi)`
      */
     dpi: number;
     /**
-     * A scale factor that is applied to the final export resolution.
-     *
-     * This is only relevant for new scenes that are created in the editor. Loaded scenes will use the
-     * value stored in their serialization file.
+     * @deprecated Setting this value has no effect. You can change the dpi of the
+     * current scene via `engine.block.setInt(sceneId, 'scene/pixelScaleFactor', * factor)`
      */
     pixelScaleFactor: number;
 };
@@ -3516,6 +3551,15 @@ export declare interface Vec4 {
     w: number;
 }
 
+/**
+ * - Top: The blocks get top aligned.
+ * - Bottom: The blocks get bottom aligned.
+ * - Center: The blocks get center aligned.
+ *
+ * @public
+ */
+export declare type VerticalBlockAlignment = 'Top' | 'Bottom' | 'Center';
+
 /** @public */
 export declare type VerticalTextAlignment = 'Top' | 'Bottom' | 'Center';