Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
bab71a1f
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
bab71a1f
编写于
5月 24, 2023
作者:
O
openharmony_ci
提交者:
Gitee
5月 24, 2023
浏览文件
操作
浏览文件
下载
差异文件
!18557 补充componentSnapshot说明
Merge pull request !18557 from 周沺耳/master
上级
406c2abf
601961cd
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
23 addition
and
1 deletion
+23
-1
zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md
...ion-dev/reference/apis/js-apis-arkui-componentSnapshot.md
+23
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md
浏览文件 @
bab71a1f
# @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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录