@cesdk/engine 1.56.0-nightly.20250711 → 1.57.0-nightly.20250712

package/index.d.ts

@@ -1936,7 +1936,7 @@ export declare class BlockAPI {
      */
     supportsContentFillMode(id: DesignBlockId): boolean;
     /**
-     * Gets the width of a block.
+     * Gets the width of a block in the current width mode.
      *
      * ```javascript
      * const width = engine.block.getWidth(block);
@@ -1960,7 +1960,7 @@ export declare class BlockAPI {
      */
     getWidthMode(id: DesignBlockId): SizeMode;
     /**
-     * Gets the height of a block.
+     * Gets the height of a block in the current height mode.
      *
      * ```javascript
      * const height = engine.block.getHeight(block);
@@ -2008,7 +2008,7 @@ export declare class BlockAPI {
         positionMode?: PositionMode;
     }): void;
     /**
-     * Update a block's width and optionally maintain the crop.
+     * Sets the width of a block in the current width mode.
      *
      * If the crop is maintained, the crop values will be automatically adjusted.
      *
@@ -2035,7 +2035,7 @@ export declare class BlockAPI {
      */
     setWidthMode(id: DesignBlockId, mode: SizeMode): void;
     /**
-     * Sets the height of a block.
+     * Sets the height of a block in the current height mode.
      *
      * If the crop is maintained, the crop values will be automatically adjusted.
      *
@@ -2799,7 +2799,7 @@ export declare class BlockAPI {
      */
     setCropScaleY(id: DesignBlockId, scaleY: number): void;
     /**
-     * Sets the crop rotation of a block.
+     * Sets the crop rotation of a block in radians.
      *
      * ```javascript
      * engine.block.setCropRotation(image, Math.PI);
@@ -2825,7 +2825,7 @@ export declare class BlockAPI {
      */
     setCropScaleRatio(id: DesignBlockId, scaleRatio: number): void;
     /**
-     * Sets the horizontal crop translation of a block.
+     * Sets the horizontal crop translation of a block in percentage of the crop frame width.
      *
      * ```javascript
      * engine.block.setCropTranslationX(image, -1.0);
@@ -2837,7 +2837,7 @@ export declare class BlockAPI {
      */
     setCropTranslationX(id: DesignBlockId, translationX: number): void;
     /**
-     * Sets the vertical crop translation of a block.
+     * Sets the vertical crop translation of a block in percentage of the crop frame height.
      *
      * ```javascript
      * engine.block.setCropTranslationY(image, 1.0);
@@ -2886,7 +2886,7 @@ export declare class BlockAPI {
      */
     getCropScaleY(id: DesignBlockId): number;
     /**
-     * Gets the crop rotation of a block.
+     * Gets the crop rotation of a block in radians.
      *
      * ```javascript
      * const cropRotation = engine.block.getCropRotation(image);
@@ -2910,7 +2910,7 @@ export declare class BlockAPI {
      */
     getCropScaleRatio(id: DesignBlockId): number;
     /**
-     * Gets the horizontal crop translation of a block.
+     * Gets the horizontal crop translation of a block in percentage of the crop frame width.
      *
      * ```javascript
      * const cropTranslationX = engine.block.getCropTranslationX(image);
@@ -2922,7 +2922,7 @@ export declare class BlockAPI {
      */
     getCropTranslationX(id: DesignBlockId): number;
     /**
-     * Gets the vertical crop translation of a block.
+     * Gets the vertical crop translation of a block in percentage of the crop frame height.
      *
      * ```javascript
      * const cropTranslationY = engine.block.getCropTranslationY(image);
@@ -2934,7 +2934,7 @@ export declare class BlockAPI {
      */
     getCropTranslationY(id: DesignBlockId): number;
     /**
-     * Adjusts the crop position and scale to fill the crop frame.
+     * Adjusts the crop position and scale of the given image block to fill its crop frame, while maintaining the position and size of the crop frame.
      *
      * ```javascript
      * const adjustedScaleRatio = engine.block.adjustCropToFillFrame(image, 1.0);
@@ -4069,7 +4069,7 @@ export declare class BlockAPI {
     /**
      * Enables or disables the placeholder function for a block.
      *
-     * When set to `true`, the placeholder capabilities are enabled in Adopter mode.
+     * When set to `true`, the given block becomes selectable by users and its placeholder capabilities are enabled in Adopter mode.
      *
      * ```javascript
      * engine.block.setPlaceholderEnabled(block, true);
@@ -4081,7 +4081,7 @@ export declare class BlockAPI {
      */
     setPlaceholderEnabled(id: DesignBlockId, enabled: boolean): void;
     /**
-     * Checks if the placeholder function for a block is enabled.
+     * Checks if the placeholder function for a block is enabled and can be selected by users in Adopter mode.
      *
      * ```javascript
      * const placeholderIsEnabled = engine.block.isPlaceholderEnabled(block);
@@ -4116,6 +4116,8 @@ export declare class BlockAPI {
     /**
      * Enables or disables the placeholder behavior for a block.
      *
+     * When its fill block is set to `true`, an image block will act as a placeholder, showing a control overlay and a replacement button.
+     *
      * ```javascript
      * engine.block.setPlaceholderBehaviorEnabled(block, true);
      * ```
@@ -4147,7 +4149,7 @@ export declare class BlockAPI {
      */
     hasPlaceholderControls(id: DesignBlockId): boolean;
     /**
-     * Checks if a block supports placeholder controls.
+     * Checks if a block supports placeholder controls, e.g. a control overlay and a replacement button.
      *
      * @category Block Placeholder
      * @param id - The block to query.