ts-canvasrenderingcontext2d.md 100.1 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
| setting | [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


## 属性

Y
yamila 已提交
41 42
| 名称                                                  | 类型                                                         | 描述                                                         |
| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
L
limeng 已提交
43
| [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卡片中使用。 |
Y
yamila 已提交
44
| [lineWidth](#linewidth)                               | number                                                       | 设置绘制线条的宽度。                                         |
L
limeng 已提交
45
| [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卡片中使用。 |
Z
zhongjianfei 已提交
46 47 48
| [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卡片中使用。 |
L
limeng 已提交
49
| [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卡片中使用。 |
Z
zhongjianfei 已提交
50 51 52 53 54 55 56 57 58 59
| [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卡片中使用。 |
60 61
| [height](#height)                                     | number                                                       | 组件高度。 <br/>单位:vp<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [width](#width)                                       | number                                                       | 组件宽度。 <br/>单位:vp<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
62 63 64
| [imageSmoothingQuality](#imagesmoothingquality)       |ImageSmoothingQuality     | imageSmoothingEnabled为true时,用于设置图像平滑度。可选值为:<br/>- 'low':低画质<br/>- 'medium':中画质<br/>- 'high':高画质。<br/>默认值:low<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [direction](#direction)       |CanvasDirection     | 用于设置绘制文字时使用的文字方向。可选值为:<br/>- 'inherit':继承canvas组件已设定的文本方向<br/>- 'ltr':从左往右<br/>- 'rtl':从右往左。<br/>默认值:inherit<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [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)


Z
zengyawen 已提交
722
## 方法
Z
zengyawen 已提交
723 724


Z
zengyawen 已提交
725 726 727
### fillRect

fillRect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
728 729 730

填充一个矩形。

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

L
lanyill 已提交
733 734
**参数:**

H
HelloCrease 已提交
735 736 737 738 739 740
| 参数     | 类型     | 必填   | 默认值  | 说明            |
| ------ | ------ | ---- | ---- | ------------- |
| x      | number | 是    | 0    | 指定矩形左上角点的x坐标。 |
| y      | number | 是    | 0    | 指定矩形左上角点的y坐标。 |
| width  | number | 是    | 0    | 指定矩形的宽度。      |
| height | number | 是    | 0    | 指定矩形的高度。      |
Z
zengyawen 已提交
741

L
lanyill 已提交
742
**示例:**
Z
zengyawen 已提交
743

H
geshi  
HelloCrease 已提交
744 745
  ```ts
  // xxx.ets
Z
zengyawen 已提交
746 747 748
  @Entry
  @Component
  struct FillRect {
Y
yamila 已提交
749 750
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
751 752 753 754 755 756 757 758
    
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
759
            this.context.fillRect(30,30,100,100)
Z
zengyawen 已提交
760 761 762 763
         })
        }
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
764
    }
Z
zengyawen 已提交
765 766
  }
  ```
Z
zengyawen 已提交
767

Z
zengyawen 已提交
768
  ![zh-cn_image_0000001194192436](figures/zh-cn_image_0000001194192436.png)
Z
zengyawen 已提交
769 770


Z
zengyawen 已提交
771
### strokeRect
Z
zengyawen 已提交
772

Z
zengyawen 已提交
773
strokeRect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
774 775 776

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

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

L
lanyill 已提交
779 780
**参数:**

H
HelloCrease 已提交
781 782 783 784 785 786
| 参数   | 类型     | 必填   | 默认值  | 说明           |
| ---- | ------ | ---- | ---- | ------------ |
| x    | number | 是    | 0    | 指定矩形的左上角x坐标。 |
| y    | number | 是    | 0    | 指定矩形的左上角y坐标。 |
| w    | number | 是    | 0    | 指定矩形的宽度。     |
| h    | number | 是    | 0    | 指定矩形的高度。     |
L
lanyill 已提交
787 788

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

H
geshi  
HelloCrease 已提交
790 791
  ```ts
  // xxx.ets
Z
zengyawen 已提交
792 793 794
  @Entry
  @Component
  struct StrokeRect {
Y
yamila 已提交
795 796
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
797

Z
zengyawen 已提交
798 799 800 801 802 803 804 805 806
    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 已提交
807
      }
Z
zengyawen 已提交
808 809
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
810
    }
Z
zengyawen 已提交
811 812
  }
  ```
Z
zengyawen 已提交
813

Z
zengyawen 已提交
814
  ![zh-cn_image_0000001194352436](figures/zh-cn_image_0000001194352436.png)
Z
zengyawen 已提交
815 816


Z
zengyawen 已提交
817
### clearRect
Z
zengyawen 已提交
818

Z
zengyawen 已提交
819
clearRect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
820 821 822

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

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

L
lanyill 已提交
825 826
**参数:**

H
HelloCrease 已提交
827 828 829 830 831 832
| 参数   | 类型     | 必填   | 默认值  | 描述            |
| ---- | ------ | ---- | ---- | ------------- |
| x    | number | 是    | 0    | 指定矩形上的左上角x坐标。 |
| y    | number | 是    | 0    | 指定矩形上的左上角y坐标。 |
| w    | number | 是    | 0    | 指定矩形的宽度。      |
| h    | number | 是    | 0    | 指定矩形的高度。      |
L
lanyill 已提交
833 834

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

H
geshi  
HelloCrease 已提交
836 837
  ```ts
  // xxx.ets
Z
zengyawen 已提交
838 839 840
  @Entry
  @Component
  struct ClearRect {
Y
yamila 已提交
841 842
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
843

Z
zengyawen 已提交
844 845 846 847 848
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
849
          .backgroundColor('#ffff00')
Z
zengyawen 已提交
850 851
          .onReady(() =>{
            this.context.fillStyle = 'rgb(0,0,255)'
L
lanyill 已提交
852 853
            this.context.fillRect(20,20,200,200)
            this.context.clearRect(30,30,150,100)
Z
zengyawen 已提交
854
        })
Z
zengyawen 已提交
855
      }
Z
zengyawen 已提交
856 857
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
858
    }
Z
zengyawen 已提交
859 860
  }
  ```
Z
zengyawen 已提交
861

Z
zengyawen 已提交
862
  ![zh-cn_image_0000001238952377](figures/zh-cn_image_0000001238952377.png)
Z
zengyawen 已提交
863 864


Z
zengyawen 已提交
865
### fillText
Z
zengyawen 已提交
866

L
lanyill 已提交
867
fillText(text: string, x: number, y: number, maxWidth?: number): void
Z
zengyawen 已提交
868 869 870

绘制填充类文本。

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

L
lanyill 已提交
873 874
**参数:**

Y
yamila 已提交
875 876 877 878 879 880
| 参数     | 类型   | 必填 | 默认值 | 说明                          |
| -------- | ------ | ---- | ------ | ----------------------------- |
| text     | string | 是   | ''     | 需要绘制的文本内容。          |
| x        | number | 是   | 0      | 需要绘制的文本的左下角x坐标。 |
| y        | number | 是   | 0      | 需要绘制的文本的左下角y坐标。 |
| maxWidth | number | 否   | -      | 指定文本允许的最大宽度。      |
L
lanyill 已提交
881 882

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

H
geshi  
HelloCrease 已提交
884 885
  ```ts
  // xxx.ets
Z
zengyawen 已提交
886 887 888
  @Entry
  @Component
  struct FillText {
Y
yamila 已提交
889 890
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
891

Z
zengyawen 已提交
892 893 894 895 896 897 898 899 900 901
    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 已提交
902
      }
Z
zengyawen 已提交
903 904
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
905
    }
Z
zengyawen 已提交
906 907
  }
  ```
Z
zengyawen 已提交
908

Z
zengyawen 已提交
909
  ![zh-cn_image_0000001194032458](figures/zh-cn_image_0000001194032458.png)
Z
zengyawen 已提交
910 911


Z
zengyawen 已提交
912
### strokeText
Z
zengyawen 已提交
913

L
lanyill 已提交
914
strokeText(text: string, x: number, y: number, maxWidth?:number): void
Z
zengyawen 已提交
915 916 917

绘制描边类文本。

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

L
lanyill 已提交
920 921
**参数:**

Y
yamila 已提交
922 923 924 925 926 927
| 参数     | 类型   | 必填 | 默认值 | 描述                          |
| -------- | ------ | ---- | ------ | ----------------------------- |
| text     | string | 是   | ''     | 需要绘制的文本内容。          |
| x        | number | 是   | 0      | 需要绘制的文本的左下角x坐标。 |
| y        | number | 是   | 0      | 需要绘制的文本的左下角y坐标。 |
| maxWidth | number | 否   | -      | 需要绘制的文本的最大宽度 。   |
L
lanyill 已提交
928 929

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

H
geshi  
HelloCrease 已提交
931 932
  ```ts
  // xxx.ets
Z
zengyawen 已提交
933 934 935
  @Entry
  @Component
  struct StrokeText {
Y
yamila 已提交
936 937
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
938

Z
zengyawen 已提交
939 940 941 942 943 944 945 946 947 948
    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 已提交
949
      }
Z
zengyawen 已提交
950 951
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
952
    }
Z
zengyawen 已提交
953 954
  }
  ```
Z
zengyawen 已提交
955

Z
zengyawen 已提交
956
  ![zh-cn_image_0000001239032413](figures/zh-cn_image_0000001239032413.png)
Z
zengyawen 已提交
957 958


Z
zengyawen 已提交
959
### measureText
Z
zengyawen 已提交
960

Z
zengyawen 已提交
961
measureText(text: string): TextMetrics
Z
zengyawen 已提交
962 963 964

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

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

L
lanyill 已提交
967 968
**参数:**

Y
yamila 已提交
969 970 971
| 参数 | 类型   | 必填 | 默认值 | 说明                 |
| ---- | ------ | ---- | ------ | -------------------- |
| text | string | 是   | ''     | 需要进行测量的文本。 |
Z
zengyawen 已提交
972

L
lanyill 已提交
973
**返回值:**
Z
zengyawen 已提交
974

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

L
lanyill 已提交
979 980
**TextMetrics类型描述:**

H
HelloCrease 已提交
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
| 属性                       | 类型     | 描述                                       |
| ------------------------ | ------ | ---------------------------------------- |
| 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 已提交
996 997 998 999 1000

  


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

H
geshi  
HelloCrease 已提交
1002 1003
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1004 1005 1006
  @Entry
  @Component
  struct MeasureText {
Y
yamila 已提交
1007 1008
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
1009

Z
zengyawen 已提交
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
    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 已提交
1021
      }
Z
zengyawen 已提交
1022 1023
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1024
    }
Z
zengyawen 已提交
1025 1026
  }
  ```
Z
zengyawen 已提交
1027

Z
zengyawen 已提交
1028
  ![zh-cn_image_0000001193872492](figures/zh-cn_image_0000001193872492.png)
Z
zengyawen 已提交
1029 1030


Z
zengyawen 已提交
1031
### stroke
Z
zengyawen 已提交
1032

Z
zengyawen 已提交
1033
stroke(path?: Path2D): void
Z
zengyawen 已提交
1034 1035 1036

进行边框绘制操作。

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

L
lanyill 已提交
1039 1040
**参数:**

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

L
lanyill 已提交
1045
**示例:**
Z
zengyawen 已提交
1046

H
geshi  
HelloCrease 已提交
1047 1048
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1049 1050 1051
  @Entry
  @Component
  struct Stroke {
Y
yamila 已提交
1052 1053
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1054

Z
zengyawen 已提交
1055 1056 1057 1058 1059 1060 1061 1062 1063
    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 已提交
1064 1065
            this.context.lineTo(75, 105)
            this.context.lineTo(75, 25)
Z
zengyawen 已提交
1066 1067 1068
            this.context.strokeStyle = 'rgb(0,0,255)'
            this.context.stroke()
          })
Z
zengyawen 已提交
1069
      }
Z
zengyawen 已提交
1070 1071
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1072
    }
Z
zengyawen 已提交
1073 1074
  }
  ```
Z
zengyawen 已提交
1075

Z
zengyawen 已提交
1076
  ![zh-cn_image_0000001238832389](figures/zh-cn_image_0000001238832389.png)
Z
zengyawen 已提交
1077 1078


Z
zengyawen 已提交
1079
### beginPath
Z
zengyawen 已提交
1080

Z
zengyawen 已提交
1081
beginPath(): void
Z
zengyawen 已提交
1082 1083 1084

创建一个新的绘制路径。

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

L
lanyill 已提交
1087 1088
**示例:**

H
geshi  
HelloCrease 已提交
1089 1090
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1091 1092 1093
  @Entry
  @Component
  struct BeginPath {
Y
yamila 已提交
1094 1095
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1096

Z
zengyawen 已提交
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
    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 已提交
1111
      }
Z
zengyawen 已提交
1112 1113
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1114
    }
Z
zengyawen 已提交
1115 1116
  }
  ```
Z
zengyawen 已提交
1117

Z
zengyawen 已提交
1118
  ![zh-cn_image_0000001238712417](figures/zh-cn_image_0000001238712417.png)
Z
zengyawen 已提交
1119 1120


Z
zengyawen 已提交
1121
### moveTo
Z
zengyawen 已提交
1122

Z
zengyawen 已提交
1123
moveTo(x: number, y: number): void
Z
zengyawen 已提交
1124 1125 1126

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

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

L
lanyill 已提交
1129 1130
**参数:**

H
HelloCrease 已提交
1131 1132 1133 1134
| 参数   | 类型     | 必填   | 默认值  | 说明        |
| ---- | ------ | ---- | ---- | --------- |
| x    | number | 是    | 0    | 指定位置的x坐标。 |
| y    | number | 是    | 0    | 指定位置的y坐标。 |
Z
zengyawen 已提交
1135

L
lanyill 已提交
1136
**示例:**
Z
zengyawen 已提交
1137

H
geshi  
HelloCrease 已提交
1138 1139
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1140 1141 1142
  @Entry
  @Component
  struct MoveTo {
Y
yamila 已提交
1143 1144
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1145

Z
zengyawen 已提交
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
    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 已提交
1158
      }
Z
zengyawen 已提交
1159 1160
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1161
    }
Z
zengyawen 已提交
1162 1163
  }
  ```
Z
zengyawen 已提交
1164

Z
zengyawen 已提交
1165
  ![zh-cn_image_0000001194192438](figures/zh-cn_image_0000001194192438.png)
Z
zengyawen 已提交
1166 1167


Z
zengyawen 已提交
1168
### lineTo
Z
zengyawen 已提交
1169

Z
zengyawen 已提交
1170
lineTo(x: number, y: number): void
Z
zengyawen 已提交
1171 1172 1173

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

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

L
lanyill 已提交
1176 1177
**参数:**

H
HelloCrease 已提交
1178 1179 1180 1181
| 参数   | 类型     | 必填   | 默认值  | 描述        |
| ---- | ------ | ---- | ---- | --------- |
| x    | number | 是    | 0    | 指定位置的x坐标。 |
| y    | number | 是    | 0    | 指定位置的y坐标。 |
Z
zengyawen 已提交
1182

L
lanyill 已提交
1183
**示例:**
Z
zengyawen 已提交
1184

H
geshi  
HelloCrease 已提交
1185 1186
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1187 1188 1189
  @Entry
  @Component
  struct LineTo {
Y
yamila 已提交
1190 1191
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1192

Z
zengyawen 已提交
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
    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 已提交
1205
      }
Z
zengyawen 已提交
1206 1207
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1208
    }
Z
zengyawen 已提交
1209 1210
  }
  ```
Z
zengyawen 已提交
1211

Z
zengyawen 已提交
1212
  ![zh-cn_image_0000001194352438](figures/zh-cn_image_0000001194352438.png)
Z
zengyawen 已提交
1213 1214


Z
zengyawen 已提交
1215
### closePath
Z
zengyawen 已提交
1216

Z
zengyawen 已提交
1217
closePath(): void
Z
zengyawen 已提交
1218 1219 1220

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

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

L
lanyill 已提交
1223 1224
**示例:**

H
geshi  
HelloCrease 已提交
1225 1226
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1227 1228 1229
  @Entry
  @Component
  struct ClosePath {
Y
yamila 已提交
1230 1231
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1232

Z
zengyawen 已提交
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
    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 已提交
1247
      }
Z
zengyawen 已提交
1248 1249
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1250
    }
Z
zengyawen 已提交
1251 1252
  }
  ```
Z
zengyawen 已提交
1253

Z
zengyawen 已提交
1254
  ![zh-cn_image_0000001238952379](figures/zh-cn_image_0000001238952379.png)
Z
zengyawen 已提交
1255 1256


Z
zengyawen 已提交
1257
### createPattern
Z
zengyawen 已提交
1258

L
lanyill 已提交
1259
createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | null
Z
zengyawen 已提交
1260 1261 1262

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

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

L
lanyill 已提交
1265 1266
**参数:**

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

L
limeng 已提交
1272
**返回值:**
L
lanyill 已提交
1273

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

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

H
geshi  
HelloCrease 已提交
1280 1281
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1282 1283 1284
  @Entry
  @Component
  struct CreatePattern {
Y
yamila 已提交
1285 1286 1287
    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 已提交
1288

Z
zengyawen 已提交
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
    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 已提交
1300
      }
Z
zengyawen 已提交
1301 1302
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1303
    }
Z
zengyawen 已提交
1304 1305
  }
  ```
Z
zengyawen 已提交
1306

Z
zengyawen 已提交
1307
  ![zh-cn_image_0000001194032460](figures/zh-cn_image_0000001194032460.png)
Z
zengyawen 已提交
1308 1309


Z
zengyawen 已提交
1310
### bezierCurveTo
Z
zengyawen 已提交
1311

Z
zengyawen 已提交
1312
bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): void
Z
zengyawen 已提交
1313 1314 1315

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

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

L
lanyill 已提交
1318 1319
**参数:**

H
HelloCrease 已提交
1320 1321 1322 1323 1324 1325 1326 1327
| 参数   | 类型     | 必填   | 默认值  | 描述             |
| ---- | ------ | ---- | ---- | -------------- |
| 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 已提交
1328

L
lanyill 已提交
1329 1330
**示例:**

H
geshi  
HelloCrease 已提交
1331 1332
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1333 1334 1335
  @Entry
  @Component
  struct BezierCurveTo {
Y
yamila 已提交
1336 1337
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1338

Z
zengyawen 已提交
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
    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 已提交
1351
      }
Z
zengyawen 已提交
1352 1353
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1354
    }
Z
zengyawen 已提交
1355 1356
  }
  ```
Z
zengyawen 已提交
1357

Z
zengyawen 已提交
1358
  ![zh-cn_image_0000001239032415](figures/zh-cn_image_0000001239032415.png)
Z
zengyawen 已提交
1359 1360


Z
zengyawen 已提交
1361
### quadraticCurveTo
Z
zengyawen 已提交
1362

Z
zengyawen 已提交
1363
quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void
Z
zengyawen 已提交
1364 1365 1366

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

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

L
lanyill 已提交
1369 1370
**参数:**

H
HelloCrease 已提交
1371 1372 1373 1374 1375 1376
| 参数   | 类型     | 必填   | 默认值  | 描述          |
| ---- | ------ | ---- | ---- | ----------- |
| cpx  | number | 是    | 0    | 贝塞尔参数的x坐标值。 |
| cpy  | number | 是    | 0    | 贝塞尔参数的y坐标值。 |
| x    | number | 是    | 0    | 路径结束时的x坐标值。 |
| y    | number | 是    | 0    | 路径结束时的y坐标值。 |
Z
zengyawen 已提交
1377

L
lanyill 已提交
1378
**示例:**
Z
zengyawen 已提交
1379

H
geshi  
HelloCrease 已提交
1380 1381
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1382 1383 1384
  @Entry
  @Component
  struct QuadraticCurveTo {
Y
yamila 已提交
1385 1386
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
1387

Z
zengyawen 已提交
1388 1389 1390 1391 1392 1393 1394
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
1395 1396 1397 1398
            this.context.beginPath()
            this.context.moveTo(20, 20)
            this.context.quadraticCurveTo(100, 100, 200, 20)
            this.context.stroke()
Z
zengyawen 已提交
1399
        })
Z
zengyawen 已提交
1400
      }
Z
zengyawen 已提交
1401 1402
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1403
    }
Z
zengyawen 已提交
1404 1405
  }
  ```
Z
zengyawen 已提交
1406

Z
zengyawen 已提交
1407
  ![zh-cn_image_0000001193872494](figures/zh-cn_image_0000001193872494.png)
Z
zengyawen 已提交
1408 1409


Z
zengyawen 已提交
1410
### arc
Z
zengyawen 已提交
1411

L
lanyill 已提交
1412
arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void
Z
zengyawen 已提交
1413 1414 1415

绘制弧线路径。

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

L
lanyill 已提交
1418 1419
**参数:**

H
HelloCrease 已提交
1420 1421 1422 1423 1424 1425 1426 1427
| 参数               | 类型      | 必填   | 默认值   | 描述         |
| ---------------- | ------- | ---- | ----- | ---------- |
| x                | number  | 是    | 0     | 弧线圆心的x坐标值。 |
| y                | number  | 是    | 0     | 弧线圆心的y坐标值。 |
| radius           | number  | 是    | 0     | 弧线的圆半径。    |
| startAngle       | number  | 是    | 0     | 弧线的起始弧度。   |
| endAngle         | number  | 是    | 0     | 弧线的终止弧度。   |
| counterclockwise | boolean | 否    | false | 是否逆时针绘制圆弧。 |
L
lanyill 已提交
1428 1429

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

H
geshi  
HelloCrease 已提交
1431 1432
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1433 1434 1435
  @Entry
  @Component
  struct Arc {
Y
yamila 已提交
1436 1437
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1438

Z
zengyawen 已提交
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
    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 已提交
1450
      }
Z
zengyawen 已提交
1451 1452
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1453
    }
Z
zengyawen 已提交
1454 1455
  }
  ```
Z
zengyawen 已提交
1456

Z
zengyawen 已提交
1457
  ![zh-cn_image_0000001238832391](figures/zh-cn_image_0000001238832391.png)
Z
zengyawen 已提交
1458 1459


Z
zengyawen 已提交
1460
### arcTo
Z
zengyawen 已提交
1461

Z
zengyawen 已提交
1462
arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void
Z
zengyawen 已提交
1463 1464 1465

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

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

L
lanyill 已提交
1468 1469
**参数:**

H
HelloCrease 已提交
1470 1471 1472 1473 1474 1475 1476
| 参数     | 类型     | 必填   | 默认值  | 描述              |
| ------ | ------ | ---- | ---- | --------------- |
| x1     | number | 是    | 0    | 圆弧经过的第一个点的x坐标值。 |
| y1     | number | 是    | 0    | 圆弧经过的第一个点的y坐标值。 |
| x2     | number | 是    | 0    | 圆弧经过的第二个点的x坐标值。 |
| y2     | number | 是    | 0    | 圆弧经过的第二个点的y坐标值。 |
| radius | number | 是    | 0    | 圆弧的圆半径值。        |
Z
zengyawen 已提交
1477

L
lanyill 已提交
1478
**示例:**
Z
zengyawen 已提交
1479

H
geshi  
HelloCrease 已提交
1480 1481
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1482 1483 1484
  @Entry
  @Component
  struct ArcTo {
Y
yamila 已提交
1485 1486
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1487

Z
zengyawen 已提交
1488 1489 1490 1491 1492 1493 1494
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
1495 1496 1497
            this.context.moveTo(100, 20)
            this.context.arcTo(150, 20, 150, 70, 50)
            this.context.stroke()
Z
zengyawen 已提交
1498
          })
Z
zengyawen 已提交
1499
      }
Z
zengyawen 已提交
1500 1501
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1502
    }
Z
zengyawen 已提交
1503 1504
  }
  ```
Z
zengyawen 已提交
1505

Z
zengyawen 已提交
1506
  ![zh-cn_image_0000001238712419](figures/zh-cn_image_0000001238712419.png)
Z
zengyawen 已提交
1507 1508


Z
zengyawen 已提交
1509
### ellipse
Z
zengyawen 已提交
1510

L
lanyill 已提交
1511
ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void
Z
zengyawen 已提交
1512 1513 1514

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

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

L
lanyill 已提交
1517 1518
**参数:**

H
HelloCrease 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527
| 参数               | 类型      | 必填   | 默认值   | 说明                |
| ---------------- | ------- | ---- | ----- | ----------------- |
| 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     | 椭圆绘制的结束点角度,以弧度表示。 |
L
lanyill 已提交
1528
| counterclockwise | boolean | 否    | false | 是否以逆时针方向绘制椭圆。<br>true:逆时针方向绘制椭圆。<br>false:顺时针方向绘制椭圆。     |
Z
zengyawen 已提交
1529

L
lanyill 已提交
1530
**示例:**
Z
zengyawen 已提交
1531

H
geshi  
HelloCrease 已提交
1532 1533
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1534 1535 1536
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
1537 1538
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1539

Z
zengyawen 已提交
1540 1541 1542 1543 1544 1545 1546 1547
    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 已提交
1548
            this.context.ellipse(200, 200, 50, 100, Math.PI * 0.25, Math.PI * 0.5, Math.PI * 2)
Z
zengyawen 已提交
1549 1550
            this.context.stroke()
          })
Z
zengyawen 已提交
1551
      }
Z
zengyawen 已提交
1552 1553
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1554
    }
Z
zengyawen 已提交
1555 1556
  }
  ```
H
geshi  
HelloCrease 已提交
1557

Z
zengyawen 已提交
1558
  ![zh-cn_image_0000001194192440](figures/zh-cn_image_0000001194192440.png)
Z
zengyawen 已提交
1559 1560


Z
zengyawen 已提交
1561
### rect
Z
zengyawen 已提交
1562

L
lanyill 已提交
1563
rect(x: number, y: number, w: number, h: number): void
Z
zengyawen 已提交
1564 1565 1566

创建矩形路径。

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

L
lanyill 已提交
1569 1570
**参数:**

H
HelloCrease 已提交
1571 1572 1573 1574 1575 1576
| 参数   | 类型     | 必填   | 默认值  | 描述            |
| ---- | ------ | ---- | ---- | ------------- |
| x    | number | 是    | 0    | 指定矩形的左上角x坐标值。 |
| y    | number | 是    | 0    | 指定矩形的左上角y坐标值。 |
| w    | number | 是    | 0    | 指定矩形的宽度。      |
| h    | number | 是    | 0    | 指定矩形的高度。      |
L
lanyill 已提交
1577 1578

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

H
geshi  
HelloCrease 已提交
1580 1581
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1582 1583 1584
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
1585 1586
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1587

Z
zengyawen 已提交
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
    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 已提交
1598
      }
Z
zengyawen 已提交
1599 1600
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1601
    }
Z
zengyawen 已提交
1602 1603
  }
  ```
Z
zengyawen 已提交
1604

Z
zengyawen 已提交
1605
  ![zh-cn_image_0000001194352440](figures/zh-cn_image_0000001194352440.png)
Z
zengyawen 已提交
1606 1607


Z
zengyawen 已提交
1608
### fill
Z
zengyawen 已提交
1609

L
lanyill 已提交
1610
fill(fillRule?: CanvasFillRule): void
Z
zengyawen 已提交
1611 1612 1613

对封闭路径进行填充。

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

L
lanyill 已提交
1616 1617
**参数:** 

H
HelloCrease 已提交
1618 1619 1620
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要填充对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |
L
lanyill 已提交
1621 1622 1623 1624


**示例:**   

H
geshi  
HelloCrease 已提交
1625 1626
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1627 1628 1629
  @Entry
  @Component
  struct Fill {
Y
yamila 已提交
1630 1631
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1632

Z
zengyawen 已提交
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
    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 已提交
1643
      }
Z
zengyawen 已提交
1644 1645
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1646
    }
Z
zengyawen 已提交
1647 1648
  }
  ```
Z
zengyawen 已提交
1649

Z
zengyawen 已提交
1650
  ![zh-cn_image_0000001238952381](figures/zh-cn_image_0000001238952381.png)
Z
zengyawen 已提交
1651 1652


L
lanyill 已提交
1653 1654 1655 1656
fill(path: Path2D, fillRule?: CanvasFillRule): void

对封闭路径进行填充。

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

L
lanyill 已提交
1659 1660
**参数:** 

H
HelloCrease 已提交
1661 1662 1663 1664
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| path     | Path2D         | 是    |           | Path2D填充路径。                              |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要填充对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |
L
lanyill 已提交
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683


**示例:**   

```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 已提交
1684 1685 1686 1687 1688 1689 1690 1691
          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 已提交
1692
          // Fill path
L
lanyill 已提交
1693
          this.context.fillStyle = '#00ff00'
Y
yamila 已提交
1694
          this.context.fill(region, "evenodd")
L
lanyill 已提交
1695 1696 1697 1698 1699 1700
        })
    }
    .width('100%')
    .height('100%')
  }
}
H
HelloCrease 已提交
1701
```
L
lanyill 已提交
1702 1703 1704 1705

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


Z
zengyawen 已提交
1706
### clip
Z
zengyawen 已提交
1707

L
lanyill 已提交
1708
clip(fillRule?: CanvasFillRule): void
Z
zengyawen 已提交
1709 1710 1711

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

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

L
lanyill 已提交
1714 1715
**参数:** 

H
HelloCrease 已提交
1716 1717 1718
| 参数       | 类型             | 必填   | 默认值       | 描述                                       |
| -------- | -------------- | ---- | --------- | ---------------------------------------- |
| fillRule | CanvasFillRule | 否    | "nonzero" | 指定要剪切对象的规则。<br/>可选参数为:"nonzero", "evenodd"。 |
L
lanyill 已提交
1719 1720 1721

**示例:** 

H
geshi  
HelloCrease 已提交
1722 1723
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1724 1725 1726
  @Entry
  @Component
  struct Clip {
Y
yamila 已提交
1727 1728
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1729

Z
zengyawen 已提交
1730 1731 1732 1733 1734 1735 1736
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
1737
            this.context.rect(0, 0, 100, 200)
Z
zengyawen 已提交
1738 1739 1740
            this.context.stroke()
            this.context.clip()
            this.context.fillStyle = "rgb(255,0,0)"
L
lanyill 已提交
1741
            this.context.fillRect(0, 0, 200, 200)
Z
zengyawen 已提交
1742
          })
Z
zengyawen 已提交
1743
      }
Z
zengyawen 已提交
1744 1745
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1746
    }
Z
zengyawen 已提交
1747 1748
  }
  ```
H
geshi  
HelloCrease 已提交
1749

Z
zengyawen 已提交
1750
  ![zh-cn_image_0000001194032462](figures/zh-cn_image_0000001194032462.png)
Z
zengyawen 已提交
1751 1752


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

L
lanyill 已提交
1755
设置当前路径为剪切路径
L
lanyill 已提交
1756

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

L
lanyill 已提交
1759 1760
**参数:** 

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

L
lanyill 已提交
1766

L
lanyill 已提交
1767 1768 1769 1770
**示例:** 

  ```ts
  // xxx.ets
L
lanyill 已提交
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
  @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 已提交
1798 1799 1800 1801 1802 1803
    }
  }
  ```

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

L
lanyill 已提交
1804 1805 1806 1807 1808

### filter

filter(filter: string): void

1809
为Canvas图形设置各类滤镜效果。
L
lanyill 已提交
1810

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

L
lanyill 已提交
1813 1814
**参数:**

H
HelloCrease 已提交
1815 1816
| 参数     | 类型     | 必填   | 默认值  | 说明           |
| ------ | ------ | ---- | ---- | ------------ |
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
| 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' |

**示例:**
```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)
L
lanyill 已提交
1879 1880 1881 1882 1883 1884 1885 1886


### getTransform

getTransform(): Matrix2D

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

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

L
limeng 已提交
1889 1890 1891 1892 1893 1894
**返回值:**

| 类型                                                  | 说明       |
| ----------------------------------------------------- | ---------- |
| [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 矩阵对象。 |

L
lanyill 已提交
1895 1896 1897 1898 1899 1900 1901

### resetTransform

resetTransform(): void

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

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

L
lanyill 已提交
1904 1905 1906 1907 1908

### direction

direction(direction: CanvasDirection): void

1909
绘制文本时,描述当前文本方向的属性。
L
lanyill 已提交
1910

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

1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
**示例:**
```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)
L
lanyill 已提交
1945

Z
zengyawen 已提交
1946
### rotate
Z
zengyawen 已提交
1947

L
lanyill 已提交
1948
rotate(angle: number): void
Z
zengyawen 已提交
1949 1950 1951

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

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

L
lanyill 已提交
1954 1955
**参数:**

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

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

H
geshi  
HelloCrease 已提交
1962 1963
  ```ts
  // xxx.ets
Z
zengyawen 已提交
1964 1965 1966
  @Entry
  @Component
  struct Rotate {
Y
yamila 已提交
1967 1968
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
1969

Z
zengyawen 已提交
1970 1971 1972 1973 1974 1975 1976
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
1977
            this.context.rotate(45 * Math.PI / 180)
Z
zengyawen 已提交
1978 1979
            this.context.fillRect(70, 20, 50, 50)
          })
Z
zengyawen 已提交
1980
      }
Z
zengyawen 已提交
1981 1982
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
1983
    }
Z
zengyawen 已提交
1984 1985
  }
  ```
Z
zengyawen 已提交
1986

Z
zengyawen 已提交
1987
  ![zh-cn_image_0000001239032417](figures/zh-cn_image_0000001239032417.png)
Z
zengyawen 已提交
1988 1989


Z
zengyawen 已提交
1990
### scale
Z
zengyawen 已提交
1991

Z
zengyawen 已提交
1992
scale(x: number, y: number): void
Z
zengyawen 已提交
1993 1994 1995

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

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

L
lanyill 已提交
1998 1999
**参数:**

H
HelloCrease 已提交
2000 2001 2002 2003
| 参数   | 类型     | 必填   | 默认值  | 描述          |
| ---- | ------ | ---- | ---- | ----------- |
| x    | number | 是    | 0    | 设置水平方向的缩放值。 |
| y    | number | 是    | 0    | 设置垂直方向的缩放值。 |
Z
zengyawen 已提交
2004

L
lanyill 已提交
2005
**示例:**
Z
zengyawen 已提交
2006

H
geshi  
HelloCrease 已提交
2007 2008
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2009 2010 2011
  @Entry
  @Component
  struct Scale {
Y
yamila 已提交
2012 2013
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2014

Z
zengyawen 已提交
2015 2016 2017 2018 2019 2020 2021
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
L
lanyill 已提交
2022 2023
            this.context.lineWidth = 3
            this.context.strokeRect(30, 30, 50, 50)
Z
zengyawen 已提交
2024
            this.context.scale(2, 2) // Scale to 200%
L
lanyill 已提交
2025
            this.context.strokeRect(30, 30, 50, 50)
Z
zengyawen 已提交
2026
          })
Z
zengyawen 已提交
2027
      }
Z
zengyawen 已提交
2028 2029
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2030
    }
Z
zengyawen 已提交
2031 2032
  }
  ```
Z
zengyawen 已提交
2033

Z
zengyawen 已提交
2034
  ![zh-cn_image_0000001193872498](figures/zh-cn_image_0000001193872498.png)
Z
zengyawen 已提交
2035 2036


Z
zengyawen 已提交
2037
### transform
Z
zengyawen 已提交
2038

L
lanyill 已提交
2039
transform(a: number, b: number, c: number, d: number, e: number, f: number): void
Z
zengyawen 已提交
2040 2041 2042

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

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

zyjhandsome's avatar
zyjhandsome 已提交
2045
> **说明:**
Z
zengyawen 已提交
2046
> 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标):
H
geshi  
HelloCrease 已提交
2047
>
Z
zengyawen 已提交
2048
> - x' = scaleX \* x + skewY \* y + translateX
H
geshi  
HelloCrease 已提交
2049
>
Z
zengyawen 已提交
2050 2051
> - y' = skewX \* x + scaleY \* y + translateY

L
lanyill 已提交
2052 2053
**参数:**

H
HelloCrease 已提交
2054 2055 2056 2057 2058 2059 2060 2061
| 参数   | 类型     | 必填   | 默认值  | 描述                   |
| ---- | ------ | ---- | ---- | -------------------- |
| 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 已提交
2062 2063 2064

**示例:**

H
geshi  
HelloCrease 已提交
2065 2066
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2067 2068 2069
  @Entry
  @Component
  struct Transform {
Y
yamila 已提交
2070 2071
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2072

Z
zengyawen 已提交
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088
    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 已提交
2089
      }
Z
zengyawen 已提交
2090 2091
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2092
    }
Z
zengyawen 已提交
2093 2094 2095 2096 2097 2098 2099 2100
  }
  ```

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


### setTransform

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

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

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

L
lanyill 已提交
2107 2108
**参数:**

H
HelloCrease 已提交
2109 2110 2111 2112 2113 2114 2115 2116
| 参数   | 类型     | 必填   | 默认值  | 描述                   |
| ---- | ------ | ---- | ---- | -------------------- |
| 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 已提交
2117 2118 2119

**示例:**

H
geshi  
HelloCrease 已提交
2120 2121
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2122 2123 2124
  @Entry
  @Component
  struct SetTransform {
Y
yamila 已提交
2125 2126
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2127

Z
zengyawen 已提交
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140
    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 已提交
2141
      }
Z
zengyawen 已提交
2142 2143
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2144
    }
Z
zengyawen 已提交
2145 2146
  }
  ```
Z
zengyawen 已提交
2147

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

L
limeng 已提交
2150
### setTransform
Z
zengyawen 已提交
2151

L
lanyill 已提交
2152 2153 2154 2155
setTransform(transform?: Matrix2D): void

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

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

L
limeng 已提交
2158 2159 2160 2161 2162
**参数:**

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

Z
zengyawen 已提交
2164
### translate
Z
zengyawen 已提交
2165

Z
zengyawen 已提交
2166
translate(x: number, y: number): void
Z
zengyawen 已提交
2167 2168 2169

移动当前坐标系的原点。

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

L
lanyill 已提交
2172 2173
**参数:**

H
HelloCrease 已提交
2174 2175 2176 2177
| 参数   | 类型     | 必填   | 默认值  | 描述       |
| ---- | ------ | ---- | ---- | -------- |
| x    | number | 是    | 0    | 设置水平平移量。 |
| y    | number | 是    | 0    | 设置竖直平移量。 |
Z
zengyawen 已提交
2178

L
lanyill 已提交
2179
**示例:**
Z
zengyawen 已提交
2180

H
geshi  
HelloCrease 已提交
2181 2182
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2183 2184 2185
  @Entry
  @Component
  struct Translate {
Y
yamila 已提交
2186 2187
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2188

Z
zengyawen 已提交
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
    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 已提交
2200
      }
Z
zengyawen 已提交
2201 2202
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2203
    }
Z
zengyawen 已提交
2204 2205
  }
  ```
Z
zengyawen 已提交
2206

Z
zengyawen 已提交
2207
  ![zh-cn_image_0000001194192446](figures/zh-cn_image_0000001194192446.png)
Z
zengyawen 已提交
2208 2209


Z
zengyawen 已提交
2210
### drawImage
Z
zengyawen 已提交
2211

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

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

L
lanyill 已提交
2216
drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh: number, dx: number, dy: number, dw: number, dh: number):void
Z
zengyawen 已提交
2217 2218 2219

进行图像绘制。

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

L
lanyill 已提交
2222 2223
**参数:**

H
HelloCrease 已提交
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
| 参数    | 类型                                       | 必填   | 默认值  | 描述                                       |
| ----- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| 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 已提交
2235

Z
zengyawen 已提交
2236

L
lanyill 已提交
2237
**示例:**
Z
zengyawen 已提交
2238

H
geshi  
HelloCrease 已提交
2239 2240
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2241 2242 2243
  @Entry
  @Component
  struct ImageExample {
Y
yamila 已提交
2244 2245
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Y
yamila 已提交
2246
    private img:ImageBitmap = new ImageBitmap("common/images/example.jpg")
L
lanyill 已提交
2247

Z
zengyawen 已提交
2248 2249 2250 2251 2252 2253 2254
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
2255
            this.context.drawImage( this.img,0,0,500,500,0,0,400,200)
Z
zengyawen 已提交
2256
        })
Z
zengyawen 已提交
2257
      }
Z
zengyawen 已提交
2258 2259
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2260
    }
Z
zengyawen 已提交
2261 2262 2263 2264 2265 2266 2267 2268
  }
  ```

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


### createImageData

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

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

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

L
lanyill 已提交
2275 2276
**参数:**

H
HelloCrease 已提交
2277 2278 2279 2280
| 参数   | 类型     | 必填   | 默认   | 描述            |
| ---- | ------ | ---- | ---- | ------------- |
| sw   | number | 是    | 0    | ImageData的宽度。 |
| sh   | number | 是    | 0    | ImageData的高度。 |
Z
zengyawen 已提交
2281 2282


L
lanyill 已提交
2283
createImageData(imageData: ImageData): ImageData
Z
zengyawen 已提交
2284

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

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

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

H
HelloCrease 已提交
2291 2292
| 参数        | 类型                                       | 必填   | 默认   | 描述                |
| --------- | ---------------------------------------- | ---- | ---- | ----------------- |
L
lanyill 已提交
2293
| imagedata | [ImageData](ts-components-canvas-imagedata.md) | 是    | null | 复制现有的ImageData对象。 |
L
lanyill 已提交
2294 2295 2296

  **返回值:**

H
HelloCrease 已提交
2297 2298
| 类型                                       | 说明             |
| ---------------------------------------- | -------------- |
L
lanyill 已提交
2299
| [ImageData](ts-components-canvas-imagedata.md) | 新的ImageData对象。 |
L
lanyill 已提交
2300

Z
zengyawen 已提交
2301

Y
yaoyuchi 已提交
2302 2303 2304 2305 2306
### getPixelMap

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

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

**参数:**

H
HelloCrease 已提交
2310 2311 2312 2313 2314 2315
| 参数   | 类型     | 必填   | 默认值  | 描述              |
| ---- | ------ | ---- | ---- | --------------- |
| sx   | number | 是    | 0    | 需要输出的区域的左上角x坐标。 |
| sy   | number | 是    | 0    | 需要输出的区域的左上角y坐标。 |
| sw   | number | 是    | 0    | 需要输出的区域的宽度。     |
| sh   | number | 是    | 0    | 需要输出的区域的高度。     |
Z
zengyawen 已提交
2316

L
lanyill 已提交
2317 2318
**返回值:**

H
HelloCrease 已提交
2319 2320 2321
| 类型                                       | 说明            |
| ---------------------------------------- | ------------- |
| [PixelMap](../apis/js-apis-image.md#pixelmap7) | 新的PixelMap对象。 |
Z
zengyawen 已提交
2322 2323 2324

### getImageData

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

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

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

L
lanyill 已提交
2331 2332
**参数:**

H
HelloCrease 已提交
2333 2334 2335 2336 2337 2338
| 参数   | 类型     | 必填   | 默认值  | 描述              |
| ---- | ------ | ---- | ---- | --------------- |
| sx   | number | 是    | 0    | 需要输出的区域的左上角x坐标。 |
| sy   | number | 是    | 0    | 需要输出的区域的左上角y坐标。 |
| sw   | number | 是    | 0    | 需要输出的区域的宽度。     |
| sh   | number | 是    | 0    | 需要输出的区域的高度。     |
Z
zengyawen 已提交
2339

L
lanyill 已提交
2340 2341
  **返回值:**

H
HelloCrease 已提交
2342 2343
| 类型                                       | 说明             |
| ---------------------------------------- | -------------- |
L
lanyill 已提交
2344 2345 2346 2347 2348 2349 2350
| [ImageData](ts-components-canvas-imagedata.md) | 新的ImageData对象。 |


**示例:**

  ```ts
  // xxx.ets
L
lanyill 已提交
2351 2352 2353 2354 2355 2356
  @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 已提交
2357

L
lanyill 已提交
2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
    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 已提交
2372 2373 2374 2375 2376
    }
  }
  ```

  ![zh-cn_image_000000127777780](figures/zh-cn_image_000000127777780.png)
Z
zengyawen 已提交
2377 2378 2379 2380


### putImageData

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

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

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

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

L
lanyill 已提交
2389 2390
**参数:**

L
limeng 已提交
2391 2392 2393 2394 2395 2396 2397 2398 2399
| 参数        | 类型                                           | 必填 | 默认值          | 描述                                                      |
| ----------- | ---------------------------------------------- | ---- | --------------- | --------------------------------------------------------- |
| 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 已提交
2400

L
lanyill 已提交
2401 2402
**示例:**

H
geshi  
HelloCrease 已提交
2403 2404
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2405 2406 2407
  @Entry
  @Component
  struct PutImageData {
Y
yamila 已提交
2408 2409
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2410

Z
zengyawen 已提交
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426
    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 已提交
2427
      }
Z
zengyawen 已提交
2428 2429
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2430
    }
Z
zengyawen 已提交
2431 2432
  }
  ```
Z
zengyawen 已提交
2433

Z
zengyawen 已提交
2434
  ![zh-cn_image_0000001238952387](figures/zh-cn_image_0000001238952387.png)
Z
zengyawen 已提交
2435 2436


L
lanyill 已提交
2437 2438 2439 2440 2441 2442
### setLineDash

setLineDash(segments: number[]): void

设置画布的虚线样式。

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

L
lanyill 已提交
2445 2446
**参数:** 

H
HelloCrease 已提交
2447 2448
| 参数       | 类型       | 描述                  |
| -------- | -------- | ------------------- |
L
lanyill 已提交
2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
| 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 已提交
2470
            this.context.stroke()
L
lanyill 已提交
2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487
          })
      }
      .width('100%')
      .height('100%')
    }
  }
  ```

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


### getLineDash

getLineDash(): number[]

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

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

L
lanyill 已提交
2490 2491
**返回值:** 

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

L
lanyill 已提交
2496

L
lanyill 已提交
2497 2498 2499 2500
**示例:** 

  ```ts
  // xxx.ets
L
lanyill 已提交
2501 2502 2503 2504 2505 2506
  @Entry
  @Component
  struct CanvasGetLineDash {
    @State message: string = 'Hello World'
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
2507

L
lanyill 已提交
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530
    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 已提交
2531
      }
L
lanyill 已提交
2532
      .height('100%')
L
lanyill 已提交
2533 2534 2535
    }
  }
  ```
L
lanyill 已提交
2536 2537
![zh-cn_image_000000127777778](figures/zh-cn_image_000000127777778.png) 

L
lanyill 已提交
2538 2539 2540 2541 2542 2543


### imageSmoothingQuality

imageSmoothingQuality(quality: imageSmoothingQuality)

2544
用于设置图像平滑度。
L
lanyill 已提交
2545

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

L
lanyill 已提交
2548 2549
 **参数:** 

H
HelloCrease 已提交
2550 2551
| 参数      | 类型                    | 描述                                       |
| ------- | --------------------- | ---------------------------------------- |
2552
| quality | imageSmoothingQuality | 支持如下三种类型:<br/>- 'low':低画质<br/>- 'medium':中画质<br/>- 'high':高画质 |
L
lanyill 已提交
2553

2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
**示例:**
```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%')
    }
  }
```
L
lanyill 已提交
2582

2583
![ImageSmoothingQualityDemo](figures/ImageSmoothingQualityDemo.jpeg)
L
lanyill 已提交
2584 2585 2586 2587 2588 2589 2590

### transferFromImageBitmap

transferFromImageBitmap(bitmap: ImageBitmap): void

显示给定的ImageBitmap对象。

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

L
lanyill 已提交
2593 2594
**参数:** 

H
HelloCrease 已提交
2595 2596
| 参数     | 类型                                       | 描述                 |
| ------ | ---------------------------------------- | ------------------ |
L
lanyill 已提交
2597
| bitmap | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 待显示的ImageBitmap对象。 |
L
lanyill 已提交
2598 2599 2600 2601 2602 2603 2604

**示例:** 

  ```ts
  // xxx.ets
  @Entry
  @Component
L
lanyill 已提交
2605
  struct TransferFromImageBitmap {
L
lanyill 已提交
2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
    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 已提交
2634 2635
  ![zh-cn_image_0000001238952387](figures/zh-cn_image_0000001238952387.png)  

L
lanyill 已提交
2636 2637 2638 2639 2640 2641 2642

### toDataURL

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

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

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

L
lanyill 已提交
2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
**参数:** 

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

**返回值:** 

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

**示例:**

  ```ts
  // xxx.ets
L
lanyill 已提交
2662 2663 2664 2665 2666
  @Entry
  @Component
  struct ToDataURL {
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
L
lanyill 已提交
2667

L
lanyill 已提交
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679
    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 已提交
2680 2681 2682 2683 2684
    }
  }
  ```


Z
zengyawen 已提交
2685
### restore
Z
zengyawen 已提交
2686

Z
zengyawen 已提交
2687
restore(): void
Z
zengyawen 已提交
2688 2689 2690

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

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

L
lanyill 已提交
2693 2694
**示例:**

H
geshi  
HelloCrease 已提交
2695 2696
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2697 2698 2699
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
2700 2701
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2702

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


Z
zengyawen 已提交
2725
### save
Z
zengyawen 已提交
2726

Z
zengyawen 已提交
2727
save(): void
Z
zengyawen 已提交
2728

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

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

L
lanyill 已提交
2733 2734
**示例:**

H
geshi  
HelloCrease 已提交
2735 2736
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2737 2738 2739
  @Entry
  @Component
  struct CanvasExample {
Y
yamila 已提交
2740 2741
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
H
geshi  
HelloCrease 已提交
2742

Z
zengyawen 已提交
2743 2744 2745 2746 2747 2748 2749
    build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        Canvas(this.context)
          .width('100%')
          .height('100%')
          .backgroundColor('#ffff00')
          .onReady(() =>{
Y
yamila 已提交
2750
            this.context.save() // save the default state
L
lanyill 已提交
2751
            this.context.fillStyle = "#00ff00"
Y
yamila 已提交
2752 2753 2754
            this.context.fillRect(20, 20, 100, 100)
            this.context.restore() // restore to the default state
            this.context.fillRect(150, 75, 100, 100)
L
lanyill 已提交
2755
          })
Z
zengyawen 已提交
2756
      }
Z
zengyawen 已提交
2757 2758
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2759
    }
Z
zengyawen 已提交
2760 2761
  }
  ```
L
lanyill 已提交
2762
  ![zh-cn_image_000000127777781](figures/zh-cn_image_000000127777781.png)
Z
zengyawen 已提交
2763 2764


Z
zengyawen 已提交
2765
### createLinearGradient
Z
zengyawen 已提交
2766

Z
zengyawen 已提交
2767
createLinearGradient(x0: number, y0: number, x1: number, y1: number): void
Z
zengyawen 已提交
2768 2769 2770

创建一个线性渐变色。

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

L
lanyill 已提交
2773 2774
**参数:**

H
HelloCrease 已提交
2775 2776 2777 2778 2779 2780
| 参数   | 类型     | 必填   | 默认值  | 描述       |
| ---- | ------ | ---- | ---- | -------- |
| x0   | number | 是    | 0    | 起点的x轴坐标。 |
| y0   | number | 是    | 0    | 起点的y轴坐标。 |
| x1   | number | 是    | 0    | 终点的x轴坐标。 |
| y1   | number | 是    | 0    | 终点的y轴坐标。 |
Z
zengyawen 已提交
2781

L
lanyill 已提交
2782
**示例:**
Z
zengyawen 已提交
2783

H
geshi  
HelloCrease 已提交
2784 2785
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2786 2787 2788
  @Entry
  @Component
  struct CreateLinearGradient {
Y
yamila 已提交
2789 2790
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
2791
    
Z
zengyawen 已提交
2792 2793 2794 2795 2796 2797 2798 2799
    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 已提交
2800 2801 2802
            grad.addColorStop(0.0, '#ff0000')
            grad.addColorStop(0.5, '#ffffff')
            grad.addColorStop(1.0, '#00ff00')
Z
zengyawen 已提交
2803
            this.context.fillStyle = grad
L
lanyill 已提交
2804
            this.context.fillRect(0, 0, 400, 400)
Z
zengyawen 已提交
2805
          })
Z
zengyawen 已提交
2806
      }
Z
zengyawen 已提交
2807 2808
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2809
    }
Z
zengyawen 已提交
2810 2811
  }
  ```
Z
zengyawen 已提交
2812

Z
zengyawen 已提交
2813
  ![zh-cn_image_0000001194032466](figures/zh-cn_image_0000001194032466.png)
Z
zengyawen 已提交
2814 2815


Z
zengyawen 已提交
2816
### createRadialGradient
Z
zengyawen 已提交
2817

Z
zengyawen 已提交
2818
createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): void
Z
zengyawen 已提交
2819 2820 2821

创建一个径向渐变色。

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

L
lanyill 已提交
2824 2825
**参数:**

H
HelloCrease 已提交
2826 2827 2828 2829 2830 2831 2832 2833
| 参数   | 类型     | 必填   | 默认值  | 描述                |
| ---- | ------ | ---- | ---- | ----------------- |
| x0   | number | 是    | 0    | 起始圆的x轴坐标。         |
| y0   | number | 是    | 0    | 起始圆的y轴坐标。         |
| r0   | number | 是    | 0    | 起始圆的半径。必须是非负且有限的。 |
| x1   | number | 是    | 0    | 终点圆的x轴坐标。         |
| y1   | number | 是    | 0    | 终点圆的y轴坐标。         |
| r1   | number | 是    | 0    | 终点圆的半径。必须为非负且有限的。 |
Z
zengyawen 已提交
2834

L
lanyill 已提交
2835 2836
**示例:**

H
geshi  
HelloCrease 已提交
2837 2838
  ```ts
  // xxx.ets
Z
zengyawen 已提交
2839 2840 2841
  @Entry
  @Component
  struct CreateRadialGradient {
Y
yamila 已提交
2842 2843
    private settings: RenderingContextSettings = new RenderingContextSettings(true)
    private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
Z
zengyawen 已提交
2844
    
Z
zengyawen 已提交
2845 2846 2847 2848 2849 2850 2851 2852
    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 已提交
2853 2854 2855
            grad.addColorStop(0.0, '#ff0000')
            grad.addColorStop(0.5, '#ffffff')
            grad.addColorStop(1.0, '#00ff00')
Z
zengyawen 已提交
2856
            this.context.fillStyle = grad
L
lanyill 已提交
2857
            this.context.fillRect(0, 0, 440, 440)
Z
zengyawen 已提交
2858
          })
Z
zengyawen 已提交
2859
      }
Z
zengyawen 已提交
2860 2861
      .width('100%')
      .height('100%')
Z
zengyawen 已提交
2862
    }
Z
zengyawen 已提交
2863 2864
  }
  ```
Z
zengyawen 已提交
2865

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

2868
### createConicGradient<sup>10+</sup>
2869 2870 2871 2872 2873 2874 2875 2876 2877 2878

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

创建一个圆锥渐变色。

**参数:**

| 参数       | 类型   | 必填 | 默认值 | 描述                                                         |
| ---------- | ------ | ---- | ------ | ------------------------------------------------------------ |
| startAngle | number | 是   | 0      | 开始渐变的角度,以弧度为单位。角度测量从中心右侧水平开始,顺时针移动。 |
2879 2880
| x          | number | 是   | 0      | 圆锥渐变的中心x轴坐标。单位:vp                              |
| y          | number | 是   | 0      | 圆锥渐变的中心y轴坐标。单位:vp                              |
2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896

**示例:**

```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%')
2897
        .backgroundColor('#ffffff')
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913
        .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)