# Snapshot.takeSnapshot(Object object)

> 基础库 3.0.0 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：不支持
> 
> __小程序插件__：支持
> 
> __微信 鸿蒙 OS 版__：支持

> 相关文档: [snapshot](/miniprogram/dev/component/snapshot.md)

## 功能描述

对 snapshot 组件子树进行截图

## 参数

### Object object

| 属性 | 类型 | 默认值 | 必填 | 说明 |
| ---- | ---- | ------ | -------- | ---- |
| type | String |  | 是 | 截图导出类型，'file' 保存到临时文件目录或 'arraybuffer' 返回图片二进制数据，默认值为 'file' |
| format | String |  | 是 | 截图文件格式，'rgba' 或 'png'，默认值为 'png' |
| success | function |  | 否 | 接口调用成功的回调函数 |
| fail | function |  | 否 | 接口调用失败的回调函数 |
| complete | function |  | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |

#### object.success 回调函数
##### 参数

###### Object res

| 属性 | 类型 | 说明 |
| ---- | ---- | ---- |
| tempFilePath  | String | 截图保存的临时文件路径，当 type 为 file 该字段生效 |
| data  | ArrayBuffer | 截图对应的二进制数据，当 type 为 arraybuffer 该字段生效 |