ts-canvasrenderingcontext2d.md 97.6 KB
Newer Older
Z
zengyawen 已提交
1 2
# CanvasRenderingContext2D对象

L
lanyill 已提交
3 4
使用RenderingContext在Canvas组件上进行绘制,绘制对象可以是矩形、文本、图片等。

H
HelloCrease 已提交
5 6
> **说明:**
>
Z
zengyawen 已提交
7
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
Z
zengyawen 已提交
8 9


Z
zengyawen 已提交
10 11 12

## 接口

13
CanvasRenderingContext2D(settings?: RenderingContextSettings)
Z
zengyawen 已提交
14

Z
zhongjianfei 已提交
15 16
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
17 18
**参数:**

H
HelloCrease 已提交
19 20 21
| 参数名      | 参数类型                                     | 必填   | 参数描述                                     |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| settings | [RenderingContextSettings](#renderingcontextsettings) | 否    | 见[RenderingContextSettings](#renderingcontextsettings)。 |
Z
zengyawen 已提交
22 23 24 25


### RenderingContextSettings

26
RenderingContextSettings(antialias?: boolean)
Z
zengyawen 已提交
27

Y
yaoyuchi 已提交
28
用来配置CanvasRenderingContext2D对象的参数,包括是否开启抗锯齿。
Z
zengyawen 已提交
29

Z
zhongjianfei 已提交
30 31
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
32
**参数:**
Z
zengyawen 已提交
33

H
HelloCrease 已提交
34 35 36
| 参数名       | 参数类型    | 必填   | 参数描述                          |
| --------- | ------- | ---- | ----------------------------- |
| antialias | boolean | 否    | 表明canvas是否开启抗锯齿。<br>默认值:false |
Z
zengyawen 已提交
37 38 39 40


## 属性

H
HelloCrease 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
| 名称                                       | 类型                                       | 描述                                       |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| [fillStyle](#fillstyle)                  | string&nbsp;\|number<sup>10+</sup>&nbsp;\|[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 指定绘制的填充色。<br/>-&nbsp;类型为string时,表示设置填充区域的颜色。<br/>- 类型为number时,表示设置填充区域的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineWidth](#linewidth)                  | number                                   | 设置绘制线条的宽度。                               |
| [strokeStyle](#strokestyle)              | string&nbsp;\|number<sup>10+</sup>&nbsp;\|[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 设置描边的颜色。<br/>-&nbsp;类型为string时,表示设置描边使用的颜色。<br/>- 类型为number时,表示设置描边使用的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineCap](#linecap)                      | CanvasLineCap                            | 指定线端点的样式,可选值为:<br/>-&nbsp;'butt':线端点以方形结束。<br/>-&nbsp;'round':线端点以圆形结束。<br/>-&nbsp;'square':线端点以方形结束,该样式下会增加一个长度和线段厚度相同,宽度是线段厚度一半的矩形。<br/>默认值:'butt'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineJoin](#linejoin)                    | CanvasLineJoin                           | 指定线段间相交的交点样式,可选值为:<br/>-&nbsp;'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。<br/>-&nbsp;'bevel':在线段相连处使用三角形为底填充,&nbsp;每个部分矩形拐角独立。<br/>-&nbsp;'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。<br/>默认值:'miter'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [miterLimit](#miterlimit)                | number                                   | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。  <br/>默认值:10<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [font](#font)                            | string                                   | 设置文本绘制中的字体样式。<br/>语法:ctx.font='font-size&nbsp;font-family'<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列。<br/>语法:ctx.font='font-style&nbsp;font-weight&nbsp;font-size&nbsp;font-family'<br/>-&nbsp;font-style(可选),用于指定字体样式,支持如下几种样式:'normal','italic'。<br/>-&nbsp;font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal',&nbsp;'bold',&nbsp;'bolder',&nbsp;'lighter',&nbsp;100,&nbsp;200,&nbsp;300,&nbsp;400,&nbsp;500,&nbsp;600,&nbsp;700,&nbsp;800,&nbsp;900。<br/>-&nbsp;font-size(可选),指定字号和行高,单位支持px、vp。使用时需要添加单位。<br/>-&nbsp;font-family(可选),指定字体系列,支持如下几种类型:'sans-serif',&nbsp;'serif',&nbsp;'monospace'。<br/>默认值:'normal normal 14px sans-serif'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [textAlign](#textalign)                  | CanvasTextAlign                          | 设置文本绘制中的文本对齐方式,可选值为:<br/>-&nbsp;'left':文本左对齐。<br/>-&nbsp;'right':文本右对齐。<br/>-&nbsp;'center':文本居中对齐。<br/>-&nbsp;'start':文本对齐界线开始的地方。<br/>-&nbsp;'end':文本对齐界线结束的地方。<br/>ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。<br/>默认值:'left'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [textBaseline](#textbaseline)            | CanvasTextBaseline                       | 设置文本绘制中的水平对齐方式,可选值为:<br/>-&nbsp;'alphabetic':文本基线是标准的字母基线。<br/>-&nbsp;'top':文本基线在文本块的顶部。<br/>-&nbsp;'hanging':文本基线是悬挂基线。<br/>-&nbsp;'middle':文本基线在文本块的中间。<br/>-&nbsp;'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。<br/>-&nbsp;'bottom':文本基线在文本块的底部。&nbsp;与ideographic基线的区别在于ideographic基线不需要考虑下行字母。<br/>默认值:'alphabetic'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [globalAlpha](#globalalpha)              | number                                   | 设置透明度,0.0为完全透明,1.0为完全不透明。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineDashOffset](#linedashoffset)        | number                                   | 设置画布的虚线偏移量,精度为float。    <br/>默认值:0.0<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [globalCompositeOperation](#globalcompositeoperation) | string                                   | 设置合成操作的方式。类型字段可选值有'source-over','source-atop','source-in','source-out','destination-over','destination-atop','destination-in','destination-out','lighter','copy','xor'。<br/>默认值:'source-over'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowBlur](#shadowblur)                | number                                   | 设置绘制阴影时的模糊级别,值越大越模糊,精度为float。   <br/>默认值:0.0<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowColor](#shadowcolor)              | string                                   | 设置绘制阴影时的阴影颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowOffsetX](#shadowoffsetx)          | number                                   | 设置绘制阴影时和原有对象的水平偏移值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowOffsetY](#shadowoffsety)          | number                                   | 设置绘制阴影时和原有对象的垂直偏移值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean                                  | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 <br/>默认值:true<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [height](#height)                        | number                                   | 组件高度。 <br/>单位:vp<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [width](#width)                          | number                                   | 组件宽度。 <br/>单位:vp<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
62 63
| [imageSmoothingQuality](#imagesmoothingquality)       |[ImageSmoothingQuality](ts-appendix-enums.md#imagesmoothingquality8)     | imageSmoothingEnabled为true时,用于设置图像平滑度。<br/>默认值:ImageSmoothingQuality.low<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [direction](#direction)       | [CanvasDirection](ts-appendix-enums.md#canvasdirection8)    | 用于设置绘制文字时使用的文字方向。<br/>默认值:CanvasDirection.inherit<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
H
HelloCrease 已提交
64
| [filter](#filter)                        | string                                   | 用于设置图像的滤镜。支持的滤镜效果如下:<br/>- 'none': 无滤镜效果<br/>- 'blur':给图像设置高斯模糊<br/>- 'brightness':给图片应用一种线性乘法,使其看起来更亮或更暗<br/>- 'contrast':调整图像的对比度<br/>- 'grayscale':将图像转换为灰度图像<br/>- 'hue-rotate':给图像应用色相旋转<br/>- 'invert':反转输入图像<br/>- 'opacity':转化图像的透明程度<br/>- 'saturate':转换图像饱和度<br/>- 'sepia':将图像转换为深褐色<br/>默认值:'none'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Z
zengyawen 已提交
65

H
HelloCrease 已提交
66 67 68
> **说明:**
>
> fillStyle、shadowColor与 strokeStyle 中string类型格式为 'rgb(255, 255, 255)','rgba(255, 255, 255, 1.0)','\#FFFFFF'。
Z
zengyawen 已提交
69 70 71


### fillStyle
Z
zengyawen 已提交
72

H
geshi  
HelloCrease 已提交
73 74
```ts
// xxx.ets
Z
zengyawen 已提交
75 76 77
@Entry
@Component
struct FillStyleExample {
Y
yamila 已提交
78 79
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
80 81 82 83 84 85 86 87 88

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.fillStyle = '#0000ff'
L
lanyill 已提交
89
          this.context.fillRect(20, 20, 150, 100)
Z
zengyawen 已提交
90 91 92 93 94 95 96 97
        })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
98
![zh-cn_image_0000001238712411](figures/zh-cn_image_0000001238712411.png)
Z
zengyawen 已提交
99

Z
zengyawen 已提交
100 101

### lineWidth
Z
zengyawen 已提交
102

H
geshi  
HelloCrease 已提交
103 104
```ts
// xxx.ets
Z
zengyawen 已提交
105 106 107
@Entry
@Component
struct LineWidthExample {
Y
yamila 已提交
108 109
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
        this.context.lineWidth = 5
        this.context.strokeRect(25, 25, 85, 105)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
128 129
![zh-cn_image_0000001194192432](figures/zh-cn_image_0000001194192432.png)

Z
zengyawen 已提交
130

Z
zengyawen 已提交
131
### strokeStyle
Z
zengyawen 已提交
132

H
geshi  
HelloCrease 已提交
133 134
```ts
// xxx.ets
Z
zengyawen 已提交
135 136 137
@Entry
@Component
struct StrokeStyleExample {
Y
yamila 已提交
138 139
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.lineWidth = 10
          this.context.strokeStyle = '#0000ff'
          this.context.strokeRect(25, 25, 155, 105)
        })
    }
    .width('100%')
    .height('100%')
  }
}
```


Z
zengyawen 已提交
160 161 162 163
![zh-cn_image_0000001194352432](figures/zh-cn_image_0000001194352432.png)


### lineCap
Z
zengyawen 已提交
164

H
geshi  
HelloCrease 已提交
165 166
```ts
// xxx.ets
Z
zengyawen 已提交
167 168 169
@Entry
@Component
struct LineCapExample {
Y
yamila 已提交
170 171
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.lineWidth = 8
          this.context.beginPath()
          this.context.lineCap = 'round'
          this.context.moveTo(30, 50)
          this.context.lineTo(220, 50)
          this.context.stroke()
        })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
194 195
![zh-cn_image_0000001238952373](figures/zh-cn_image_0000001238952373.png)

Z
zengyawen 已提交
196

Z
zengyawen 已提交
197
### lineJoin
Z
zengyawen 已提交
198

H
geshi  
HelloCrease 已提交
199 200
```ts
// xxx.ets
Z
zengyawen 已提交
201 202 203
@Entry
@Component
struct LineJoinExample {
Y
yamila 已提交
204 205
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
        this.context.beginPath()
        this.context.lineWidth = 8
        this.context.lineJoin = 'miter'
        this.context.moveTo(30, 30)
        this.context.lineTo(120, 60)
        this.context.lineTo(30, 110)
        this.context.stroke()
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
229
![zh-cn_image_0000001194032454](figures/zh-cn_image_0000001194032454.png)
Z
zengyawen 已提交
230

Z
zengyawen 已提交
231 232

### miterLimit
Z
zengyawen 已提交
233

H
geshi  
HelloCrease 已提交
234 235
```ts
// xxx.ets
Z
zengyawen 已提交
236 237 238
@Entry
@Component
struct MiterLimit {
Y
yamila 已提交
239 240
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.lineWidth = 8
          this.context.lineJoin = 'miter'
          this.context.miterLimit = 3
          this.context.moveTo(30, 30)
          this.context.lineTo(60, 35)
          this.context.lineTo(30, 37)
          this.context.stroke()
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
264 265
![zh-cn_image_0000001239032409](figures/zh-cn_image_0000001239032409.png)

Z
zengyawen 已提交
266

Z
zengyawen 已提交
267
### font
Z
zengyawen 已提交
268

H
geshi  
HelloCrease 已提交
269 270
```ts
// xxx.ets
Z
zengyawen 已提交
271 272
@Entry
@Component
G
gmy 已提交
273
struct Fonts {
Y
yamila 已提交
274 275
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.font = '30px sans-serif'
          this.context.fillText("Hello World", 20, 60)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
294
![zh-cn_image_0000001193872488](figures/zh-cn_image_0000001193872488.png)
Z
zengyawen 已提交
295

Z
zengyawen 已提交
296 297

### textAlign
Z
zengyawen 已提交
298

H
geshi  
HelloCrease 已提交
299 300
```ts
// xxx.ets
Z
zengyawen 已提交
301 302
@Entry
@Component
Y
yaoyuchi 已提交
303
struct CanvasExample {
Y
yamila 已提交
304 305
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
        this.context.strokeStyle = '#0000ff'
        this.context.moveTo(140, 10)
        this.context.lineTo(140, 160)
        this.context.stroke()
        this.context.font = '18px sans-serif'
        this.context.textAlign = 'start'
        this.context.fillText('textAlign=start', 140, 60)
        this.context.textAlign = 'end'
        this.context.fillText('textAlign=end', 140, 80)
        this.context.textAlign = 'left'
        this.context.fillText('textAlign=left', 140, 100)
        this.context.textAlign = 'center'
        this.context.fillText('textAlign=center',140, 120)
        this.context.textAlign = 'right'
        this.context.fillText('textAlign=right',140, 140)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
337 338
![zh-cn_image_0000001238832385](figures/zh-cn_image_0000001238832385.png)

Z
zengyawen 已提交
339

Z
zengyawen 已提交
340
### textBaseline
Z
zengyawen 已提交
341

H
geshi  
HelloCrease 已提交
342 343
```ts
// xxx.ets
Z
zengyawen 已提交
344 345 346
@Entry
@Component
struct TextBaseline {
Y
yamila 已提交
347 348
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.strokeStyle = '#0000ff'
          this.context.moveTo(0, 120)
          this.context.lineTo(400, 120)
          this.context.stroke()
          this.context.font = '20px sans-serif'
          this.context.textBaseline = 'top'
          this.context.fillText('Top', 10, 120)
          this.context.textBaseline = 'bottom'
          this.context.fillText('Bottom', 55, 120)
          this.context.textBaseline = 'middle'
          this.context.fillText('Middle', 125, 120)
          this.context.textBaseline = 'alphabetic'
          this.context.fillText('Alphabetic', 195, 120)
          this.context.textBaseline = 'hanging'
          this.context.fillText('Hanging', 295, 120)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
380
![zh-cn_image_0000001238712413](figures/zh-cn_image_0000001238712413.png)
Z
zengyawen 已提交
381

Z
zengyawen 已提交
382 383

### globalAlpha
Z
zengyawen 已提交
384

H
geshi  
HelloCrease 已提交
385 386
```ts
// xxx.ets
Z
zengyawen 已提交
387 388 389
@Entry
@Component
struct GlobalAlpha {
Y
yamila 已提交
390 391
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
392 393 394 395 396 397 398 399
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
L
lanyill 已提交
400 401 402 403 404
          this.context.fillStyle = 'rgb(0,0,255)'
          this.context.fillRect(0, 0, 50, 50)
          this.context.globalAlpha = 0.4
          this.context.fillStyle = 'rgb(0,0,255)'
          this.context.fillRect(50, 50, 50, 50)
Z
zengyawen 已提交
405 406 407 408 409 410 411 412
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
413 414
![zh-cn_image_0000001194192434](figures/zh-cn_image_0000001194192434.png)

Z
zengyawen 已提交
415

Z
zengyawen 已提交
416
### lineDashOffset
Z
zengyawen 已提交
417

H
geshi  
HelloCrease 已提交
418 419
```ts
// xxx.ets
Z
zengyawen 已提交
420 421 422
@Entry
@Component
struct LineDashOffset {
Y
yamila 已提交
423 424
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
425 426 427 428 429 430 431 432 433 434
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.arc(100, 75, 50, 0, 6.28)
          this.context.setLineDash([10,20])
Y
yamila 已提交
435 436
          this.context.lineDashOffset = 10.0
          this.context.stroke()
Z
zengyawen 已提交
437 438 439 440 441 442 443 444
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
445 446 447 448 449
![zh-cn_image_0000001194352434](figures/zh-cn_image_0000001194352434.png)


### globalCompositeOperation

H
geshi  
HelloCrease 已提交
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
| 名称               | 描述                       |
| ---------------- | ------------------------ |
| source-over      | 在现有绘制内容上显示新绘制内容,属于默认值。   |
| source-atop      | 在现有绘制内容顶部显示新绘制内容。        |
| source-in        | 在现有绘制内容中显示新绘制内容。         |
| source-out       | 在现有绘制内容之外显示新绘制内容。        |
| destination-over | 在新绘制内容上方显示现有绘制内容。        |
| destination-atop | 在新绘制内容顶部显示现有绘制内容。        |
| destination-in   | 在新绘制内容中显示现有绘制内容。         |
| destination-out  | 在新绘制内容外显示现有绘制内容。         |
| lighter          | 显示新绘制内容和现有绘制内容。          |
| copy             | 显示新绘制内容而忽略现有绘制内容。        |
| xor              | 使用异或操作对新绘制内容与现有绘制内容进行融合。 |

```ts
// xxx.ets
Z
zengyawen 已提交
466 467 468
@Entry
@Component
struct GlobalCompositeOperation {
Y
yamila 已提交
469 470
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.fillStyle = 'rgb(255,0,0)'
          this.context.fillRect(20, 20, 50, 50)
          this.context.globalCompositeOperation = 'source-over'
          this.context.fillStyle = 'rgb(0,0,255)'
          this.context.fillRect(50, 50, 50, 50)
          this.context.fillStyle = 'rgb(255,0,0)'
          this.context.fillRect(120, 20, 50, 50)
          this.context.globalCompositeOperation = 'destination-over'
          this.context.fillStyle = 'rgb(0,0,255)'
          this.context.fillRect(150, 50, 50, 50)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
497
![zh-cn_image_0000001238952375](figures/zh-cn_image_0000001238952375.png)
Z
zengyawen 已提交
498

Z
zengyawen 已提交
499 500

### shadowBlur
Z
zengyawen 已提交
501

H
geshi  
HelloCrease 已提交
502 503
```ts
// xxx.ets
Z
zengyawen 已提交
504 505 506
@Entry
@Component
struct ShadowBlur {
Y
yamila 已提交
507 508
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.shadowBlur = 30
          this.context.shadowColor = 'rgb(0,0,0)'
          this.context.fillStyle = 'rgb(255,0,0)'
          this.context.fillRect(20, 20, 100, 80)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
529 530
![zh-cn_image_0000001194032456](figures/zh-cn_image_0000001194032456.png)

Z
zengyawen 已提交
531

Z
zengyawen 已提交
532
### shadowColor
Z
zengyawen 已提交
533

H
geshi  
HelloCrease 已提交
534 535
```ts
// xxx.ets
Z
zengyawen 已提交
536 537 538
@Entry
@Component
struct ShadowColor {
Y
yamila 已提交
539 540
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.shadowBlur = 30
          this.context.shadowColor = 'rgb(0,0,255)'
          this.context.fillStyle = 'rgb(255,0,0)'
          this.context.fillRect(30, 30, 100, 100)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
561
![zh-cn_image_0000001239032411](figures/zh-cn_image_0000001239032411.png)
Z
zengyawen 已提交
562

Z
zengyawen 已提交
563 564

### shadowOffsetX
Z
zengyawen 已提交
565

H
geshi  
HelloCrease 已提交
566 567
```ts
// xxx.ets
Z
zengyawen 已提交
568 569 570
@Entry
@Component
struct ShadowOffsetX {
Y
yamila 已提交
571 572
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.shadowBlur = 10
          this.context.shadowOffsetX = 20
          this.context.shadowColor = 'rgb(0,0,0)'
          this.context.fillStyle = 'rgb(255,0,0)'
          this.context.fillRect(20, 20, 100, 80)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
594 595
![zh-cn_image_0000001193872490](figures/zh-cn_image_0000001193872490.png)

Z
zengyawen 已提交
596

Z
zengyawen 已提交
597
### shadowOffsetY
Z
zengyawen 已提交
598

H
geshi  
HelloCrease 已提交
599 600
```ts
// xxx.ets
Z
zengyawen 已提交
601 602 603
@Entry
@Component
struct ShadowOffsetY {
Y
yamila 已提交
604 605
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.shadowBlur = 10
          this.context.shadowOffsetY = 20
          this.context.shadowColor = 'rgb(0,0,0)'
          this.context.fillStyle = 'rgb(255,0,0)'
          this.context.fillRect(30, 30, 100, 100)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
626
![zh-cn_image_0000001238832387](figures/zh-cn_image_0000001238832387.png)
Z
zengyawen 已提交
627

Z
zengyawen 已提交
628 629

### imageSmoothingEnabled
Z
zengyawen 已提交
630

H
geshi  
HelloCrease 已提交
631 632
```ts
// xxx.ets
Z
zengyawen 已提交
633 634 635
@Entry
@Component
struct ImageSmoothingEnabled {
Y
yamila 已提交
636 637 638
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
  private img:ImageBitmap = new ImageBitmap("common/images/icon.jpg")
Z
zengyawen 已提交
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
          this.context.imageSmoothingEnabled = false
          this.context.drawImage( this.img,0,0,400,200)
      })
    }
    .width('100%')
    .height('100%')
  }
}
```

Z
zengyawen 已提交
657 658
![zh-cn_image_0000001238712415](figures/zh-cn_image_0000001238712415.png)

Z
zengyawen 已提交
659

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
### height

```ts
// xxx.ets
@Entry
@Component
struct HeightExample {
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width(300)
        .height(300)
        .backgroundColor('#ffff00')
        .onReady(() => {
          let h = this.context.height
          let w = this.context.width
          this.context.fillRect(0, 0, 300, h/2)
        })
    }
    .width('100%')
    .height('100%')
  }
}
```

![zh-cn_image_canvas_height](figures/zh-cn_image_canvas_height.png)


### width

```ts
// xxx.ets
@Entry
@Component
struct WidthExample {
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width(300)
        .height(300)
        .backgroundColor('#ffff00')
        .onReady(() => {
          let h = this.context.height
          let w = this.context.width
          this.context.fillRect(0, 0, w/2, 300)
        })
    }
    .width('100%')
    .height('100%')
  }
}
```

![zh-cn_image_canvas_width](figures/zh-cn_image_canvas_width.png)


722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
### imageSmoothingQuality

```ts
  // xxx.ets
  @Entry
  @Component
  struct ImageSmoothingQualityDemo {
    private settings: RenderingContextSettings = new RenderingContextSettings(true);
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings);
    private img:ImageBitmap = new ImageBitmap("common/images/example.jpg");

    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            let ctx = this.context
            ctx.imageSmoothingEnabled = true
            ctx.imageSmoothingQuality = 'high'
            ctx.drawImage(this.img, 0, 0, 400, 200)
          })
      }
      .width('100%')
      .height('100%')
    }
  }
```

![ImageSmoothingQualityDemo](figures/ImageSmoothingQualityDemo.jpeg)


### direction

```ts
  // xxx.ets
  @Entry
  @Component
  struct DirectionDemo {
    private settings: RenderingContextSettings = new RenderingContextSettings(true);
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings);

    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            let ctx = this.context
            ctx.font = '48px serif';
            ctx.textAlign = 'start'
            ctx.fillText("Hi ltr!", 200, 50);

            ctx.direction = "rtl";
            ctx.fillText("Hi rtl!", 200, 100);
          })
      }
      .width('100%')
      .height('100%')
    }
  }
```

![directionDemo](figures/directionDemo.jpeg)


### filter

```ts
  // xxx.ets
  @Entry
  @Component
  struct FilterDemo {
    private settings: RenderingContextSettings = new RenderingContextSettings(true);
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings);
    private img:ImageBitmap = new ImageBitmap("common/images/example.jpg");

    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            let ctx = this.context
            let img = this.img

            ctx.drawImage(img, 0, 0, 100, 100);

            ctx.filter = 'grayscale(50%)';
            ctx.drawImage(img, 100, 0, 100, 100);

            ctx.filter = 'sepia(60%)';
            ctx.drawImage(img, 200, 0, 100, 100);

            ctx.filter = 'saturate(30%)';
            ctx.drawImage(img, 0, 100, 100, 100);

            ctx.filter = 'hue-rotate(90degree)';
            ctx.drawImage(img, 100, 100, 100, 100);

            ctx.filter = 'invert(100%)';
            ctx.drawImage(img, 200, 100, 100, 100);

            ctx.filter = 'opacity(25%)';
            ctx.drawImage(img, 0, 200, 100, 100);

            ctx.filter = 'brightness(0.4)';
            ctx.drawImage(img, 100, 200, 100, 100);

            ctx.filter = 'contrast(200%)';
            ctx.drawImage(img, 200, 200, 100, 100);

            ctx.filter = 'blur(5px)';
            ctx.drawImage(img, 0, 300, 100, 100);

            let result = ctx.toDataURL()
            console.info(result)
          })
      }
      .width('100%')
      .height('100%')
    }
  }
```

![filterDemo](figures/filterDemo.jpeg)

Z
zengyawen 已提交
852
## 方法
Z
zengyawen 已提交
853 854


Z
zengyawen 已提交
855 856 857
### fillRect

fillRect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
858 859 860

填充一个矩形。

Z
zhongjianfei 已提交
861 862
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
863 864
**参数:**

H
HelloCrease 已提交
865 866 867 868 869 870
| 参数     | 类型     | 必填   | 默认值  | 说明            |
| ------ | ------ | ---- | ---- | ------------- |
| x      | number | 是    | 0    | 指定矩形左上角点的x坐标。 |
| y      | number | 是    | 0    | 指定矩形左上角点的y坐标。 |
| width  | number | 是    | 0    | 指定矩形的宽度。      |
| height | number | 是    | 0    | 指定矩形的高度。      |
Z
zengyawen 已提交
871

L
lanyill 已提交
872
**示例:**
Z
zengyawen 已提交
873

H
geshi  
HelloCrease 已提交
874 875
  ```ts
  // xxx.ets
Z
zengyawen 已提交
876 877 878
  @Entry
  @Component
  struct FillRect {
Y
yamila 已提交
879 880
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
881 882 883 884 885 886 887 888
    
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
889
            this.context.fillRect(30,30,100,100)
Z
zengyawen 已提交
890 891 892 893
         })
        }
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
894
    }
Z
zengyawen 已提交
895 896
  }
  ```
Z
zengyawen 已提交
897

Z
zengyawen 已提交
898
  ![zh-cn_image_0000001194192436](figures/zh-cn_image_0000001194192436.png)
Z
zengyawen 已提交
899 900


Z
zengyawen 已提交
901
### strokeRect
Z
zengyawen 已提交
902

Z
zengyawen 已提交
903
strokeRect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
904 905 906

绘制具有边框的矩形,矩形内部不填充。

Z
zhongjianfei 已提交
907 908
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
909 910
**参数:**

H
HelloCrease 已提交
911 912 913 914 915 916
| 参数   | 类型     | 必填   | 默认值  | 说明           |
| ---- | ------ | ---- | ---- | ------------ |
| x    | number | 是    | 0    | 指定矩形的左上角x坐标。 |
| y    | number | 是    | 0    | 指定矩形的左上角y坐标。 |
| w    | number | 是    | 0    | 指定矩形的宽度。     |
| h    | number | 是    | 0    | 指定矩形的高度。     |
L
lanyill 已提交
917 918

**示例:**
Z
zengyawen 已提交
919

H
geshi  
HelloCrease 已提交
920 921
  ```ts
  // xxx.ets
Z
zengyawen 已提交
922 923 924
  @Entry
  @Component
  struct StrokeRect {
Y
yamila 已提交
925 926
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
927

Z
zengyawen 已提交
928 929 930 931 932 933 934 935 936
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.strokeRect(30, 30, 200, 150)
        })
Z
zengyawen 已提交
937
      }
Z
zengyawen 已提交
938 939
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
940
    }
Z
zengyawen 已提交
941 942
  }
  ```
Z
zengyawen 已提交
943

Z
zengyawen 已提交
944
  ![zh-cn_image_0000001194352436](figures/zh-cn_image_0000001194352436.png)
Z
zengyawen 已提交
945 946


Z
zengyawen 已提交
947
### clearRect
Z
zengyawen 已提交
948

Z
zengyawen 已提交
949
clearRect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
950 951 952

删除指定区域内的绘制内容。

Z
zhongjianfei 已提交
953 954
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
955 956
**参数:**

H
HelloCrease 已提交
957 958 959 960 961 962
| 参数   | 类型     | 必填   | 默认值  | 描述            |
| ---- | ------ | ---- | ---- | ------------- |
| x    | number | 是    | 0    | 指定矩形上的左上角x坐标。 |
| y    | number | 是    | 0    | 指定矩形上的左上角y坐标。 |
| w    | number | 是    | 0    | 指定矩形的宽度。      |
| h    | number | 是    | 0    | 指定矩形的高度。      |
L
lanyill 已提交
963 964

**示例:**
Z
zengyawen 已提交
965

H
geshi  
HelloCrease 已提交
966 967
  ```ts
  // xxx.ets
Z
zengyawen 已提交
968 969 970
  @Entry
  @Component
  struct ClearRect {
Y
yamila 已提交
971 972
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
973

Z
zengyawen 已提交
974 975 976 977 978
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
979
          .backgroundColor('#ffff00')
Z
zengyawen 已提交
980 981
          .onReady(() =>{
            this.context.fillStyle = 'rgb(0,0,255)'
L
lanyill 已提交
982 983
            this.context.fillRect(20,20,200,200)
            this.context.clearRect(30,30,150,100)
Z
zengyawen 已提交
984
        })
Z
zengyawen 已提交
985
      }
Z
zengyawen 已提交
986 987
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
988
    }
Z
zengyawen 已提交
989 990
  }
  ```
Z
zengyawen 已提交
991

Z
zengyawen 已提交
992
  ![zh-cn_image_0000001238952377](figures/zh-cn_image_0000001238952377.png)
Z
zengyawen 已提交
993 994


Z
zengyawen 已提交
995
### fillText
Z
zengyawen 已提交
996

L
lanyill 已提交
997
fillText(text: string, x: number, y: number, maxWidth?: number): void
Z
zengyawen 已提交
998 999 1000

绘制填充类文本。

Z
zhongjianfei 已提交
1001 1002
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1003 1004
**参数:**

H
HelloCrease 已提交
1005 1006 1007 1008 1009 1010
| 参数       | 类型     | 必填   | 默认值  | 说明              |
| -------- | ------ | ---- | ---- | --------------- |
| text     | string | 是    | ''   | 需要绘制的文本内容。      |
| x        | number | 是    | 0    | 需要绘制的文本的左下角x坐标。 |
| y        | number | 是    | 0    | 需要绘制的文本的左下角y坐标。 |
| maxWidth | number | 否    | -    | 指定文本允许的最大宽度。    |
L
lanyill 已提交
1011 1012

**示例:**
Z
zengyawen 已提交
1013

H
geshi  
HelloCrease 已提交
1014 1015
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1016 1017 1018
  @Entry
  @Component
  struct FillText {
Y
yamila 已提交
1019 1020
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
1021

Z
zengyawen 已提交
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.font = '30px sans-serif'
            this.context.fillText("Hello World!", 20, 100)
        })
Z
zengyawen 已提交
1032
      }
Z
zengyawen 已提交
1033 1034
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1035
    }
Z
zengyawen 已提交
1036 1037
  }
  ```
Z
zengyawen 已提交
1038

Z
zengyawen 已提交
1039
  ![zh-cn_image_0000001194032458](figures/zh-cn_image_0000001194032458.png)
Z
zengyawen 已提交
1040 1041


Z
zengyawen 已提交
1042
### strokeText
Z
zengyawen 已提交
1043

L
lanyill 已提交
1044
strokeText(text: string, x: number, y: number, maxWidth?:number): void
Z
zengyawen 已提交
1045 1046 1047

绘制描边类文本。

Z
zhongjianfei 已提交
1048 1049
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1050 1051
**参数:**

H
HelloCrease 已提交
1052 1053 1054 1055 1056 1057
| 参数       | 类型     | 必填   | 默认值  | 描述              |
| -------- | ------ | ---- | ---- | --------------- |
| text     | string | 是    | ''   | 需要绘制的文本内容。      |
| x        | number | 是    | 0    | 需要绘制的文本的左下角x坐标。 |
| y        | number | 是    | 0    | 需要绘制的文本的左下角y坐标。 |
| maxWidth | number | 否    | -    | 需要绘制的文本的最大宽度 。  |
L
lanyill 已提交
1058 1059

**示例:**
Z
zengyawen 已提交
1060

H
geshi  
HelloCrease 已提交
1061 1062
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1063 1064 1065
  @Entry
  @Component
  struct StrokeText {
Y
yamila 已提交
1066 1067
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
1068

Z
zengyawen 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.font = '55px sans-serif'
            this.context.strokeText("Hello World!", 20, 60)
        })
Z
zengyawen 已提交
1079
      }
Z
zengyawen 已提交
1080 1081
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1082
    }
Z
zengyawen 已提交
1083 1084
  }
  ```
Z
zengyawen 已提交
1085

Z
zengyawen 已提交
1086
  ![zh-cn_image_0000001239032413](figures/zh-cn_image_0000001239032413.png)
Z
zengyawen 已提交
1087 1088


Z
zengyawen 已提交
1089
### measureText
Z
zengyawen 已提交
1090

Z
zengyawen 已提交
1091
measureText(text: string): TextMetrics
Z
zengyawen 已提交
1092 1093 1094

该方法返回一个文本测算的对象,通过该对象可以获取指定文本的宽度值。

Z
zhongjianfei 已提交
1095 1096
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1097 1098
**参数:**

H
HelloCrease 已提交
1099 1100 1101
| 参数   | 类型     | 必填   | 默认值  | 说明         |
| ---- | ------ | ---- | ---- | ---------- |
| text | string | 是    | ''   | 需要进行测量的文本。 |
Z
zengyawen 已提交
1102

L
lanyill 已提交
1103
**返回值:**
Z
zengyawen 已提交
1104

H
HelloCrease 已提交
1105 1106
| 类型          | 说明                                       |
| ----------- | ---------------------------------------- |
Z
zhongjianfei 已提交
1107
| TextMetrics | 文本的尺寸信息。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Z
zengyawen 已提交
1108

L
lanyill 已提交
1109 1110
**TextMetrics类型描述:**

H
HelloCrease 已提交
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
| 属性                       | 类型     | 描述                                       |
| ------------------------ | ------ | ---------------------------------------- |
| width                    | number | 字符串的宽度。                                  |
| height                   | number | 字符串的高度。                                  |
| actualBoundingBoxAscent  | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的矩形边界顶部的距离,当前值为0。 |
| actualBoundingBoxDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的矩形边界底部的距离,当前值为0。 |
| actualBoundingBoxLeft    | number | 平行于基线,从CanvasRenderingContext2D.textAlign 属性确定的对齐点到文本矩形边界左侧的距离,当前值为0。 |
| actualBoundingBoxRight   | number | 平行于基线,从CanvasRenderingContext2D.textAlign 属性确定的对齐点到文本矩形边界右侧的距离,当前值为0。 |
| alphabeticBaseline       | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 alphabetic 基线的距离,当前值为0。 |
| emHeightAscent           | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框中 em 方块顶部的距离,当前值为0。 |
| emHeightDescent          | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框中 em 方块底部的距离,当前值为0。 |
| fontBoundingBoxAscent    | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的所有字体的矩形最高边界顶部的距离,当前值为0。 |
| fontBoundingBoxDescent   | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的所有字体的矩形边界最底部的距离,当前值为0。 |
| hangingBaseline          | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 hanging 基线的距离,当前值为0。 |
| ideographicBaseline      | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 ideographic 基线的距离,当前值为0。 |
L
lanyill 已提交
1126 1127 1128 1129 1130

  


**示例:**
Z
zengyawen 已提交
1131

H
geshi  
HelloCrease 已提交
1132 1133
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1134 1135 1136
  @Entry
  @Component
  struct MeasureText {
Y
yamila 已提交
1137 1138
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
1139

Z
zengyawen 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.font = '50px sans-serif'
            this.context.fillText("Hello World!", 20, 100)
            this.context.fillText("width:" + this.context.measureText("Hello World!").width, 20, 200)
        })
Z
zengyawen 已提交
1151
      }
Z
zengyawen 已提交
1152 1153
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1154
    }
Z
zengyawen 已提交
1155 1156
  }
  ```
Z
zengyawen 已提交
1157

Z
zengyawen 已提交
1158
  ![zh-cn_image_0000001193872492](figures/zh-cn_image_0000001193872492.png)
Z
zengyawen 已提交
1159 1160


Z
zengyawen 已提交
1161
### stroke
Z
zengyawen 已提交
1162

Z
zengyawen 已提交
1163
stroke(path?: Path2D): void
Z
zengyawen 已提交
1164 1165 1166

进行边框绘制操作。

Z
zhongjianfei 已提交
1167 1168
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1169 1170
**参数:**

H
HelloCrease 已提交
1171 1172 1173
| 参数   | 类型                                       | 必填   | 默认值  | 描述           |
| ---- | ---------------------------------------- | ---- | ---- | ------------ |
| path | [Path2D](ts-components-canvas-path2d.md) | 否    | null | 需要绘制的Path2D。 |
Z
zengyawen 已提交
1174

L
lanyill 已提交
1175
**示例:**
Z
zengyawen 已提交
1176

H
geshi  
HelloCrease 已提交
1177 1178
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1179 1180 1181
  @Entry
  @Component
  struct Stroke {
Y
yamila 已提交
1182 1183
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1184

Z
zengyawen 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.moveTo(25, 25)
            this.context.lineTo(25, 105)
L
lanyill 已提交
1194 1195
            this.context.lineTo(75, 105)
            this.context.lineTo(75, 25)
Z
zengyawen 已提交
1196 1197 1198
            this.context.strokeStyle = 'rgb(0,0,255)'
            this.context.stroke()
          })
Z
zengyawen 已提交
1199
      }
Z
zengyawen 已提交
1200 1201
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1202
    }
Z
zengyawen 已提交
1203 1204
  }
  ```
Z
zengyawen 已提交
1205

Z
zengyawen 已提交
1206
  ![zh-cn_image_0000001238832389](figures/zh-cn_image_0000001238832389.png)
Z
zengyawen 已提交
1207 1208


Z
zengyawen 已提交
1209
### beginPath
Z
zengyawen 已提交
1210

Z
zengyawen 已提交
1211
beginPath(): void
Z
zengyawen 已提交
1212 1213 1214

创建一个新的绘制路径。

Z
zhongjianfei 已提交
1215 1216
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1217 1218
**示例:**

H
geshi  
HelloCrease 已提交
1219 1220
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1221 1222 1223
  @Entry
  @Component
  struct BeginPath {
Y
yamila 已提交
1224 1225
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1226

Z
zengyawen 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.beginPath()
            this.context.lineWidth = 6
            this.context.strokeStyle = '#0000ff'
            this.context.moveTo(15, 80)
            this.context.lineTo(280, 160)
            this.context.stroke()
          })
Z
zengyawen 已提交
1241
      }
Z
zengyawen 已提交
1242 1243
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1244
    }
Z
zengyawen 已提交
1245 1246
  }
  ```
Z
zengyawen 已提交
1247

Z
zengyawen 已提交
1248
  ![zh-cn_image_0000001238712417](figures/zh-cn_image_0000001238712417.png)
Z
zengyawen 已提交
1249 1250


Z
zengyawen 已提交
1251
### moveTo
Z
zengyawen 已提交
1252

Z
zengyawen 已提交
1253
moveTo(x: number, y: number): void
Z
zengyawen 已提交
1254 1255 1256

路径从当前点移动到指定点。

Z
zhongjianfei 已提交
1257 1258
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1259 1260
**参数:**

H
HelloCrease 已提交
1261 1262 1263 1264
| 参数   | 类型     | 必填   | 默认值  | 说明        |
| ---- | ------ | ---- | ---- | --------- |
| x    | number | 是    | 0    | 指定位置的x坐标。 |
| y    | number | 是    | 0    | 指定位置的y坐标。 |
Z
zengyawen 已提交
1265

L
lanyill 已提交
1266
**示例:**
Z
zengyawen 已提交
1267

H
geshi  
HelloCrease 已提交
1268 1269
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1270 1271 1272
  @Entry
  @Component
  struct MoveTo {
Y
yamila 已提交
1273 1274
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1275

Z
zengyawen 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.beginPath()
            this.context.moveTo(10, 10)
            this.context.lineTo(280, 160)
            this.context.stroke()
          })
Z
zengyawen 已提交
1288
      }
Z
zengyawen 已提交
1289 1290
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1291
    }
Z
zengyawen 已提交
1292 1293
  }
  ```
Z
zengyawen 已提交
1294

Z
zengyawen 已提交
1295
  ![zh-cn_image_0000001194192438](figures/zh-cn_image_0000001194192438.png)
Z
zengyawen 已提交
1296 1297


Z
zengyawen 已提交
1298
### lineTo
Z
zengyawen 已提交
1299

Z
zengyawen 已提交
1300
lineTo(x: number, y: number): void
Z
zengyawen 已提交
1301 1302 1303

从当前点到指定点进行路径连接。

Z
zhongjianfei 已提交
1304 1305
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1306 1307
**参数:**

H
HelloCrease 已提交
1308 1309 1310 1311
| 参数   | 类型     | 必填   | 默认值  | 描述        |
| ---- | ------ | ---- | ---- | --------- |
| x    | number | 是    | 0    | 指定位置的x坐标。 |
| y    | number | 是    | 0    | 指定位置的y坐标。 |
Z
zengyawen 已提交
1312

L
lanyill 已提交
1313
**示例:**
Z
zengyawen 已提交
1314

H
geshi  
HelloCrease 已提交
1315 1316
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1317 1318 1319
  @Entry
  @Component
  struct LineTo {
Y
yamila 已提交
1320 1321
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1322

Z
zengyawen 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.beginPath()
            this.context.moveTo(10, 10)
            this.context.lineTo(280, 160)
            this.context.stroke()
          })
Z
zengyawen 已提交
1335
      }
Z
zengyawen 已提交
1336 1337
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1338
    }
Z
zengyawen 已提交
1339 1340
  }
  ```
Z
zengyawen 已提交
1341

Z
zengyawen 已提交
1342
  ![zh-cn_image_0000001194352438](figures/zh-cn_image_0000001194352438.png)
Z
zengyawen 已提交
1343 1344


Z
zengyawen 已提交
1345
### closePath
Z
zengyawen 已提交
1346

Z
zengyawen 已提交
1347
closePath(): void
Z
zengyawen 已提交
1348 1349 1350

结束当前路径形成一个封闭路径。

Z
zhongjianfei 已提交
1351 1352
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1353 1354
**示例:**

H
geshi  
HelloCrease 已提交
1355 1356
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1357 1358 1359
  @Entry
  @Component
  struct ClosePath {
Y
yamila 已提交
1360 1361
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1362

Z
zengyawen 已提交
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
              this.context.beginPath()
              this.context.moveTo(30, 30)
              this.context.lineTo(110, 30)
              this.context.lineTo(70, 90)
              this.context.closePath()
              this.context.stroke()
          })
Z
zengyawen 已提交
1377
      }
Z
zengyawen 已提交
1378 1379
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1380
    }
Z
zengyawen 已提交
1381 1382
  }
  ```
Z
zengyawen 已提交
1383

Z
zengyawen 已提交
1384
  ![zh-cn_image_0000001238952379](figures/zh-cn_image_0000001238952379.png)
Z
zengyawen 已提交
1385 1386


Z
zengyawen 已提交
1387
### createPattern
Z
zengyawen 已提交
1388

L
lanyill 已提交
1389
createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | null
Z
zengyawen 已提交
1390 1391 1392

通过指定图像和重复方式创建图片填充的模板。

Z
zhongjianfei 已提交
1393 1394
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1395 1396
**参数:**

H
HelloCrease 已提交
1397 1398 1399 1400
| 参数         | 类型                                       | 必填   | 描述                                       |
| ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| image      | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是    | 图源对象,具体参考ImageBitmap对象。                  |
| repetition | string                                   | 是    | 设置图像重复的方式,取值为:'repeat'、'repeat-x'、&nbsp'repeat-y'、'no-repeat'、'clamp'、'mirror'。<br/>默认值:'' |
Z
zengyawen 已提交
1401

L
limeng 已提交
1402
**返回值:**
L
lanyill 已提交
1403

H
HelloCrease 已提交
1404 1405
| 类型                                       | 说明                      |
| ---------------------------------------- | ----------------------- |
L
limeng 已提交
1406
| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 通过指定图像和重复方式创建图片填充的模板对象。 |
L
lanyill 已提交
1407 1408

**示例:**
Z
zengyawen 已提交
1409

H
geshi  
HelloCrease 已提交
1410 1411
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1412 1413 1414
  @Entry
  @Component
  struct CreatePattern {
Y
yamila 已提交
1415 1416 1417
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
    private img:ImageBitmap = new ImageBitmap("common/images/icon.jpg")
H
geshi  
HelloCrease 已提交
1418

Z
zengyawen 已提交
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            var pattern = this.context.createPattern(this.img, 'repeat')
            this.context.fillStyle = pattern
            this.context.fillRect(0, 0, 200, 200)
          })
Z
zengyawen 已提交
1430
      }
Z
zengyawen 已提交
1431 1432
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1433
    }
Z
zengyawen 已提交
1434 1435
  }
  ```
Z
zengyawen 已提交
1436

Z
zengyawen 已提交
1437
  ![zh-cn_image_0000001194032460](figures/zh-cn_image_0000001194032460.png)
Z
zengyawen 已提交
1438 1439


Z
zengyawen 已提交
1440
### bezierCurveTo
Z
zengyawen 已提交
1441

Z
zengyawen 已提交
1442
bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): void
Z
zengyawen 已提交
1443 1444 1445

创建三次贝赛尔曲线的路径。

Z
zhongjianfei 已提交
1446 1447
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1448 1449
**参数:**

H
HelloCrease 已提交
1450 1451 1452 1453 1454 1455 1456 1457
| 参数   | 类型     | 必填   | 默认值  | 描述             |
| ---- | ------ | ---- | ---- | -------------- |
| cp1x | number | 是    | 0    | 第一个贝塞尔参数的x坐标值。 |
| cp1y | number | 是    | 0    | 第一个贝塞尔参数的y坐标值。 |
| cp2x | number | 是    | 0    | 第二个贝塞尔参数的x坐标值。 |
| cp2y | number | 是    | 0    | 第二个贝塞尔参数的y坐标值。 |
| x    | number | 是    | 0    | 路径结束时的x坐标值。    |
| y    | number | 是    | 0    | 路径结束时的y坐标值。    |
Z
zengyawen 已提交
1458

L
lanyill 已提交
1459 1460
**示例:**

H
geshi  
HelloCrease 已提交
1461 1462
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1463 1464 1465
  @Entry
  @Component
  struct BezierCurveTo {
Y
yamila 已提交
1466 1467
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1468

Z
zengyawen 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.beginPath()
            this.context.moveTo(10, 10)
            this.context.bezierCurveTo(20, 100, 200, 100, 200, 20)
            this.context.stroke()
          })
Z
zengyawen 已提交
1481
      }
Z
zengyawen 已提交
1482 1483
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1484
    }
Z
zengyawen 已提交
1485 1486
  }
  ```
Z
zengyawen 已提交
1487

Z
zengyawen 已提交
1488
  ![zh-cn_image_0000001239032415](figures/zh-cn_image_0000001239032415.png)
Z
zengyawen 已提交
1489 1490


Z
zengyawen 已提交
1491
### quadraticCurveTo
Z
zengyawen 已提交
1492

Z
zengyawen 已提交
1493
quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void
Z
zengyawen 已提交
1494 1495 1496

创建二次贝赛尔曲线的路径。

Z
zhongjianfei 已提交
1497 1498
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1499 1500
**参数:**

H
HelloCrease 已提交
1501 1502 1503 1504 1505 1506
| 参数   | 类型     | 必填   | 默认值  | 描述          |
| ---- | ------ | ---- | ---- | ----------- |
| cpx  | number | 是    | 0    | 贝塞尔参数的x坐标值。 |
| cpy  | number | 是    | 0    | 贝塞尔参数的y坐标值。 |
| x    | number | 是    | 0    | 路径结束时的x坐标值。 |
| y    | number | 是    | 0    | 路径结束时的y坐标值。 |
Z
zengyawen 已提交
1507

L
lanyill 已提交
1508
**示例:**
Z
zengyawen 已提交
1509

H
geshi  
HelloCrease 已提交
1510 1511
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1512 1513 1514
  @Entry
  @Component
  struct QuadraticCurveTo {
Y
yamila 已提交
1515 1516
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
1517

Z
zengyawen 已提交
1518 1519 1520 1521 1522 1523 1524
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
1525 1526 1527 1528
            this.context.beginPath()
            this.context.moveTo(20, 20)
            this.context.quadraticCurveTo(100, 100, 200, 20)
            this.context.stroke()
Z
zengyawen 已提交
1529
        })
Z
zengyawen 已提交
1530
      }
Z
zengyawen 已提交
1531 1532
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1533
    }
Z
zengyawen 已提交
1534 1535
  }
  ```
Z
zengyawen 已提交
1536

Z
zengyawen 已提交
1537
  ![zh-cn_image_0000001193872494](figures/zh-cn_image_0000001193872494.png)
Z
zengyawen 已提交
1538 1539


Z
zengyawen 已提交
1540
### arc
Z
zengyawen 已提交
1541

L
lanyill 已提交
1542
arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void
Z
zengyawen 已提交
1543 1544 1545

绘制弧线路径。

Z
zhongjianfei 已提交
1546 1547
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1548 1549
**参数:**

H
HelloCrease 已提交
1550 1551 1552 1553 1554 1555 1556 1557
| 参数               | 类型      | 必填   | 默认值   | 描述         |
| ---------------- | ------- | ---- | ----- | ---------- |
| x                | number  | 是    | 0     | 弧线圆心的x坐标值。 |
| y                | number  | 是    | 0     | 弧线圆心的y坐标值。 |
| radius           | number  | 是    | 0     | 弧线的圆半径。    |
| startAngle       | number  | 是    | 0     | 弧线的起始弧度。   |
| endAngle         | number  | 是    | 0     | 弧线的终止弧度。   |
| counterclockwise | boolean | 否    | false | 是否逆时针绘制圆弧。 |
L
lanyill 已提交
1558 1559

**示例:**
Z
zengyawen 已提交
1560

H
geshi  
HelloCrease 已提交
1561 1562
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1563 1564 1565
  @Entry
  @Component
  struct Arc {
Y
yamila 已提交
1566 1567
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1568

Z
zengyawen 已提交
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.beginPath()
            this.context.arc(100, 75, 50, 0, 6.28)
            this.context.stroke()
          })
Z
zengyawen 已提交
1580
      }
Z
zengyawen 已提交
1581 1582
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1583
    }
Z
zengyawen 已提交
1584 1585
  }
  ```
Z
zengyawen 已提交
1586

Z
zengyawen 已提交
1587
  ![zh-cn_image_0000001238832391](figures/zh-cn_image_0000001238832391.png)
Z
zengyawen 已提交
1588 1589


Z
zengyawen 已提交
1590
### arcTo
Z
zengyawen 已提交
1591

Z
zengyawen 已提交
1592
arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void
Z
zengyawen 已提交
1593 1594 1595

依据圆弧经过的点和圆弧半径创建圆弧路径。

Z
zhongjianfei 已提交
1596 1597
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1598 1599
**参数:**

H
HelloCrease 已提交
1600 1601 1602 1603 1604 1605 1606
| 参数     | 类型     | 必填   | 默认值  | 描述              |
| ------ | ------ | ---- | ---- | --------------- |
| x1     | number | 是    | 0    | 圆弧经过的第一个点的x坐标值。 |
| y1     | number | 是    | 0    | 圆弧经过的第一个点的y坐标值。 |
| x2     | number | 是    | 0    | 圆弧经过的第二个点的x坐标值。 |
| y2     | number | 是    | 0    | 圆弧经过的第二个点的y坐标值。 |
| radius | number | 是    | 0    | 圆弧的圆半径值。        |
Z
zengyawen 已提交
1607

L
lanyill 已提交
1608
**示例:**
Z
zengyawen 已提交
1609

H
geshi  
HelloCrease 已提交
1610 1611
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1612 1613 1614
  @Entry
  @Component
  struct ArcTo {
Y
yamila 已提交
1615 1616
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1617

Z
zengyawen 已提交
1618 1619 1620 1621 1622 1623 1624
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
1625 1626 1627
            this.context.moveTo(100, 20)
            this.context.arcTo(150, 20, 150, 70, 50)
            this.context.stroke()
Z
zengyawen 已提交
1628
          })
Z
zengyawen 已提交
1629
      }
Z
zengyawen 已提交
1630 1631
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1632
    }
Z
zengyawen 已提交
1633 1634
  }
  ```
Z
zengyawen 已提交
1635

Z
zengyawen 已提交
1636
  ![zh-cn_image_0000001238712419](figures/zh-cn_image_0000001238712419.png)
Z
zengyawen 已提交
1637 1638


Z
zengyawen 已提交
1639
### ellipse
Z
zengyawen 已提交
1640

L
lanyill 已提交
1641
ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void
Z
zengyawen 已提交
1642 1643 1644

在规定的矩形区域绘制一个椭圆。

Z
zhongjianfei 已提交
1645 1646
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1647 1648
**参数:**

H
HelloCrease 已提交
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
| 参数               | 类型      | 必填   | 默认值   | 说明                                       |
| ---------------- | ------- | ---- | ----- | ---------------------------------------- |
| x                | number  | 是    | 0     | 椭圆圆心的x轴坐标。                               |
| y                | number  | 是    | 0     | 椭圆圆心的y轴坐标。                               |
| radiusX          | number  | 是    | 0     | 椭圆x轴的半径长度。                               |
| radiusY          | number  | 是    | 0     | 椭圆y轴的半径长度。                               |
| rotation         | number  | 是    | 0     | 椭圆的旋转角度,单位为弧度。                           |
| startAngle       | number  | 是    | 0     | 椭圆绘制的起始点角度,以弧度表示。                        |
| endAngle         | number  | 是    | 0     | 椭圆绘制的结束点角度,以弧度表示。                        |
| counterclockwise | boolean | 否    | false | 是否以逆时针方向绘制椭圆。<br>true:逆时针方向绘制椭圆。<br>false:顺时针方向绘制椭圆。 |
Z
zengyawen 已提交
1659

L
lanyill 已提交
1660
**示例:**
Z
zengyawen 已提交
1661

H
geshi  
HelloCrease 已提交
1662 1663
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1664 1665 1666
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
1667 1668
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1669

Z
zengyawen 已提交
1670 1671 1672 1673 1674 1675 1676 1677
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.beginPath()
L
lanyill 已提交
1678
            this.context.ellipse(200, 200, 50, 100, Math.PI * 0.25, Math.PI * 0.5, Math.PI * 2)
Z
zengyawen 已提交
1679 1680
            this.context.stroke()
          })
Z
zengyawen 已提交
1681
      }
Z
zengyawen 已提交
1682 1683
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1684
    }
Z
zengyawen 已提交
1685 1686
  }
  ```
H
geshi  
HelloCrease 已提交
1687

Z
zengyawen 已提交
1688
  ![zh-cn_image_0000001194192440](figures/zh-cn_image_0000001194192440.png)
Z
zengyawen 已提交
1689 1690


Z
zengyawen 已提交
1691
### rect
Z
zengyawen 已提交
1692

L
lanyill 已提交
1693
rect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
1694 1695 1696

创建矩形路径。

Z
zhongjianfei 已提交
1697 1698
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1699 1700
**参数:**

H
HelloCrease 已提交
1701 1702 1703 1704 1705 1706
| 参数   | 类型     | 必填   | 默认值  | 描述            |
| ---- | ------ | ---- | ---- | ------------- |
| x    | number | 是    | 0    | 指定矩形的左上角x坐标值。 |
| y    | number | 是    | 0    | 指定矩形的左上角y坐标值。 |
| w    | number | 是    | 0    | 指定矩形的宽度。      |
| h    | number | 是    | 0    | 指定矩形的高度。      |
L
lanyill 已提交
1707 1708

**示例:**
Z
zengyawen 已提交
1709

H
geshi  
HelloCrease 已提交
1710 1711
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1712 1713 1714
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
1715 1716
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1717

Z
zengyawen 已提交
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.rect(20, 20, 100, 100) // Create a 100*100 rectangle at (20, 20)
            this.context.stroke()
          })
Z
zengyawen 已提交
1728
      }
Z
zengyawen 已提交
1729 1730
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1731
    }
Z
zengyawen 已提交
1732 1733
  }
  ```
Z
zengyawen 已提交
1734

Z
zengyawen 已提交
1735
  ![zh-cn_image_0000001194352440](figures/zh-cn_image_0000001194352440.png)
Z
zengyawen 已提交
1736 1737


Z
zengyawen 已提交
1738
### fill
Z
zengyawen 已提交
1739

L
lanyill 已提交
1740
fill(fillRule?: CanvasFillRule): void
Z
zengyawen 已提交
1741 1742 1743

对封闭路径进行填充。

Z
zhongjianfei 已提交
1744 1745
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1746 1747
**参数:** 

H
HelloCrease 已提交
1748 1749 1750
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要填充对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |
L
lanyill 已提交
1751 1752 1753 1754


**示例:**   

H
geshi  
HelloCrease 已提交
1755 1756
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1757 1758 1759
  @Entry
  @Component
  struct Fill {
Y
yamila 已提交
1760 1761
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1762

Z
zengyawen 已提交
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.rect(20, 20, 100, 100) // Create a 100*100 rectangle at (20, 20)
            this.context.fill()
          })
Z
zengyawen 已提交
1773
      }
Z
zengyawen 已提交
1774 1775
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1776
    }
Z
zengyawen 已提交
1777 1778
  }
  ```
Z
zengyawen 已提交
1779

Z
zengyawen 已提交
1780
  ![zh-cn_image_0000001238952381](figures/zh-cn_image_0000001238952381.png)
Z
zengyawen 已提交
1781 1782


L
lanyill 已提交
1783 1784 1785 1786
fill(path: Path2D, fillRule?: CanvasFillRule): void

对封闭路径进行填充。

Z
zhongjianfei 已提交
1787 1788
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1789 1790
**参数:** 

H
HelloCrease 已提交
1791 1792 1793 1794
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| path     | Path2D         | 是    |           | Path2D填充路径。                              |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要填充对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |
L
lanyill 已提交
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813


**示例:**   

```ts
// xxx.ets
@Entry
@Component
struct Fill {
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
        .backgroundColor('#ffff00')
        .onReady(() =>{
Y
yamila 已提交
1814 1815 1816 1817 1818 1819 1820 1821
          let region = new Path2D()
          region.moveTo(30, 90)
          region.lineTo(110, 20)
          region.lineTo(240, 130)
          region.lineTo(60, 130)
          region.lineTo(190, 20)
          region.lineTo(270, 90)
          region.closePath()
L
lanyill 已提交
1822
          // Fill path
L
lanyill 已提交
1823
          this.context.fillStyle = '#00ff00'
Y
yamila 已提交
1824
          this.context.fill(region, "evenodd")
L
lanyill 已提交
1825 1826 1827 1828 1829 1830
        })
    }
    .width('100%')
    .height('100%')
  }
}
H
HelloCrease 已提交
1831
```
L
lanyill 已提交
1832 1833 1834 1835

 ![zh-cn_image_000000127777774](figures/zh-cn_image_000000127777774.png)


Z
zengyawen 已提交
1836
### clip
Z
zengyawen 已提交
1837

L
lanyill 已提交
1838
clip(fillRule?: CanvasFillRule): void
Z
zengyawen 已提交
1839 1840 1841

设置当前路径为剪切路径。

Z
zhongjianfei 已提交
1842 1843
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1844 1845
**参数:** 

H
HelloCrease 已提交
1846 1847 1848
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要剪切对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |
L
lanyill 已提交
1849 1850 1851

**示例:** 

H
geshi  
HelloCrease 已提交
1852 1853
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1854 1855 1856
  @Entry
  @Component
  struct Clip {
Y
yamila 已提交
1857 1858
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1859

Z
zengyawen 已提交
1860 1861 1862 1863 1864 1865 1866
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
1867
            this.context.rect(0, 0, 100, 200)
Z
zengyawen 已提交
1868 1869 1870
            this.context.stroke()
            this.context.clip()
            this.context.fillStyle = "rgb(255,0,0)"
L
lanyill 已提交
1871
            this.context.fillRect(0, 0, 200, 200)
Z
zengyawen 已提交
1872
          })
Z
zengyawen 已提交
1873
      }
Z
zengyawen 已提交
1874 1875
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1876
    }
Z
zengyawen 已提交
1877 1878
  }
  ```
H
geshi  
HelloCrease 已提交
1879

Z
zengyawen 已提交
1880
  ![zh-cn_image_0000001194032462](figures/zh-cn_image_0000001194032462.png)
Z
zengyawen 已提交
1881 1882


L
lanyill 已提交
1883 1884
clip(path: Path2D, fillRule?: CanvasFillRule): void

L
lanyill 已提交
1885
设置当前路径为剪切路径
L
lanyill 已提交
1886

Z
zhongjianfei 已提交
1887 1888
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1889 1890
**参数:** 

H
HelloCrease 已提交
1891 1892 1893 1894 1895
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| path     | Path2D         | 是    | -         | Path2D剪切路径。                              |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要剪切对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |

L
lanyill 已提交
1896

L
lanyill 已提交
1897 1898 1899 1900
**示例:** 

  ```ts
  // xxx.ets
L
lanyill 已提交
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
  @Entry
  @Component
  struct Clip {
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            let region = new Path2D()
            region.moveTo(30, 90)
            region.lineTo(110, 20)
            region.lineTo(240, 130)
            region.lineTo(60, 130)
            region.lineTo(190, 20)
            region.lineTo(270, 90)
            region.closePath()
            this.context.clip(region,"evenodd")
            this.context.fillStyle = "rgb(0,255,0)"
            this.context.fillRect(0, 0, this.context.width, this.context.height)
          })
      }
      .width('100%')
      .height('100%')
L
lanyill 已提交
1928 1929 1930 1931 1932 1933
    }
  }
  ```

  ![zh-cn_image_000000127777779](figures/zh-cn_image_000000127777779.png)

L
lanyill 已提交
1934 1935 1936 1937 1938 1939 1940

### getTransform

getTransform(): Matrix2D

获取当前被应用到上下文的转换矩阵。该接口为空接口。

Z
zhongjianfei 已提交
1941 1942
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
limeng 已提交
1943 1944
**返回值:**

H
HelloCrease 已提交
1945 1946
| 类型                                       | 说明    |
| ---------------------------------------- | ----- |
L
limeng 已提交
1947 1948
| [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 矩阵对象。 |

L
lanyill 已提交
1949 1950 1951 1952 1953 1954 1955

### resetTransform

resetTransform(): void

使用单位矩阵重新设置当前变形。该接口为空接口。

Z
zhongjianfei 已提交
1956 1957
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1958

Z
zengyawen 已提交
1959
### rotate
Z
zengyawen 已提交
1960

L
lanyill 已提交
1961
rotate(angle: number): void
Z
zengyawen 已提交
1962 1963 1964

针对当前坐标轴进行顺时针旋转。

Z
zhongjianfei 已提交
1965 1966
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
1967 1968
**参数:**

H
HelloCrease 已提交
1969 1970 1971
| 参数    | 类型     | 必填   | 默认值  | 描述                                       |
| ----- | ------ | ---- | ---- | ---------------------------------------- |
| angle | number | 是    | 0    | 设置顺时针旋转的弧度值,可以通过Math.PI&nbsp;/&nbsp;180将角度转换为弧度值。 |
L
lanyill 已提交
1972 1973

**示例:**
Z
zengyawen 已提交
1974

H
geshi  
HelloCrease 已提交
1975 1976
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1977 1978 1979
  @Entry
  @Component
  struct Rotate {
Y
yamila 已提交
1980 1981
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1982

Z
zengyawen 已提交
1983 1984 1985 1986 1987 1988 1989
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
1990
            this.context.rotate(45 * Math.PI / 180)
Z
zengyawen 已提交
1991 1992
            this.context.fillRect(70, 20, 50, 50)
          })
Z
zengyawen 已提交
1993
      }
Z
zengyawen 已提交
1994 1995
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1996
    }
Z
zengyawen 已提交
1997 1998
  }
  ```
Z
zengyawen 已提交
1999

Z
zengyawen 已提交
2000
  ![zh-cn_image_0000001239032417](figures/zh-cn_image_0000001239032417.png)
Z
zengyawen 已提交
2001 2002


Z
zengyawen 已提交
2003
### scale
Z
zengyawen 已提交
2004

Z
zengyawen 已提交
2005
scale(x: number, y: number): void
Z
zengyawen 已提交
2006 2007 2008

设置canvas画布的缩放变换属性,后续的绘制操作将按照缩放比例进行缩放。

Z
zhongjianfei 已提交
2009 2010
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2011 2012
**参数:**

H
HelloCrease 已提交
2013 2014 2015 2016
| 参数   | 类型     | 必填   | 默认值  | 描述          |
| ---- | ------ | ---- | ---- | ----------- |
| x    | number | 是    | 0    | 设置水平方向的缩放值。 |
| y    | number | 是    | 0    | 设置垂直方向的缩放值。 |
Z
zengyawen 已提交
2017

L
lanyill 已提交
2018
**示例:**
Z
zengyawen 已提交
2019

H
geshi  
HelloCrease 已提交
2020 2021
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2022 2023 2024
  @Entry
  @Component
  struct Scale {
Y
yamila 已提交
2025 2026
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2027

Z
zengyawen 已提交
2028 2029 2030 2031 2032 2033 2034
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
2035 2036
            this.context.lineWidth = 3
            this.context.strokeRect(30, 30, 50, 50)
Z
zengyawen 已提交
2037
            this.context.scale(2, 2) // Scale to 200%
L
lanyill 已提交
2038
            this.context.strokeRect(30, 30, 50, 50)
Z
zengyawen 已提交
2039
          })
Z
zengyawen 已提交
2040
      }
Z
zengyawen 已提交
2041 2042
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2043
    }
Z
zengyawen 已提交
2044 2045
  }
  ```
Z
zengyawen 已提交
2046

Z
zengyawen 已提交
2047
  ![zh-cn_image_0000001193872498](figures/zh-cn_image_0000001193872498.png)
Z
zengyawen 已提交
2048 2049


Z
zengyawen 已提交
2050
### transform
Z
zengyawen 已提交
2051

L
lanyill 已提交
2052
transform(a: number, b: number, c: number, d: number, e: number, f: number): void
Z
zengyawen 已提交
2053 2054 2055

transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。

Z
zhongjianfei 已提交
2056 2057
从API version 9开始,该接口支持在ArkTS卡片中使用。

zyjhandsome's avatar
zyjhandsome 已提交
2058
> **说明:**
Z
zengyawen 已提交
2059
> 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标):
H
geshi  
HelloCrease 已提交
2060
>
Z
zengyawen 已提交
2061
> - x' = scaleX \* x + skewY \* y + translateX
H
geshi  
HelloCrease 已提交
2062
>
Z
zengyawen 已提交
2063 2064
> - y' = skewX \* x + scaleY \* y + translateY

L
lanyill 已提交
2065 2066
**参数:**

H
HelloCrease 已提交
2067 2068 2069 2070 2071 2072 2073 2074
| 参数   | 类型     | 必填   | 默认值  | 描述                   |
| ---- | ------ | ---- | ---- | -------------------- |
| a    | number | 是    | 0    | scaleX: 指定水平缩放值。     |
| b    | number | 是    | 0    | skewX: 指定水平倾斜值。      |
| c    | number | 是    | 0    | skewY: 指定垂直倾斜值。      |
| d    | number | 是    | 0    | scaleY: 指定垂直缩放值。     |
| e    | number | 是    | 0    | translateX: 指定水平移动值。 |
| f    | number | 是    | 0    | translateY: 指定垂直移动值。 |
L
lanyill 已提交
2075 2076 2077

**示例:**

H
geshi  
HelloCrease 已提交
2078 2079
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2080 2081 2082
  @Entry
  @Component
  struct Transform {
Y
yamila 已提交
2083 2084
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2085

Z
zengyawen 已提交
2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.fillStyle = 'rgb(0,0,0)'
            this.context.fillRect(0, 0, 100, 100)
            this.context.transform(1, 0.5, -0.5, 1, 10, 10)
            this.context.fillStyle = 'rgb(255,0,0)'
            this.context.fillRect(0, 0, 100, 100)
            this.context.transform(1, 0.5, -0.5, 1, 10, 10)
            this.context.fillStyle = 'rgb(0,0,255)'
            this.context.fillRect(0, 0, 100, 100)
          })
Z
zengyawen 已提交
2102
      }
Z
zengyawen 已提交
2103 2104
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2105
    }
Z
zengyawen 已提交
2106 2107 2108 2109 2110 2111 2112 2113
  }
  ```

  ![zh-cn_image_0000001238832395](figures/zh-cn_image_0000001238832395.png)


### setTransform

L
lanyill 已提交
2114
setTransform(a: number, b: number, c: number, d: number, e: number, f: number): void
Z
zengyawen 已提交
2115

H
HelloCrease 已提交
2116
setTransform方法使用的参数和transform()方法相同,但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。
Z
zengyawen 已提交
2117

Z
zhongjianfei 已提交
2118 2119
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2120 2121
**参数:**

H
HelloCrease 已提交
2122 2123 2124 2125 2126 2127 2128 2129
| 参数   | 类型     | 必填   | 默认值  | 描述                   |
| ---- | ------ | ---- | ---- | -------------------- |
| a    | number | 是    | 0    | scaleX: 指定水平缩放值。     |
| b    | number | 是    | 0    | skewX: 指定水平倾斜值。      |
| c    | number | 是    | 0    | skewY: 指定垂直倾斜值。      |
| d    | number | 是    | 0    | scaleY: 指定垂直缩放值。     |
| e    | number | 是    | 0    | translateX: 指定水平移动值。 |
| f    | number | 是    | 0    | translateY: 指定垂直移动值。 |
L
lanyill 已提交
2130 2131 2132

**示例:**

H
geshi  
HelloCrease 已提交
2133 2134
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2135 2136 2137
  @Entry
  @Component
  struct SetTransform {
Y
yamila 已提交
2138 2139
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2140

Z
zengyawen 已提交
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.fillStyle = 'rgb(255,0,0)'
            this.context.fillRect(0, 0, 100, 100)
            this.context.setTransform(1,0.5, -0.5, 1, 10, 10)
            this.context.fillStyle = 'rgb(0,0,255)'
            this.context.fillRect(0, 0, 100, 100)
          })
Z
zengyawen 已提交
2154
      }
Z
zengyawen 已提交
2155 2156
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2157
    }
Z
zengyawen 已提交
2158 2159
  }
  ```
Z
zengyawen 已提交
2160

Z
zengyawen 已提交
2161
  ![zh-cn_image_0000001238712421](figures/zh-cn_image_0000001238712421.png)
Z
zengyawen 已提交
2162

L
limeng 已提交
2163
### setTransform
Z
zengyawen 已提交
2164

L
lanyill 已提交
2165 2166 2167 2168
setTransform(transform?: Matrix2D): void

以Matrix2D对象为模板重置现有的变换矩阵并创建新的变换矩阵。该接口为空接口。

L
lanyill 已提交
2169 2170
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
limeng 已提交
2171 2172
**参数:**

H
HelloCrease 已提交
2173 2174 2175
| 参数        | 类型                                       | 必填   | 默认值  | 描述    |
| --------- | ---------------------------------------- | ---- | ---- | ----- |
| transform | [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 否    | null | 变换矩阵。 |
L
lanyill 已提交
2176

Z
zengyawen 已提交
2177
### translate
Z
zengyawen 已提交
2178

Z
zengyawen 已提交
2179
translate(x: number, y: number): void
Z
zengyawen 已提交
2180 2181 2182

移动当前坐标系的原点。

Z
zhongjianfei 已提交
2183 2184
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2185 2186
**参数:**

H
HelloCrease 已提交
2187 2188 2189 2190
| 参数   | 类型     | 必填   | 默认值  | 描述       |
| ---- | ------ | ---- | ---- | -------- |
| x    | number | 是    | 0    | 设置水平平移量。 |
| y    | number | 是    | 0    | 设置竖直平移量。 |
Z
zengyawen 已提交
2191

L
lanyill 已提交
2192
**示例:**
Z
zengyawen 已提交
2193

H
geshi  
HelloCrease 已提交
2194 2195
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2196 2197 2198
  @Entry
  @Component
  struct Translate {
Y
yamila 已提交
2199 2200
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2201

Z
zengyawen 已提交
2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.fillRect(10, 10, 50, 50)
            this.context.translate(70, 70)
            this.context.fillRect(10, 10, 50, 50)
          })
Z
zengyawen 已提交
2213
      }
Z
zengyawen 已提交
2214 2215
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2216
    }
Z
zengyawen 已提交
2217 2218
  }
  ```
Z
zengyawen 已提交
2219

Z
zengyawen 已提交
2220
  ![zh-cn_image_0000001194192446](figures/zh-cn_image_0000001194192446.png)
Z
zengyawen 已提交
2221 2222


Z
zengyawen 已提交
2223
### drawImage
Z
zengyawen 已提交
2224

Y
yaoyuchi 已提交
2225
drawImage(image: ImageBitmap | PixelMap, dx: number, dy: number): void
Z
zengyawen 已提交
2226

L
lanyill 已提交
2227
drawImage(image: ImageBitmap | PixelMap, dx: number, dy: number, dw: number, dh: number): void
Z
zengyawen 已提交
2228

L
lanyill 已提交
2229
drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh: number, dx: number, dy: number, dw: number, dh: number):void
Z
zengyawen 已提交
2230 2231 2232

进行图像绘制。

Z
zhongjianfei 已提交
2233
从API version 9开始,该接口支持在ArkTS卡片中使用,卡片中不支持PixelMap对象。
2234

L
lanyill 已提交
2235 2236
**参数:**

H
HelloCrease 已提交
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
| 参数    | 类型                                       | 必填   | 默认值  | 描述                                       |
| ----- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| image | [ImageBitmap](ts-components-canvas-imagebitmap.md)[PixelMap](../apis/js-apis-image.md#pixelmap7) | 是    | null | 图片资源,请参考ImageBitmap或PixelMap。            |
| sx    | number                                   | 否    | 0    | 裁切源图像时距离源图像左上角的x坐标值。                     |
| sy    | number                                   | 否    | 0    | 裁切源图像时距离源图像左上角的y坐标值。                     |
| sw    | number                                   | 否    | 0    | 裁切源图像时需要裁切的宽度。                           |
| sh    | number                                   | 否    | 0    | 裁切源图像时需要裁切的高度。                           |
| dx    | number                                   | 是    | 0    | 绘制区域左上角在x轴的位置。                           |
| dy    | number                                   | 是    | 0    | 绘制区域左上角在y&nbsp;轴的位置。                     |
| dw    | number                                   | 否    | 0    | 绘制区域的宽度。当绘制区域的宽度和裁剪图像的宽度不一致时,将图像宽度拉伸或压缩为绘制区域的宽度。 |
| dh    | number                                   | 否    | 0    | 绘制区域的高度。当绘制区域的高度和裁剪图像的高度不一致时,将图像高度拉伸或压缩为绘制区域的高度。 |
L
lanyill 已提交
2248

Z
zengyawen 已提交
2249

L
lanyill 已提交
2250
**示例:**
Z
zengyawen 已提交
2251

H
geshi  
HelloCrease 已提交
2252 2253
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2254 2255 2256
  @Entry
  @Component
  struct ImageExample {
Y
yamila 已提交
2257 2258
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Y
yamila 已提交
2259
    private img:ImageBitmap = new ImageBitmap("common/images/example.jpg")
L
lanyill 已提交
2260

Z
zengyawen 已提交
2261 2262 2263 2264 2265 2266 2267
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
2268
            this.context.drawImage( this.img,0,0,500,500,0,0,400,200)
Z
zengyawen 已提交
2269
        })
Z
zengyawen 已提交
2270
      }
Z
zengyawen 已提交
2271 2272
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2273
    }
Z
zengyawen 已提交
2274 2275 2276 2277 2278 2279 2280 2281
  }
  ```

  ![zh-cn_image_0000001194352442](figures/zh-cn_image_0000001194352442.png)


### createImageData

L
lanyill 已提交
2282
createImageData(sw: number, sh: number): ImageData
Z
zengyawen 已提交
2283

L
lanyill 已提交
2284
创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagedata.md)
Z
zengyawen 已提交
2285

Z
zhongjianfei 已提交
2286 2287
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2288 2289
**参数:**

H
HelloCrease 已提交
2290 2291 2292 2293
| 参数   | 类型     | 必填   | 默认   | 描述            |
| ---- | ------ | ---- | ---- | ------------- |
| sw   | number | 是    | 0    | ImageData的宽度。 |
| sh   | number | 是    | 0    | ImageData的高度。 |
Z
zengyawen 已提交
2294 2295


L
lanyill 已提交
2296
createImageData(imageData: ImageData): ImageData
Z
zengyawen 已提交
2297

L
lanyill 已提交
2298
创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagedata.md)
Z
zengyawen 已提交
2299

Z
zhongjianfei 已提交
2300 2301
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2302 2303
**参数:**

H
HelloCrease 已提交
2304 2305
| 参数        | 类型                                       | 必填   | 默认   | 描述                |
| --------- | ---------------------------------------- | ---- | ---- | ----------------- |
L
lanyill 已提交
2306
| imagedata | [ImageData](ts-components-canvas-imagedata.md) | 是    | null | 复制现有的ImageData对象。 |
L
lanyill 已提交
2307 2308 2309

  **返回值:**

H
HelloCrease 已提交
2310 2311
| 类型                                       | 说明             |
| ---------------------------------------- | -------------- |
L
lanyill 已提交
2312
| [ImageData](ts-components-canvas-imagedata.md) | 新的ImageData对象。 |
L
lanyill 已提交
2313

Z
zengyawen 已提交
2314

Y
yaoyuchi 已提交
2315 2316 2317 2318 2319
### getPixelMap

getPixelMap(sx: number, sy: number, sw: number, sh: number): PixelMap

以当前canvas指定区域内的像素创建[PixelMap](../apis/js-apis-image.md#pixelmap7)对象。
L
lanyill 已提交
2320 2321 2322

**参数:**

H
HelloCrease 已提交
2323 2324 2325 2326 2327 2328
| 参数   | 类型     | 必填   | 默认值  | 描述              |
| ---- | ------ | ---- | ---- | --------------- |
| sx   | number | 是    | 0    | 需要输出的区域的左上角x坐标。 |
| sy   | number | 是    | 0    | 需要输出的区域的左上角y坐标。 |
| sw   | number | 是    | 0    | 需要输出的区域的宽度。     |
| sh   | number | 是    | 0    | 需要输出的区域的高度。     |
Z
zengyawen 已提交
2329

L
lanyill 已提交
2330 2331
**返回值:**

H
HelloCrease 已提交
2332 2333 2334
| 类型                                       | 说明            |
| ---------------------------------------- | ------------- |
| [PixelMap](../apis/js-apis-image.md#pixelmap7) | 新的PixelMap对象。 |
Z
zengyawen 已提交
2335 2336 2337

### getImageData

L
lanyill 已提交
2338
getImageData(sx: number, sy: number, sw: number, sh: number): ImageData
Z
zengyawen 已提交
2339

L
lanyill 已提交
2340
以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagedata.md)对象。
L
lanyill 已提交
2341

Z
zhongjianfei 已提交
2342 2343
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2344 2345
**参数:**

H
HelloCrease 已提交
2346 2347 2348 2349 2350 2351
| 参数   | 类型     | 必填   | 默认值  | 描述              |
| ---- | ------ | ---- | ---- | --------------- |
| sx   | number | 是    | 0    | 需要输出的区域的左上角x坐标。 |
| sy   | number | 是    | 0    | 需要输出的区域的左上角y坐标。 |
| sw   | number | 是    | 0    | 需要输出的区域的宽度。     |
| sh   | number | 是    | 0    | 需要输出的区域的高度。     |
Z
zengyawen 已提交
2352

L
lanyill 已提交
2353 2354
  **返回值:**

H
HelloCrease 已提交
2355 2356
| 类型                                       | 说明             |
| ---------------------------------------- | -------------- |
L
lanyill 已提交
2357 2358 2359 2360 2361 2362 2363
| [ImageData](ts-components-canvas-imagedata.md) | 新的ImageData对象。 |


**示例:**

  ```ts
  // xxx.ets
L
lanyill 已提交
2364 2365 2366 2367 2368 2369
  @Entry
  @Component
  struct GetImageData {
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
    private img:ImageBitmap = new ImageBitmap("/common/images/1234.png")
L
lanyill 已提交
2370

L
lanyill 已提交
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.drawImage(this.img,0,0,130,130)
            var imagedata = this.context.getImageData(50,50,130,130)
            this.context.putImageData(imagedata,150,150)
          })
      }
      .width('100%')
      .height('100%')
L
lanyill 已提交
2385 2386 2387 2388 2389
    }
  }
  ```

  ![zh-cn_image_000000127777780](figures/zh-cn_image_000000127777780.png)
Z
zengyawen 已提交
2390 2391 2392 2393


### putImageData

L
limeng 已提交
2394
putImageData(imageData: ImageData, dx: number | string, dy: number | string): void
L
lanyill 已提交
2395

L
limeng 已提交
2396
putImageData(imageData: ImageData, dx: number | string, dy: number | string, dirtyX: number | string, dirtyY: number | string, dirtyWidth: number | string, dirtyHeight: number | string): void
Z
zengyawen 已提交
2397

L
lanyill 已提交
2398
使用[ImageData](ts-components-canvas-imagedata.md)数据填充新的矩形区域。
Z
zengyawen 已提交
2399

Z
zhongjianfei 已提交
2400 2401
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2402 2403
**参数:**

H
HelloCrease 已提交
2404 2405 2406 2407 2408 2409 2410 2411 2412
| 参数          | 类型                                       | 必填   | 默认值          | 描述                            |
| ----------- | ---------------------------------------- | ---- | ------------ | ----------------------------- |
| imagedata   | [ImageData](ts-components-canvas-imagedata.md) | 是    | null         | 包含像素值的ImageData对象。            |
| dx          | number&nbsp;\|&nbsp;string<sup>10+</sup> | 是    | 0            | 填充区域在x轴方向的偏移量。                |
| dy          | number&nbsp;\|&nbsp;string<sup>10+</sup> | 是    | 0            | 填充区域在y轴方向的偏移量。                |
| dirtyX      | number&nbsp;\|&nbsp;string<sup>10+</sup> | 否    | 0            | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 |
| dirtyY      | number&nbsp;\|&nbsp;string<sup>10+</sup> | 否    | 0            | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 |
| dirtyWidth  | number&nbsp;\|&nbsp;string<sup>10+</sup> | 否    | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。               |
| dirtyHeight | number&nbsp;\|&nbsp;string<sup>10+</sup> | 否    | imagedata的高度 | 源图像数据矩形裁切范围的高度。               |
Z
zengyawen 已提交
2413

L
lanyill 已提交
2414 2415
**示例:**

H
geshi  
HelloCrease 已提交
2416 2417
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2418 2419 2420
  @Entry
  @Component
  struct PutImageData {
Y
yamila 已提交
2421 2422
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2423

Z
zengyawen 已提交
2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            var imageData = this.context.createImageData(100, 100)
            for (var i = 0; i < imageData.data.length; i += 4) {
              imageData.data[i + 0] = 255
              imageData.data[i + 1] = 0
              imageData.data[i + 2] = 255
              imageData.data[i + 3] = 255
            }
            this.context.putImageData(imageData, 10, 10)
          })
Z
zengyawen 已提交
2440
      }
Z
zengyawen 已提交
2441 2442
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2443
    }
Z
zengyawen 已提交
2444 2445
  }
  ```
Z
zengyawen 已提交
2446

Z
zengyawen 已提交
2447
  ![zh-cn_image_0000001238952387](figures/zh-cn_image_0000001238952387.png)
Z
zengyawen 已提交
2448 2449


L
lanyill 已提交
2450 2451 2452 2453 2454 2455
### setLineDash

setLineDash(segments: number[]): void

设置画布的虚线样式。

Z
zhongjianfei 已提交
2456 2457
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2458 2459
**参数:** 

H
HelloCrease 已提交
2460 2461
| 参数       | 类型       | 描述                  |
| -------- | -------- | ------------------- |
L
lanyill 已提交
2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482
| segments | number[] | 描述线段如何交替和线段间距长度的数组。 |

**示例:** 

  ```ts
  // xxx.ets
  @Entry
  @Component
  struct SetLineDash {
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
    
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            this.context.arc(100, 75, 50, 0, 6.28)
            this.context.setLineDash([10,20])
L
lanyill 已提交
2483
            this.context.stroke()
L
lanyill 已提交
2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500
          })
      }
      .width('100%')
      .height('100%')
    }
  }
  ```

  ![zh-cn_image_000000127777771](figures/zh-cn_image_000000127777771.png)


### getLineDash

getLineDash(): number[]

获得当前画布的虚线样式。

Z
zhongjianfei 已提交
2501 2502
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2503 2504
**返回值:** 

H
HelloCrease 已提交
2505 2506
| 类型       | 说明                       |
| -------- | ------------------------ |
L
lanyill 已提交
2507 2508
| number[] | 返回数组,该数组用来描述线段如何交替和间距长度。 |

L
lanyill 已提交
2509

L
lanyill 已提交
2510 2511 2512 2513
**示例:** 

  ```ts
  // xxx.ets
L
lanyill 已提交
2514 2515 2516 2517 2518 2519
  @Entry
  @Component
  struct CanvasGetLineDash {
    @State message: string = 'Hello World'
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
2520

L
lanyill 已提交
2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
    build() {
      Row() {
        Column() {
          Text(this.message)
            .fontSize(50)
            .fontWeight(FontWeight.Bold)
            .onClick(()=>{
              console.error('before getlinedash clicked')
              let res = this.context.getLineDash()
              console.error(JSON.stringify(res))
            })
          Canvas(this.context)
            .width('100%')
            .height('100%')
            .backgroundColor('#ffff00')
            .onReady(() => {
              this.context.arc(100, 75, 50, 0, 6.28)
              this.context.setLineDash([10,20])
              this.context.stroke()
              let res = this.context.getLineDash()
            })
        }
        .width('100%')
L
lanyill 已提交
2544
      }
L
lanyill 已提交
2545
      .height('100%')
L
lanyill 已提交
2546 2547 2548
    }
  }
  ```
L
lanyill 已提交
2549 2550
![zh-cn_image_000000127777778](figures/zh-cn_image_000000127777778.png) 

L
lanyill 已提交
2551 2552 2553 2554 2555 2556 2557

### transferFromImageBitmap

transferFromImageBitmap(bitmap: ImageBitmap): void

显示给定的ImageBitmap对象。

Z
zhongjianfei 已提交
2558 2559
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2560 2561
**参数:** 

H
HelloCrease 已提交
2562 2563
| 参数     | 类型                                       | 描述                 |
| ------ | ---------------------------------------- | ------------------ |
L
lanyill 已提交
2564
| bitmap | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 待显示的ImageBitmap对象。 |
L
lanyill 已提交
2565 2566 2567 2568 2569 2570 2571

**示例:** 

  ```ts
  // xxx.ets
  @Entry
  @Component
L
lanyill 已提交
2572
  struct TransferFromImageBitmap {
L
lanyill 已提交
2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
    private offContext: OffscreenCanvasRenderingContext2D = new OffscreenCanvasRenderingContext2D(600, 600, this.settings)

    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            var imageData = this.offContext.createImageData(100, 100)
            for (var i = 0; i < imageData.data.length; i += 4) {
              imageData.data[i + 0] = 255
              imageData.data[i + 1] = 0
              imageData.data[i + 2] = 255
              imageData.data[i + 3] = 255
            }
            this.offContext.putImageData(imageData, 10, 10)
            var image = this.offContext.transferToImageBitmap()
            this.context.transferFromImageBitmap(image)
          })
      }
      .width('100%')
      .height('100%')
    }
  }
  ```
L
lanyill 已提交
2601 2602
  ![zh-cn_image_0000001238952387](figures/zh-cn_image_0000001238952387.png)  

L
lanyill 已提交
2603 2604 2605 2606 2607 2608 2609

### toDataURL

toDataURL(type?: string, quality?: number): string

生成一个包含图片展示的URL。

2610 2611
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628
**参数:** 

| 参数名     | 参数类型   | 必填   | 描述                                       |
| ------- | ------ | ---- | ---------------------------------------- |
| type    | string | 否    | 可选参数,用于指定图像格式,默认格式为image/png。            |
| quality | number | 否    | 在指定图片格式为image/jpeg或image/webp的情况下,可以从0到1的区间内选择图片的质量。如果超出取值范围,将会使用默认值0.92。 |

**返回值:** 

| 类型     | 说明        |
| ------ | --------- |
| string | 图像的URL地址。 |

**示例:**

  ```ts
  // xxx.ets
L
lanyill 已提交
2629 2630 2631 2632 2633
  @Entry
  @Component
  struct ToDataURL {
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
2634

L
lanyill 已提交
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            var dataURL = this.context.toDataURL()
          })
      }
      .width('100%')
      .height('100%')
L
lanyill 已提交
2647 2648 2649 2650 2651
    }
  }
  ```


Z
zengyawen 已提交
2652
### restore
Z
zengyawen 已提交
2653

Z
zengyawen 已提交
2654
restore(): void
Z
zengyawen 已提交
2655 2656 2657

对保存的绘图上下文进行恢复。

Z
zhongjianfei 已提交
2658 2659
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2660 2661
**示例:**

H
geshi  
HelloCrease 已提交
2662 2663
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2664 2665 2666
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
2667 2668
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2669

Z
zengyawen 已提交
2670 2671 2672 2673 2674 2675 2676
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
2677
            this.context.save() // save the default state
L
lanyill 已提交
2678
            this.context.fillStyle = "#00ff00"
Y
yamila 已提交
2679 2680 2681
            this.context.fillRect(20, 20, 100, 100)
            this.context.restore() // restore to the default state
            this.context.fillRect(150, 75, 100, 100)
Z
zengyawen 已提交
2682
          })
Z
zengyawen 已提交
2683
      }
Z
zengyawen 已提交
2684 2685
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2686
    }
Z
zengyawen 已提交
2687 2688
  }
  ```
L
lanyill 已提交
2689
  ![zh-cn_image_000000127777781](figures/zh-cn_image_000000127777781.png)
Z
zengyawen 已提交
2690 2691


Z
zengyawen 已提交
2692
### save
Z
zengyawen 已提交
2693

Z
zengyawen 已提交
2694
save(): void
Z
zengyawen 已提交
2695

H
HelloCrease 已提交
2696
将当前状态放入栈中,保存canvas的全部状态,通常在需要保存绘制状态时调用。
Z
zengyawen 已提交
2697

Z
zhongjianfei 已提交
2698 2699
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2700 2701
**示例:**

H
geshi  
HelloCrease 已提交
2702 2703
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2704 2705 2706
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
2707 2708
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2709

Z
zengyawen 已提交
2710 2711 2712 2713 2714 2715 2716
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
2717
            this.context.save() // save the default state
L
lanyill 已提交
2718
            this.context.fillStyle = "#00ff00"
Y
yamila 已提交
2719 2720 2721
            this.context.fillRect(20, 20, 100, 100)
            this.context.restore() // restore to the default state
            this.context.fillRect(150, 75, 100, 100)
L
lanyill 已提交
2722
          })
Z
zengyawen 已提交
2723
      }
Z
zengyawen 已提交
2724 2725
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2726
    }
Z
zengyawen 已提交
2727 2728
  }
  ```
L
lanyill 已提交
2729
  ![zh-cn_image_000000127777781](figures/zh-cn_image_000000127777781.png)
Z
zengyawen 已提交
2730 2731


Z
zengyawen 已提交
2732
### createLinearGradient
Z
zengyawen 已提交
2733

Z
zengyawen 已提交
2734
createLinearGradient(x0: number, y0: number, x1: number, y1: number): void
Z
zengyawen 已提交
2735 2736 2737

创建一个线性渐变色。

Z
zhongjianfei 已提交
2738 2739
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2740 2741
**参数:**

H
HelloCrease 已提交
2742 2743 2744 2745 2746 2747
| 参数   | 类型     | 必填   | 默认值  | 描述       |
| ---- | ------ | ---- | ---- | -------- |
| x0   | number | 是    | 0    | 起点的x轴坐标。 |
| y0   | number | 是    | 0    | 起点的y轴坐标。 |
| x1   | number | 是    | 0    | 终点的x轴坐标。 |
| y1   | number | 是    | 0    | 终点的y轴坐标。 |
Z
zengyawen 已提交
2748

L
lanyill 已提交
2749
**示例:**
Z
zengyawen 已提交
2750

H
geshi  
HelloCrease 已提交
2751 2752
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2753 2754 2755
  @Entry
  @Component
  struct CreateLinearGradient {
Y
yamila 已提交
2756 2757
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
2758
    
Z
zengyawen 已提交
2759 2760 2761 2762 2763 2764 2765 2766
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            var grad = this.context.createLinearGradient(50,0, 300,100)
L
lanyill 已提交
2767 2768 2769
            grad.addColorStop(0.0, '#ff0000')
            grad.addColorStop(0.5, '#ffffff')
            grad.addColorStop(1.0, '#00ff00')
Z
zengyawen 已提交
2770
            this.context.fillStyle = grad
L
lanyill 已提交
2771
            this.context.fillRect(0, 0, 400, 400)
Z
zengyawen 已提交
2772
          })
Z
zengyawen 已提交
2773
      }
Z
zengyawen 已提交
2774 2775
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2776
    }
Z
zengyawen 已提交
2777 2778
  }
  ```
Z
zengyawen 已提交
2779

Z
zengyawen 已提交
2780
  ![zh-cn_image_0000001194032466](figures/zh-cn_image_0000001194032466.png)
Z
zengyawen 已提交
2781 2782


Z
zengyawen 已提交
2783
### createRadialGradient
Z
zengyawen 已提交
2784

Z
zengyawen 已提交
2785
createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): void
Z
zengyawen 已提交
2786 2787 2788

创建一个径向渐变色。

Z
zhongjianfei 已提交
2789 2790
从API version 9开始,该接口支持在ArkTS卡片中使用。

L
lanyill 已提交
2791 2792
**参数:**

H
HelloCrease 已提交
2793 2794 2795 2796 2797 2798 2799 2800
| 参数   | 类型     | 必填   | 默认值  | 描述                |
| ---- | ------ | ---- | ---- | ----------------- |
| x0   | number | 是    | 0    | 起始圆的x轴坐标。         |
| y0   | number | 是    | 0    | 起始圆的y轴坐标。         |
| r0   | number | 是    | 0    | 起始圆的半径。必须是非负且有限的。 |
| x1   | number | 是    | 0    | 终点圆的x轴坐标。         |
| y1   | number | 是    | 0    | 终点圆的y轴坐标。         |
| r1   | number | 是    | 0    | 终点圆的半径。必须为非负且有限的。 |
Z
zengyawen 已提交
2801

L
lanyill 已提交
2802 2803
**示例:**

H
geshi  
HelloCrease 已提交
2804 2805
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2806 2807 2808
  @Entry
  @Component
  struct CreateRadialGradient {
Y
yamila 已提交
2809 2810
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
2811
    
Z
zengyawen 已提交
2812 2813 2814 2815 2816 2817 2818 2819
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
            var grad = this.context.createRadialGradient(200,200,50, 200,200,200)
L
lanyill 已提交
2820 2821 2822
            grad.addColorStop(0.0, '#ff0000')
            grad.addColorStop(0.5, '#ffffff')
            grad.addColorStop(1.0, '#00ff00')
Z
zengyawen 已提交
2823
            this.context.fillStyle = grad
L
lanyill 已提交
2824
            this.context.fillRect(0, 0, 440, 440)
Z
zengyawen 已提交
2825
          })
Z
zengyawen 已提交
2826
      }
Z
zengyawen 已提交
2827 2828
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2829
    }
Z
zengyawen 已提交
2830 2831
  }
  ```
Z
zengyawen 已提交
2832

Z
zengyawen 已提交
2833
  ![zh-cn_image_0000001239032419](figures/zh-cn_image_0000001239032419.png)
Z
zengyawen 已提交
2834

2835
### createConicGradient<sup>10+</sup>
2836 2837 2838 2839 2840 2841 2842

createConicGradient(startAngle: number, x: number, y: number): CanvasGradient

创建一个圆锥渐变色。

**参数:**

H
HelloCrease 已提交
2843 2844 2845 2846 2847
| 参数         | 类型     | 必填   | 默认值  | 描述                                  |
| ---------- | ------ | ---- | ---- | ----------------------------------- |
| startAngle | number | 是    | 0    | 开始渐变的角度,以弧度为单位。角度测量从中心右侧水平开始,顺时针移动。 |
| x          | number | 是    | 0    | 圆锥渐变的中心x轴坐标。单位:vp                   |
| y          | number | 是    | 0    | 圆锥渐变的中心y轴坐标。单位:vp                   |
2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863

**示例:**

```ts
// xxx.ets
@Entry
@Component
struct CanvasExample {
  private settings: RenderingContextSettings = new RenderingContextSettings(true)
  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Canvas(this.context)
        .width('100%')
        .height('100%')
2864
        .backgroundColor('#ffffff')
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880
        .onReady(() => {
          var grad = this.context.createConicGradient(0, 50, 80)
          grad.addColorStop(0.0, '#ff0000')
          grad.addColorStop(0.5, '#ffffff')
          grad.addColorStop(1.0, '#00ff00')
          this.context.fillStyle = grad
          this.context.fillRect(0, 30, 100, 100)
        })
    }
    .width('100%')
    .height('100%')
  }
}
```

  ![zh-cn_image_0000001239032419](figures/zh-cn_image_0000001239032420.png)