has.createCanvasContext(string canvasId, Object this)
创建canvas的绘图上下文CanvasContext对象。
在ASCF运行时2.0.1版本之前,可以获取type="2d"的CanvasContext对象;2.0.1及后续版本,type="2d"类型canvas组件,请通过Canvas.getContext('2d')获取CanvasRenderingContext2D。
起始版本: 1.0.0
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| canvasId | string | 是 | 要获取上下文的canvas组件的canvas-id属性。 |
| this | Object | 否 | 在自定义组件下,当前组件实例的this,以操作组件内canvas组件。 起始版本: 1.0.13 |
返回值:
返回CanvasContext对象。
示例:
const ctx = has.createCanvasContext('firstCanvas'); has.canvasToTempFilePath(Object object, Object this)
把当前画布指定区域的内容导出生成指定大小的图片。在draw()回调里调用该方法才能保证图片导出成功。
起始版本: 1.0.0
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| object | Object | 是 | 需要指定的信息对象。 |
| this | Object | 否 | 在自定义组件下,当前组件实例的this,以操作组件内canvas组件。 |
object参数说明:
| 参数 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|
| x | number | 0 | 否 | 指定的画布区域的左上角横坐标。 |
| y | number | 0 | 否 | 指定的画布区域的左上角纵坐标。 |
| width | number | canvas宽度-x | 否 | 指定的画布区域的宽度。 |
| height | number | canvas高度-y | 否 | 指定的画布区域的高度。 |
| destWidth | number | width*屏幕像素密度 | 否 | 输出的图片的宽度。 |
| destHeight | number | height*屏幕像素密度 | 否 | 输出的图片的高度。 |
| canvasId | string | - | 是 | 画布标识,传入canvas组件的canvas-id。 |
| canvas | Object | - | 否 | 画布标识,传入canvas组件实例(canvas type="2d"时使用该属性),或传入OffscreenCanvas离屏画布实例。 |
| fileType | string | png | 否 | 目标文件的类型。 - jpg:jpg图片 - png:png图片。 |
| quality | number | - | 否 | 图片的质量,目前仅对jpg有效。取值范围为(0, 1],不在范围内时当作1.0处理。 |
| success | function | - | - | 接口调用成功的回调函数。 |
| fail | function | - | - | 接口调用失败的回调函数。 |
| complete | function | - | - | 接口调用结束的回调函数(调用成功、失败都会执行)。 |
success返回值:
| 参数 | 类型 | 描述 |
|---|---|---|
| tempFilePath | string | 生成文件的临时路径(本地路径)。 |
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 101 | applicationContext is undefined. |
| 102 | 1. Fail to init save canvas infos, params error. 2. Invalid dimensions. 3. initSaveCanvasInfo -> CanvasParams is undefined. |
| 13000401 | 1. Fail to create file. 2. canvasToTempFilePath -> Save canvas as file failed. |
示例:
has.canvasToTempFilePath({
x: 10,
y: 20,
width: 50,
height: 50,
destWidth: 80,
destHeight: 80,
canvasId: 'firstCanvas',
success: (res) => {
console.info('canvasToTempFilePath success', res);
},
fail: (err) => {
console.error('canvasToTempFilePath fail', err);
},
complete: (res) => {
console.info('canvasToTempFilePath complete', res);
}
}); has.canvasPutImageData(Object object, Object this)
将像素数据绘制到画布。
起始版本: 1.0.3
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| object | Object | 是 | 图像的像素数据。 |
| this | Object | 否 | 在自定义组件下,当前组件实例的this,以操作组件内canvas组件。 起始版本: 1.0.13 |
object参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| canvasId | string | 是 | 画布标识,传入canvas组件的canvas-id。 |
| data | Uint8ClampedArray | 是 | 图像像素点数据,一维数组,每四项表示一个像素点的rgba。 |
| x | number | 是 | 源图像数据在目标画布中的位置偏移量(x轴方向的偏移量)。 |
| y | number | 是 | 源图像数据在目标画布中的位置偏移量(y轴方向的偏移量)。 |
| width | number | 是 | 源图像数据矩形区域的宽度。 |
| height | number | 是 | 源图像数据矩形区域的高度。 |
| success | function | 否 | 接口调用成功的回调函数。 |
| fail | function | 否 | 接口调用失败的回调函数。 |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行)。 |
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 102 | 1. canvas is empty. 2. params is illegal. 3. params is illegal. The pixel data does not match the number of pixels. pixel data length. |
| 13000601 | canvasPutImageData -> fail to put image data. |
示例:
const data = new Uint8ClampedArray([255, 0, 0, 1]);
has.canvasPutImageData({
canvasId: 'myCanvas',
x: 0,
y: 0,
width: 1,
height: 1,
data: data,
success: (res) => {
console.info('canvasPutImageData success', res);
},
fail: (err) => {
console.error('canvasPutImageData fail', err);
},
complete: (res) => {
console.info('canvasPutImageData complete', res);
}
}); has.canvasGetImageData(Object object, Object this)
获取canvas区域隐含的像素数据。
起始版本: 1.0.3
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| object | Object | 是 | 图像的像素数据。 |
| this | Object | 否 | 在自定义组件下,当前组件实例的this,以操作组件内canvas组件。 起始版本: 1.0.13 |
object参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| canvasId | string | 是 | 画布标识,传入canvas组件的canvas-id。 |
| x | number | 是 | 将要被提取的图像数据矩形区域的左上角横坐标。 |
| y | number | 是 | 将要被提取的图像数据矩形区域的左上角纵坐标。 |
| width | number | 是 | 将要被提取的图像数据矩形区域的宽度。 |
| height | number | 是 | 将要被提取的图像数据矩形区域的高度。 |
| success | function | 否 | 接口调用成功的回调函数。 |
| fail | function | 否 | 接口调用失败的回调函数。 |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行)。 |
success返回值:
返回ImageData对象。
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 102 | 1. canvas is empty. 2. params is illegal. |
| 13000501 | canvasGetImageData -> fail to get image data from canvas. |
示例:
has.canvasGetImageData({
canvasId: 'myCanvas',
x: 0,
y: 0,
width: 100,
height: 100,
success: (res) => {
console.info(res.width);
console.info(res.height);
console.info(res.data instanceof Uint8ClampedArray);
console.info(res.data.length);
},
fail: (err) => {
console.error('canvasGetImageData fail', err);
},
complete: (res) => {
console.info('canvasGetImageData complete', res);
}
}); has.createOffscreenCanvas(Object options): OffscreenCanvas
创建OffscreenCanvas离屏画布实例。离屏画布不绑定同层渲染组件,支持独立的2D绘图上下文和绘制操作,可与可见画布互操作。
起始版本: 2.0.6
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| options | Object | 是 | 离屏画布配置。 |
options参数说明:
| 参数 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|
| type | string | 2d | 是 | 创建的离屏画布类型。 |
| width | number | 300 | 否 | 画布宽度,单位px。取值范围0-1365。 |
| height | number | 150 | 否 | 画布高度,单位px。取值范围0-1365。 |
| compInst | Object | - | 否 | 在自定义组件下,当前组件实例的this。不传入则不绑定组件生命周期,随页面销毁自动清理。 |
返回值:
返回OffscreenCanvas对象。
示例:
const offscreenCanvas = has.createOffscreenCanvas({
type: '2d',
width: 300,
height: 150
});
const offCtx = offscreenCanvas.getContext('2d');
offCtx.fillStyle = 'red';
offCtx.fillRect(0, 0, 100, 100);
// 将离屏画布绘制到可见画布
has.createSelectorQuery().select('#myCanvas')
.node((res) => {
const canvas = res.node;
const ctx = canvas.getContext('2d');
ctx.drawImage(offscreenCanvas, 0, 0);
})
.exec();