ks.canvasToTempFilePath

更新时间：2024-09-18 14:46:36

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

canvasToTempFilePath(options: CanvasToTempFilePathOptions): Promise<CanvasToTempFilePathResult>

参数

参数	类型	必填
options	CanvasToTempFilePathOptions	是

CanvasToTempFilePathOptions

属性

属性	类型	默认值	必填	说明
x	number	0	否	指定的画布区域的左上角横坐标
y	number	0	否	指定的画布区域的左上角纵坐标
width	number		否	指定的画布区域的宽度
height	number		否	指定的画布区域的高度
destWidth	number		否	输出的图片的宽度
destHeight	number		否	输出的图片的高度
canvasId	string		否	canvas 组件的 canvas-id 属性
fileType	'jpg' | 'png'	'png'	否	目标文件的类型
quality	number		否	图片的质量，目前仅对 jpg 有效。取值范围为 (0, 1]，不在范围内时当作 1.0 处理
success	(result: CanvasToTempFilePathResult) => void		否	接口调用成功的回调函数
fail	(error: APIError) => void		否	接口调用失败的回调函数
complete	(resultOrError: CanvasToTempFilePathResult | APIError) => void		否	接口调用结束的回调函数（调用成功、失败都会执行）

返回值

Promise<CanvasToTempFilePathResult>

CanvasToTempFilePathResult

属性

属性	类型	说明
tempFilePath	string	生成文件的临时路径 (本地路径）

示例代码