@cesdk/cesdk-js 1.7.0-alpha.2 → 1.7.0-alpha.3

package/index.d.ts

@@ -992,6 +992,99 @@ export declare class BlockAPI {
      * @deprecated Use `getStrokeWidth`.
      */
     getOutlineWidth(id: DesignBlockId): number;
+    /**
+     * Query if the given block has a drop shadow property.
+     * @param id - The block to query.
+     * @returns True if the block has a drop shadow property.
+     */
+    hasDropShadow(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the drop shadow of the given design block.
+     * @param id - The block whose drop shadow should be enabled or disabled.
+     * @param enabled - If true, the drop shadow will be enabled.
+     */
+    setDropShadowEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if the drop shadow of the given design block is enabled.
+     * @param id - The block whose drop shadow state should be queried.
+     * @returns True if the block's drop shadow is enabled.
+     */
+    isDropShadowEnabled(id: DesignBlockId): boolean;
+    /**
+     * Set the drop shadow color of the given design block.
+     * @param id - The block whose drop shadow color should be set.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setDropShadowColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the  drop shadow color of the given design block.
+     * @param id - The block whose background color should be queried.
+     * @returns The background color.
+     */
+    getDropShadowColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Set the drop shadow's X offset of the given design block.
+     * @param id - The block whose drop shadow's X offset should be set.
+     * @param xOffset - The X offset to be set.
+     */
+    setDropShadowXOffset(id: DesignBlockId, xOffset: number): void;
+    /**
+     * Get the drop shadow's X offset of the given design block.
+     * @param id - The block whose drop shadow's X offset should be queried.
+     * @returns The offset.
+     */
+    getDropShadowXOffset(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's Y offset of the given design block.
+     * @param id - The block whose drop shadow's Y offset should be set.
+     * @param yOffset - The X offset to be set.
+     */
+    setDropShadowYOffset(id: DesignBlockId, yOffset: number): void;
+    /**
+     * Get the drop shadow's Y offset of the given design block.
+     * @param id - The block whose drop shadow's Y offset should be queried.
+     * @returns The offset.
+     */
+    getDropShadowYOffset(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's blur radius on the X axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be set.
+     * @param xBlurRadius - The blur radius to be set.
+     */
+    setDropShadowXBlurRadius(id: DesignBlockId, xBlurRadius: number): void;
+    /**
+     * Get the drop shadow's blur radius on the X axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be queried.
+     * @returns The blur radius.
+     */
+    getDropShadowXBlurRadius(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's blur radius on the Y axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be set.
+     * @param yBlurRadius - The blur radius to be set.
+     */
+    setDropShadowYBlurRadius(id: DesignBlockId, yBlurRadius: number): void;
+    /**
+     * Get the drop shadow's blur radius on the Y axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be queried.
+     * @returns The blur radius.
+     */
+    getDropShadowYBlurRadius(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's clipping of the given design block. (Only applies to shapes.)
+     * @param id - The block whose drop shadow's clip should be set.
+     * @param clip - The drop shadow's clip to be set.
+     */
+    setDropShadowClip(id: DesignBlockId, clip: boolean): void;
+    /**
+     * Get the drop shadow's clipping of the given design block.
+     * @param id - The block whose drop shadow's clipping should be queried.
+     * @returns The drop shadow's clipping.
+     */
+    getDropShadowClip(id: DesignBlockId): boolean;
     /**
      * Query if the given block has fill color properties.
      * @param id - The block to query.
@@ -1011,6 +1104,12 @@ export declare class BlockAPI {
      * @returns An empty result on success, an error otherwise.
      */
     setFillEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Returns the block containing the fill properties of the given block.
+     * @param id - The block whose fill block should be returned.
+     * @returns The block that currently defines the given block's fill.
+     */
+    getFill(id: DesignBlockId): DesignBlockId;
     /**
      * Set the fill type of the given design block.
      * @param id - The block whose fill type should be set.
@@ -1123,6 +1222,36 @@ export declare class BlockAPI {
      * @returns the gradient's radius, an error otherwise.
      */
     getFillGradientRadius(id: DesignBlockId): number;
+    /**
+     * Set a metadata value of a block identified by a key.
+     * If the key does not exist, yet, it will be added.
+     * @param block - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     * @param value - The value to set.
+     */
+    setMetadata(id: DesignBlockId, key: string, value: string): void;
+    /**
+     * Get a metadata value of a block identified by a key.
+     * If the key does not exist, yet, this method will fail.
+     * @param block - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     * @returns the value associated with the key.
+     */
+    getMetadata(id: DesignBlockId, key: string): string;
+    /**
+     * Check if the block has metadata associated with the key.
+     * @param block - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     * @returns whether the key exists.
+     */
+    hasMetadata(id: DesignBlockId, key: string): boolean;
+    /**
+     * Remove metadata associated with the key from the given block.
+     * If the key does not exist, this method will fail.
+     * @param block - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     */
+    removeMetadata(id: DesignBlockId, key: string): void;
 }
 
 /**
@@ -1423,16 +1552,6 @@ export declare class EditorAPI {
      * @returns The text cursor's y position in screen space.
      */
     getTextCursorPositionInScreenSpaceY(): number;
-    /**
-     * Sets the zoom level of the scene.
-     * @param zoomLevel - The new zoom level.
-     */
-    setZoomLevel(zoomLevel?: number): void;
-    /**
-     * Query a camera zoom level.
-     * @returns The zoom level of the block's (main) camera.
-     */
-    getZoomLevel(): number;
     /**
      * Adds a new history state to the stack, if undoable changes were made.
      */
@@ -2098,6 +2217,31 @@ export declare class SceneAPI {
      * @returns A Promise that resolves once the template was applied or rejects if there was an error.
      */
     applyTemplateFromURL(url: string): Promise<void>;
+    /**
+     * Sets the zoom level of the active scene.
+     * Only has an effect if the zoom level is not handled by the UI.
+     *
+     * @param zoomLevel - The new zoom level.
+     */
+    setZoomLevel(zoomLevel?: number): void;
+    /**
+     * Query a camera zoom level of the active scene.
+     * @returns The zoom level of the block's camera.
+     */
+    getZoomLevel(): number;
+    /**
+     * Sets the zoom and focus to show a block.
+     * Only has an effect if the zoom level is not handled by the UI.
+     * Without padding, this results in a tight view on the block.
+     *
+     * @param id - The block that should be focussed on.
+     * @param paddingLeft - Optional padding in screen pixels to the left of the block.
+     * @param paddingTop - Optional padding in screen pixels to the top of the block.
+     * @param paddingRight - Optional padding in screen pixels to the right of the block.
+     * @param paddingBottom - Optional padding in screen pixels to the bottom of the block.
+     * @returns A promise that resolves once the zoom was set or rejects with an error otherwise.
+     */
+    zoomToBlock(id: DesignBlockId, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): Promise<void>;
     /**
      * Converts all values of the current scene into the given design unit.
      * @param designUnit - The new design unit of the scene

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cesdk/cesdk-js",
-  "version": "1.7.0-alpha.2",
+  "version": "1.7.0-alpha.3",
   "main": "./cesdk.umd.js",
   "types": "./index.d.ts",
   "homepage": "https://www.img.ly",