把当前画布指定区域的内容导出生成指定大小的图片。在 draw() 回调里调用该方法才能保证图片导出成功。

Bug & Tip：

  1. tip: 在 draw 回调里调用该方法才能保证图片导出成功。

参考文档

类型

  1. (option: Option, component?: Record<string, any>) => Promise<SuccessCallbackResult>

参数

Option

参数类型默认值必填说明
canvasCanvasProps否画布标识，传入 canvas 组件实例 （canvas type=”2d” 时使用该属性）。
canvasIdstring是画布标识，传入 canvas 组件的 canvas-id
qualitynumber否图片的质量，目前仅对 jpg 有效。取值范围为 (0, 1]，不在范围内时当作 1.0 处理。
complete(res: CallbackResult) => void否接口调用结束的回调函数（调用成功、失败都会执行）
destHeightnumber否输出的图片的高度
destWidthnumber否输出的图片的宽度
fail(res: CallbackResult) => void否接口调用失败的回调函数
fileType“jpg” | “png”“png”否目标文件的类型
heightnumber否指定的画布区域的高度
success(result: SuccessCallbackResult) => void否接口调用成功的回调函数
widthnumber否指定的画布区域的宽度
xnumber否指定的画布区域的左上角横坐标
ynumber否指定的画布区域的左上角纵坐标

SuccessCallbackResult

参数类型说明
tempFilePathstring生成文件的临时路径
errMsgstring调用结果

fileType

参数说明
jpgjpg 图片
pngpng 图片

CanvasProps

参数类型默认值必填说明
typestring否指定 canvas 类型，支持 2d 和 webgl
canvasIdstring否canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性
disableScrollbooleanfalse否当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新
onTouchStartCommonEventFunction<any>否手指触摸动作开始
onTouchMoveCommonEventFunction<any>否手指触摸后移动
onTouchEndCommonEventFunction<any>否手指触摸动作结束
onTouchCancelCommonEventFunction<any>否手指触摸动作被打断，如来电提醒，弹窗
onLongTapCommonEventFunction<any>否手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动
onErrorCommonEventFunction<onErrorEventDetail>否当发生错误时触发 error 事件，detail = {{errMsg: 'something wrong'}}

onErrorEventDetail

参数类型
errMsgstring

示例代码

  1. Taro.canvasToTempFilePath({
  2.   x: 100,
  3.   y: 200,
  4.   width: 50,
  5.   height: 50,
  6.   destWidth: 100,
  7.   destHeight: 100,
  8.   canvasId: 'myCanvas',
  9.   success: function (res) {
  10.     console.log(res.tempFilePath)
  11.   }
  12. })

API 支持度

API微信小程序H5React Native
Taro.canvasToTempFilePath✔️✔️