## DrawableContext
### DrawableContext 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
### DrawableContext 的属性值 @drawablecontext-values
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| :- | :- | :- | :- | :-: | :- |
| font | string | 是 | 10px | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置字体大小 |
| fillStyle | [string.ColorString](/uts/data-type.md#ide-string) | 是 | #000 (黑色) | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置填充颜色 |
| lineCap | string | 是 | butt | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 指定如何绘制每一条线条末端的属性,可选值:`butt`线段末端以方形结束;`round`线段末端以圆形结束;`square`线段末端以方形结束,但是会增加一个一半宽度的矩形区域。 |
| lineDashOffset | number | 是 | | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置虚线偏移量 |
| lineJoin | string | 是 | miter | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性,可选值:`bevel`斜角;`round`圆角;`miter`尖角。 |
| lineWidth | number | 是 | 1px | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置线条的宽度 |
| strokeStyle | [string.ColorString](/uts/data-type.md#ide-string) | 是 | #000 (黑色) | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置边框的颜色 |
| textAlign | string | 是 | left | Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x | 设置文本的对齐方式,可取值:`left`左对齐;`center`居中对齐;`right`右对齐。 |
### DrawableContext 的方法 @drawablecontext-methods
#### beginPath(): void @beginpath
创建一个新的空路径
##### beginPath 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
#### arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean): void @arc
绘制一段弧线
##### arc 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| :- | :- | :- | :- | :-: | :- |
| x | number | 是 | | Web: x; 微信小程序: x; 支付宝小程序: x | 圆心的X轴坐标 |
| y | number | 是 | | Web: x; 微信小程序: x; 支付宝小程序: x | 圆心的Y轴坐标 |
| radius | number | 是 | | Web: x; 微信小程序: x; 支付宝小程序: x | 圆弧的半径 |
| startAngle | number | 是 | | Web: x; 微信小程序: x; 支付宝小程序: x | 圆弧的起始点,x 轴方向开始计算,单位为弧度 |
| endAngle | number | 是 | | Web: x; 微信小程序: x; 支付宝小程序: x | 圆弧的终点,单位为弧度 |
| anticlockwise | boolean | 否 | true | Web: x; 微信小程序: x; 支付宝小程序: x | 圆弧绘制方向,true:逆时针绘制,false:顺时针绘制。 |
#### moveTo(x: number, y: number): void @moveto
将一个新的路径的起始点移动到 (x,y) 坐标
##### moveTo 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 点的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 点的Y轴坐标 |
#### rect(x: number, y: number, width: number, height: number): void @rect
创建一个矩形路径
##### rect 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形起点的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形起点的Y轴坐标 |
| width | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形宽度 |
| height | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形高度 |
#### lineTo(x: number, y: number): void @lineto
将路径的最后一个点连接到 (x,y) 坐标
##### lineTo 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 线终点的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 线终点的Y轴坐标 |
#### closePath(): void @closepath
闭合路径,将最后一个点与起点连接起来。如果图形已经封闭,或者只有一个点,那么此方法不会产生任何效果。
##### closePath 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
#### stroke(): void @stroke
绘制当前或已经存在的路径的边框。
##### stroke 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
#### strokeRect(x: number, y: number, width: number, height: number): void @strokerect
绘制一个矩形框
##### strokeRect 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形起点的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形起点的Y轴坐标 |
| width | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形宽度 |
| height | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形高度 |
#### strokeText(text: string, x: number, y: number): void @stroketext
绘制空心字符
##### strokeText 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| text | string | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 要绘制的字符 |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 字符开始绘制的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 字符开始绘制的Y轴坐标 |
#### fill(fillRule?: string): void @fill
填充当前或已存在的路径
##### fill 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| :- | :- | :- | :- | :-: | :- |
| fillRule | string | 否 | nonzero | Web: x; 微信小程序: x; 支付宝小程序: x | 填充规则。可取值:`nonzero`非零环绕规则;`evenodd`奇偶环绕规则。 |
#### fillRect(x: number, y: number, width: number, height: number): void @fillrect
绘制一个实心矩形
##### fillRect 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形起点的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形起点的Y轴坐标 |
| width | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形宽度 |
| height | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 矩形高度 |
#### fillText(text: string, x: number, y: number): void @filltext
绘制实心字符
##### fillText 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| text | string | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 要绘制的字符 |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 字符开始绘制的X轴坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 字符开始绘制的Y轴坐标 |
#### reset(): void @reset
清空绘制数据
##### reset 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
#### update(): void @update
将所有绘制内容更新到画布上
##### update 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
#### setLineDash(segments: Array\): void @setlinedash
设置虚线样式
##### setLineDash 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| segments | Array<number> | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 一组描述交替绘制线段和间距长度的数字。 |
#### bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): void @beziercurveto
创建三次方贝塞尔曲线路径
##### bezierCurveTo 兼容性
Web: x; 微信小程序: x; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): x; iOS(VDOM): 4.11; iOS(Vapor): x; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): x
##### 参数
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
| :- | :- | :- | :-: | :- |
| cp1x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 第一个贝塞尔控制点的 x 坐标 |
| cp1y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 第一个贝塞尔控制点的 y 坐标 |
| cp2x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 第二个贝塞尔控制点的 x 坐标 |
| cp2y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 第二个贝塞尔控制点的 y 坐标 |
| x | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 结束点的 x 坐标 |
| y | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x | 结束点的 y 坐标 |
### 示例
示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/element-draw/element-draw.uvue),与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/element-draw/element-draw.uvue)
>
> 该 API 不支持 Web,请运行 hello uni-app x 到 App 平台体验
```uvue
```
## Bug & Tips@tips
+ 同时使用`border-radius`和`DrawableContext`,可能会出现`DrawableContext`绘制内容超出border区域的情况。
+ 如果绘制过多内容或者绘制复杂图形时,建议设置`android-layer-type`为`hardware`,提高绘制效率。具体可参考[`android-layer-type`文档](../component/common.md#attribute-android)
+ iOS 平台绘制大量文字时相较于绘制其他内容性能会显著下降,可使用`text`组件代替。
+ uni-app-x harmony 暂不支持功能:line相关效果/镂空字体