@vvfx/sdk 0.1.19-alpha.10 → 0.1.19-alpha.12

package/dist/index.d.cts

@@ -1375,6 +1375,39 @@ declare enum FrameLayoutMode {
     AUTO = "auto",
     FREE = "free"
 }
+/**
+ * @description 自动布局配置
+ */
+type AutoLayoutConfig = {
+    /**
+     * @description 单行最大宽度（像素），超过后自动换行。未设置时不限制
+     */
+    maxRowWidth?: number;
+    /**
+     * @description 最大行数限制。未设置时不限制
+     */
+    maxRowCount?: number;
+};
+/**
+ * @description 元素在自动布局中的位置信息
+ */
+type LayoutInfo = {
+    /**
+     * @description 所在行号（可为小数）
+     * 整数部分：主行号（0, 1, 2...）
+     * 小数部分：分行后的子行号（如 1.5 表示第1行的第5个子行）
+     * 仅支持两层（即小数部分为 0-9）
+     */
+    row: number;
+    /**
+     * @description 所在列号（必须为整数）
+     */
+    column: number;
+    /**
+     * @description 元素在布局中的位置（相对于画板左上角，可选）
+     */
+    position?: [number, number];
+};
 /**
  * @description Frame 画板元素属性
  */
@@ -1387,6 +1420,15 @@ type FrameItemProperty = BaseItemProperty & {
      * @description 子元素ID数组
      */
     children: string[];
+    /**
+     * @description 自动布局配置
+     */
+    autoLayoutConfig?: AutoLayoutConfig;
+    /**
+     * @description 子元素布局位置信息（用于自动布局）
+     * key: 子元素ID, value: 元素的位置信息
+     */
+    layoutInfos?: Record<string, LayoutInfo>;
 };
 /**
  * @description BaseItem 基础属性键名
@@ -1739,7 +1781,7 @@ type SpriteCreateInfo = {
     };
 };
 /**
- * @description 空节点创建信息
+ * @description 组 元素创建信息
  */
 type GroupCreateInfo = {
     type: SDKItemType.GROUP;
@@ -2164,6 +2206,15 @@ type FrameCreateInfo = {
          * @description 子元素序号
          */
         children: string[];
+        /**
+         * @description 自动布局配置
+         */
+        autoLayoutConfig?: AutoLayoutConfig;
+        /**
+         * @description 子元素布局位置信息（用于自动布局）
+         * key: 子元素ID, value: 元素的位置信息
+         */
+        layoutInfos?: Record<string, LayoutInfo>;
     };
     /**
      * @description 扩展属性
@@ -2304,8 +2355,25 @@ type SDKConfig = {
         videoPlayGizmoConfig: VideoPlayGizmoConfig;
         itemCreateGizmoEnabled: boolean;
         itemCreateGizmoConfig: ItemCreateGizmoConfig;
+        /**
+         * @description 自动布局指示器配置
+         */
+        autoLayoutIndicatorConfig: AutoLayoutIndicatorConfig;
     };
 };
+/**
+ * @description 自动布局指示器配置
+ */
+type AutoLayoutIndicatorConfig = {
+    /**
+     * @description 指示线宽度
+     */
+    lineWidth: number;
+    /**
+     * @description 指示线颜色
+     */
+    lineColor: number;
+};
 /**
  * @description 页面功能配置
  */
@@ -3411,6 +3479,7 @@ declare class SDK {
     getItemCreateInfos(ids?: string[]): ItemCreateInfo[];
     createScreenShotSceneByIds(idInfo: string | string[], time?: number): Promise<string | undefined>;
     createScreenShotByFrame(id: string): Promise<string | undefined>;
+    createScreenShotByEffects(id: string): Promise<string | undefined>;
     getChildrenIds(id: string): string[];
     /**
      * @description 更新元素在图层中的顺序
@@ -3571,6 +3640,18 @@ declare class SDK {
     closeItemCreateGizmo(): void;
     setItemName(id: string, name: string): void;
     setSafeAreaPreviewVisible(id: number, type: 'url' | 'color', visible: boolean): void;
+    /**
+     * @description 修改画板元素大小
+     * @param id 元素id
+     * @param size 目标大小 [width, height]
+     * @param translation 位置偏移补偿（可选，用于保持拖拽角点固定）
+     */
+    resizeFrameItem(id: string, size: [number, number], translation?: [number, number]): void;
+    /**
+     * @description 对 FrameItem 执行自动布局（当 layoutMode 为 AUTO 时使用）
+     * @param frameId Frame 元素 ID
+     */
+    applyFrameAutoLayout(frameId: string): void;
 }
 
 export { type ActiveData, BaseItem, type BaseItemProperty, type BaseItemPropertyKey, type BaseItemPropertyValueMap, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type FrameCreateInfo, FrameItem, type FrameItemOptions, type FrameItemProperty, FrameLayoutMode, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GeneratorItemProperty, type GizmoType, type GroupCreateInfo, GroupItem, type GroupItemOptions, type ItemCreateInfo, ItemOrderAction, type ItemPropertyMap, type Operation, type PageData, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem, type SDKItemOptions, SDKItemType, type SDKOptions, type SetItemPropertyParam, type SetSingleItemMultiplePropertiesParam, type SetSingleItemSinglePropertyParam, type SpriteCreateInfo, SpriteItem, type SpriteItemOptions, type SpriteItemProperty, type TextCreateInfo, TextItem, type TextItemOptions, type TextItemProperty, type UpdateOperation, Vector2, type VideoCreateInfo, VideoItem, type VideoItemOptions, type VideoItemProperty, type ViewParam, type ViewProperty, createSDKItem, isBaseItem, isEffectsItem, isFrameItem, isGeneratorItem, isGroupItem, isSpriteItem, isTextItem, isVideoItem };

package/dist/index.d.ts

@@ -1375,6 +1375,39 @@ declare enum FrameLayoutMode {
     AUTO = "auto",
     FREE = "free"
 }
+/**
+ * @description 自动布局配置
+ */
+type AutoLayoutConfig = {
+    /**
+     * @description 单行最大宽度（像素），超过后自动换行。未设置时不限制
+     */
+    maxRowWidth?: number;
+    /**
+     * @description 最大行数限制。未设置时不限制
+     */
+    maxRowCount?: number;
+};
+/**
+ * @description 元素在自动布局中的位置信息
+ */
+type LayoutInfo = {
+    /**
+     * @description 所在行号（可为小数）
+     * 整数部分：主行号（0, 1, 2...）
+     * 小数部分：分行后的子行号（如 1.5 表示第1行的第5个子行）
+     * 仅支持两层（即小数部分为 0-9）
+     */
+    row: number;
+    /**
+     * @description 所在列号（必须为整数）
+     */
+    column: number;
+    /**
+     * @description 元素在布局中的位置（相对于画板左上角，可选）
+     */
+    position?: [number, number];
+};
 /**
  * @description Frame 画板元素属性
  */
@@ -1387,6 +1420,15 @@ type FrameItemProperty = BaseItemProperty & {
      * @description 子元素ID数组
      */
     children: string[];
+    /**
+     * @description 自动布局配置
+     */
+    autoLayoutConfig?: AutoLayoutConfig;
+    /**
+     * @description 子元素布局位置信息（用于自动布局）
+     * key: 子元素ID, value: 元素的位置信息
+     */
+    layoutInfos?: Record<string, LayoutInfo>;
 };
 /**
  * @description BaseItem 基础属性键名
@@ -1739,7 +1781,7 @@ type SpriteCreateInfo = {
     };
 };
 /**
- * @description 空节点创建信息
+ * @description 组 元素创建信息
  */
 type GroupCreateInfo = {
     type: SDKItemType.GROUP;
@@ -2164,6 +2206,15 @@ type FrameCreateInfo = {
          * @description 子元素序号
          */
         children: string[];
+        /**
+         * @description 自动布局配置
+         */
+        autoLayoutConfig?: AutoLayoutConfig;
+        /**
+         * @description 子元素布局位置信息（用于自动布局）
+         * key: 子元素ID, value: 元素的位置信息
+         */
+        layoutInfos?: Record<string, LayoutInfo>;
     };
     /**
      * @description 扩展属性
@@ -2304,8 +2355,25 @@ type SDKConfig = {
         videoPlayGizmoConfig: VideoPlayGizmoConfig;
         itemCreateGizmoEnabled: boolean;
         itemCreateGizmoConfig: ItemCreateGizmoConfig;
+        /**
+         * @description 自动布局指示器配置
+         */
+        autoLayoutIndicatorConfig: AutoLayoutIndicatorConfig;
     };
 };
+/**
+ * @description 自动布局指示器配置
+ */
+type AutoLayoutIndicatorConfig = {
+    /**
+     * @description 指示线宽度
+     */
+    lineWidth: number;
+    /**
+     * @description 指示线颜色
+     */
+    lineColor: number;
+};
 /**
  * @description 页面功能配置
  */
@@ -3411,6 +3479,7 @@ declare class SDK {
     getItemCreateInfos(ids?: string[]): ItemCreateInfo[];
     createScreenShotSceneByIds(idInfo: string | string[], time?: number): Promise<string | undefined>;
     createScreenShotByFrame(id: string): Promise<string | undefined>;
+    createScreenShotByEffects(id: string): Promise<string | undefined>;
     getChildrenIds(id: string): string[];
     /**
      * @description 更新元素在图层中的顺序
@@ -3571,6 +3640,18 @@ declare class SDK {
     closeItemCreateGizmo(): void;
     setItemName(id: string, name: string): void;
     setSafeAreaPreviewVisible(id: number, type: 'url' | 'color', visible: boolean): void;
+    /**
+     * @description 修改画板元素大小
+     * @param id 元素id
+     * @param size 目标大小 [width, height]
+     * @param translation 位置偏移补偿（可选，用于保持拖拽角点固定）
+     */
+    resizeFrameItem(id: string, size: [number, number], translation?: [number, number]): void;
+    /**
+     * @description 对 FrameItem 执行自动布局（当 layoutMode 为 AUTO 时使用）
+     * @param frameId Frame 元素 ID
+     */
+    applyFrameAutoLayout(frameId: string): void;
 }
 
 export { type ActiveData, BaseItem, type BaseItemProperty, type BaseItemPropertyKey, type BaseItemPropertyValueMap, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type FrameCreateInfo, FrameItem, type FrameItemOptions, type FrameItemProperty, FrameLayoutMode, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GeneratorItemProperty, type GizmoType, type GroupCreateInfo, GroupItem, type GroupItemOptions, type ItemCreateInfo, ItemOrderAction, type ItemPropertyMap, type Operation, type PageData, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem, type SDKItemOptions, SDKItemType, type SDKOptions, type SetItemPropertyParam, type SetSingleItemMultiplePropertiesParam, type SetSingleItemSinglePropertyParam, type SpriteCreateInfo, SpriteItem, type SpriteItemOptions, type SpriteItemProperty, type TextCreateInfo, TextItem, type TextItemOptions, type TextItemProperty, type UpdateOperation, Vector2, type VideoCreateInfo, VideoItem, type VideoItemOptions, type VideoItemProperty, type ViewParam, type ViewProperty, createSDKItem, isBaseItem, isEffectsItem, isFrameItem, isGeneratorItem, isGroupItem, isSpriteItem, isTextItem, isVideoItem };