canvas

基础库 1.0.0 开始支持，低版本需做兼容处理。

画布（2d 接口 v2.9.0 起支持同层渲染）。相关api：wx.createCanvasContext。

属性类型默认值必填说明最低版本
typestring否指定 canvas 类型，支持 2d (2.9.0) 和 webgl (2.7.0)2.7.0
canvas-idstring否canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性1.0.0
disable-scrollbooleanfalse否当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新1.0.0
bindtouchstarteventhandle否手指触摸动作开始1.0.0
bindtouchmoveeventhandle否手指触摸后移动1.0.0
bindtouchendeventhandle否手指触摸动作结束1.0.0
bindtouchcanceleventhandle否手指触摸动作被打断，如来电提醒，弹窗1.0.0
bindlongtapeventhandle否手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动1.0.0
binderroreventhandle否当发生错误时触发 error 事件，detail = {errMsg}1.0.0

Bug & Tip

  • tip：canvas 标签默认宽度300px、高度150px
  • tip：同一页面中的 canvas-id 不可重复，如果使用一个已经出现过的 canvas-id，该 canvas 标签对应的画布将被隐藏并不再正常工作
  • tip：请注意原生组件使用限制
  • tip：开发者工具中默认关闭了 GPU 硬件加速，可在开发者工具的设置中开启“硬件加速”提高 WebGL 的渲染性能
  • tip: WebGL 支持通过 getContext('webgl', { alpha: true }) 获取透明背景的画布
  • tip: Canvas 2D 需要显式设置画布宽高 (默认为 300x150)
  • bug: 避免设置过大的宽高，在安卓下会有crash的问题

示例代码

在开发者工具中预览效果下载)

  1. <!-- canvas.wxml -->
  2. <canvas style="width: 300px; height: 200px;" canvas-id="firstCanvas"></canvas>
  3. <!-- 当使用绝对定位时，文档流后边的 canvas 的显示层级高于前边的 canvas -->
  4. <canvas style="width: 400px; height: 500px;" canvas-id="secondCanvas"></canvas>
  5. <!-- 因为 canvas-id 与前一个 canvas 重复，该 canvas 不会显示，并会发送一个错误事件到 AppService -->
  6. <canvas style="width: 400px; height: 500px;" canvas-id="secondCanvas" binderror="canvasIdErrorCallback"></canvas>
  1. Page({
  2.   canvasIdErrorCallback: function (e) {
  3.     console.error(e.detail.errMsg)
  4.   },
  5.   onReady: function (e) {
  6.     // 使用 wx.createContext 获取绘图上下文 context
  7.     var context = wx.createCanvasContext('firstCanvas')
  9.     context.setStrokeStyle("#00ff00")
  10.     context.setLineWidth(5)
  11.     context.rect(0, 0, 200, 200)
  12.     context.stroke()
  13.     context.setStrokeStyle("#ff0000")
  14.     context.setLineWidth(2)
  15.     context.moveTo(160, 100)
  16.     context.arc(100, 100, 60, 0, 2 * Math.PI, true)
  17.     context.moveTo(140, 100)
  18.     context.arc(100, 100, 40, 0, Math.PI, false)
  19.     context.moveTo(85, 80)
  20.     context.arc(80, 80, 5, 0, 2 * Math.PI, true)
  21.     context.moveTo(125, 80)
  22.     context.arc(120, 80, 5, 0, 2 * Math.PI, true)
  23.     context.stroke()
  24.     context.draw()
  25.   }
  26. })

Canvas 2D 示例代码

在开发者工具中预览效果

  1.   <!-- canvas.wxml -->
  2.   <canvas type="2d" id="myCanvas"></canvas>
// canvas.js
Page({
  onReady() {
    const query = wx.createSelectorQuery()
    query.select('#myCanvas')
      .fields({ node: true, size: true })
      .exec((res) => {
        const canvas = res[0].node
        const ctx = canvas.getContext('2d')

        const dpr = wx.getSystemInfoSync().pixelRatio
        canvas.width = res[0].width * dpr
        canvas.height = res[0].height * dpr
        ctx.scale(dpr, dpr)

        ctx.fillRect(0, 0, 100, 100)
      })
  }
})

WebGL 示例代码

在开发者工具中预览效果

  <!-- canvas.wxml -->
  <canvas type="webgl" id="myCanvas"></canvas>

// canvas.js
Page({
  onReady() {
    const query = wx.createSelectorQuery()
    query.select('#myCanvas').node().exec((res) => {
      const canvas = res[0].node
      const gl = canvas.getContext('webgl')
      gl.clearColor(1, 0, 1, 1)
      gl.clear(gl.COLOR_BUFFER_BIT)
    })
  }
})