提交 601961cd 编写于 作者: Z zhoutianer

add componentSnapshot comments

Signed-off-by: Nzhoutianer <zhoutianer@huawei.com>
Change-Id: I956f1e4fda8ae8aeee7817f199621c0d505b81ca
上级 6f2b0fca
# @ohos.arkui.componentSnapshot(组件截图)
本模块提供获取组件截图的能力,包括已加载的组件的截图和没有加载的组件的截图。
本模块提供获取组件截图的能力,包括已加载的组件的截图和没有加载的组件的截图。组件截图只能够截取组件大小的区域,如果组件的绘制超出了它的区域,或子组件的绘制超出了父组件的区域,这些在组件区域外绘制的内容不会在截图中呈现。
> **说明:**
>
......@@ -8,6 +8,7 @@
>
> 示例效果请以真机运行为准,当前 IDE 预览器不支持。
## 导入模块
```js
......@@ -20,6 +21,10 @@ get(id: string, callback: AsyncCallback<image.PixelMap>): void
获取已加载的组件的截图,传入组件的[ID 标识](../arkui-ts/ts-universal-attributes-component-id.md#组件标识),找到对应组件进行截图。通过回调返回结果。
> **说明:**
>
> 截图会获取最近一帧的绘制内容。如果在组件触发更新的同时调用截图,更新的渲染内容不会被截取到,截图会返回上一帧的绘制内容。
**系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:**
......@@ -71,6 +76,10 @@ get(id: string): Promise<image.PixelMap>
获取已加载的组件的截图,传入组件的[ID 标识](../arkui-ts/ts-universal-attributes-component-id.md#组件标识),找到对应组件进行截图。通过Promise返回结果。
> **说明:**
>
> 截图会获取最近一帧的绘制内容。如果在组件触发更新的同时调用截图,更新的渲染内容不会被截取到,截图会返回上一帧的绘制内容。
**系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:**
......@@ -134,6 +143,13 @@ createFromBuilder(builder: CustomBuilder, callback: AsyncCallback<image.PixelMap
在应用后台渲染CustomBuilder自定义组件,并输出其截图。通过回调返回结果。
> **说明:**
>
> 由于需要等待组件构建、渲染成功,离屏截图的回调有500ms以内的延迟。
>
> 部分执行耗时任务的组件可能无法及时在截图前加载完成,因此会截取不到加载成功后的图像。例如:加载网络图片的Image组件、Web组件。
**系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:**
......@@ -194,6 +210,12 @@ createFromBuilder(builder: CustomBuilder): Promise<image.PixelMap>
在应用后台渲染CustomBuilder自定义组件,并输出其截图。通过Promise返回结果。
> **说明:**
>
> 由于需要等待组件构建、渲染成功,离屏截图的回调有500ms以内的延迟。
>
> 部分执行耗时任务的组件可能无法及时在截图前加载完成,因此会截取不到加载成功后的图像。例如:加载网络图片的Image组件、Web组件。
**系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册