uni.canvasToTempFilePath(options, componentInstance)

把当前画布指定区域的内容导出生成指定大小的图片

canvasToTempFilePath 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
4.0	4.41	x	x	x

• 截图或海报需求，app平台view直接提供截图API，takesnapshot。

参数

名称	类型	必填	默认值	兼容性	描述
options	CanvasToTempFilePathOptions	是	-	Web 微信小程序 Android iOS HarmonyOS - - x x x
名称 类型 必备 默认值 兼容性 描述 x number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 画布x轴起点（默认0） y number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 画布y轴起点（默认0） width number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 画布宽度（默认为canvas宽度-x） height number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 画布高度（默认为canvas高度-y） destWidth number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 输出图片宽度（默认为 width * 屏幕像素密度） destHeight number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 输出图片高度（默认为 height * 屏幕像素密度） canvasId string 是 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 画布标识，传入 <canvas/> 的 canvas-id fileType string 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 目标文件的类型，默认为 'png' quality number 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 图片的质量，取值范围为 (0, 1]，不在范围内时当作1.0处理 success (result: CanvasToTempFilePathSuccess) => void 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 接口调用成功的回调函数 fail (result: UniError) => void 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 接口调用失败的回调函数 complete (result: any) => void 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x 接口调用结束的回调函数（调用成功、失败都会执行） canvas any 否 - Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x
componentInstance	any	是	-	Web 微信小程序 Android iOS HarmonyOS - - x x x

CanvasToTempFilePathSuccess 的属性值

名称	类型	必备	默认值	兼容性	描述
tempFilePath	string	是	-	Web 微信小程序 Android iOS HarmonyOS - 4.41 x x x	导出生成的图片路径
errMsg	string	否	-	Web 微信小程序 Android iOS HarmonyOS - - x x x

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

通用类型

GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	Web 微信小程序 Android iOS HarmonyOS - 4.41 - - -	错误信息