Version: next
Taro.canvasGetImageData(option, component)
获取 canvas 区域隐含的像素数据。
类型
(option: Option, component?: Record<string, any>) => Promise<SuccessCallbackResult>
参数
Option
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| canvasId | string | 是 | 画布标识，传入 canvas 组件的 canvas-id |
| height | number | 是 | 将要被提取的图像数据矩形区域的高度 |
| width | number | 是 | 将要被提取的图像数据矩形区域的宽度 |
| x | number | 是 | 将要被提取的图像数据矩形区域的左上角横坐标 |
| y | number | 是 | 将要被提取的图像数据矩形区域的左上角纵坐标 |
| complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
| success | (result: SuccessCallbackResult) => void | 否 | 接口调用成功的回调函数 |
SuccessCallbackResult
| 参数 | 类型 | 说明 |
|---|---|---|
| data | Uint8ClampedArray | 图像像素点数据，一维数组，每四项表示一个像素点的 rgba |
| height | number | 图像数据矩形的高度 |
| width | number | 图像数据矩形的宽度 |
| errMsg | string | 调用结果 |
示例代码
Taro.canvasGetImageData({
canvasId: 'myCanvas',
x: 0,
y: 0,
width: 100,
height: 100,
success: function (res) {
console.log(res.width) // 100
console.log(res.height) // 100
console.log(res.data instanceof Uint8ClampedArray) // true
console.log(res.data.length) // 100 * 100 * 4
}
})
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| Taro.canvasGetImageData | ✔️ | ✔️ |