# Interface: Canvas
• Canvas()
# Properties
# height
• height: number
画布的高度
Returns: number
# width
• width: number
画布的宽度
Returns: number
# Methods
# getContext
▸ getContext(contextType: "2d"): CanvasRenderingContext2D
当前兼容平台<wx,qq> 当前兼容平台<wx,qq,cymini,web> 获取画布对象的绘图上下文
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
contextType | "2d" |
# 返回值:
▸ getContext(contextType: "webgl", contextAttributes?: Readonly‹object›): WebGLRenderingContext
当前兼容平台<wx,qq> 获取画布对象的绘图上下文
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
contextType | "webgl" | - |
contextAttributes? | Readonly‹object› | webgl 上下文属性，仅当 contextType 为 webgl 时有效 |
# 返回值:
# toDataURL
▸ toDataURL(): string
当前兼容平台<wx,qq> 把画布上的绘制内容以一个 data URI 的格式返回
# 返回值:
string
data URI 格式的字符串
# toTempFilePath
▸ toTempFilePath(params: ToTempFilePathParams): Promise‹ToTempFilePathRes›
当前兼容平台<wx,qq> 将当前 Canvas 保存为一个临时文件。 如果使用了开放数据域，则生成后的文件仅能被用于以下接口：mogs.saveImageToPhotosAlbum、mogs.shareAppMessage、mogs.onShareAppMessage
todo 对于 mogs 上面的文档说明是否成立？
# 参数:
| 属性 | 类型 |
|---|---|
params | ToTempFilePathParams |
ToTempFilePathParams
| 属性 | 类型 | 描述 |
|---|---|---|
destHeight? | number | 目标文件的高度，会将截取的部分拉伸或压缩至该数值 |
destWidth? | number | 目标文件的宽度，会将截取的部分拉伸或压缩至该数值 |
fileType? | "png" | "jpg" | 目标文件的类型 |
height? | number | 截取 canvas 的高度 |
quality? | number | jpg图片的质量，仅当 fileType 为 jpg 时有效。 取值范围为 0.0（最低）- 1.0（最高），不含 0。 不在范围内时当作 1.0 |
width? | number | 截取 canvas 的宽度 |
x? | number | 截取 canvas 的左上角横坐标 |
y? | number | 截取 canvas 的左上角纵坐标 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
# 返回值:
Promise‹ToTempFilePathRes›
# toTempFilePathSync
▸ toTempFilePathSync(): string
当前兼容平台<wx,qq> Canvas.toTempFilePath 的同步版本
# 返回值:
string
canvas 生成的临时文件路径 (本地路径)