ts-drawing-components-line.md 7.3 KB
Newer Older
Z
zengyawen 已提交
1 2
# Line

3 4
直线绘制组件。

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

Z
zengyawen 已提交
9
## 子组件
Z
zengyawen 已提交
10 11 12



Z
zengyawen 已提交
13 14 15

## 接口

L
fix doc  
luoying_ace_admin 已提交
16
Line(value?: {width?: string | number, height?: string | number})
Z
zengyawen 已提交
17

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

20 21
**参数:**

T
tianyu 已提交
22
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
23
| -------- | -------- | -------- | -------- | -------- |
T
tianyu 已提交
24 25
| width | string \| number | 否 | 0 | 宽度。 |
| height | string \| number | 否 | 0 | 高度。 |
Z
zengyawen 已提交
26 27 28 29


## 属性

L
luoying_ace_admin 已提交
30 31
除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:

Y
yamila 已提交
32 33
| 名称 | 类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
34 35 36 37 38 39 40 41
| startPoint | Array&lt;Length&gt; | [0,&nbsp;0] | 直线起点坐标点(相对坐标),单位vp。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| endPoint   | Array&lt;Length&gt; | [0,&nbsp;0] | 直线终点坐标点(相对坐标),单位vp。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| fill | [ResourceColor](ts-types.md#resourcecolor) | Color.Black | 设置填充区域颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>Line组件无法形成闭合区域,该属性设置无效。 |
| fillOpacity | number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型) | 1 | 设置填充区域透明度。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>Line组件无法形成闭合区域,该属性设置无效。 |
| stroke | [ResourceColor](ts-types.md) | - | 设置边框颜色,不设置时,默认没有边框线条。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| strokeDashArray | Array&lt;Length&gt; | [] | 设置线条间隙。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| strokeDashOffset | number&nbsp;\|&nbsp;string | 0 | 线条绘制起点的偏移量。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| strokeLineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle) | LineCapStyle.Butt | 设置线条端点绘制样式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
42
| strokeLineJoin | [LineJoinStyle](ts-appendix-enums.md#linejoinstyle) | LineJoinStyle.Miter | 设置线条拐角绘制样式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>Line组件无法形成拐角,该属性设置无效。 |
43 44
| strokeMiterLimit | number&nbsp;\|&nbsp;string | 4 | 设置锐角绘制成斜角的极限值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>Line组件无法设置锐角图形,该属性设置无效。 |
| strokeOpacity | number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型) | 1 | 设置线条透明度。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>该属性的取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0。 |
45
| strokeWidth | Length | 1 | 设置线条宽度。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 <br/>**说明:**<br/>该属性若为string类型, 暂不支持百分比。|
46
| antiAlias | boolean | true | 是否开启抗锯齿效果。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Z
zengyawen 已提交
47 48

## 示例
Z
zengyawen 已提交
49

T
tianyu 已提交
50 51
### 示例1

H
geshi  
HelloCrease 已提交
52 53
```ts
// xxx.ets
Z
zengyawen 已提交
54 55 56 57
@Entry
@Component
struct LineExample {
  build() {
58 59 60
    Column({ space: 10 }) {
      // 线条绘制的起止点坐标均是相对于Line组件本身绘制区域的坐标
      Line()
61 62
        .width(200)
        .height(150)
63 64
        .startPoint([0, 0])
        .endPoint([50, 100])
65
        .stroke(Color.Black)
66 67 68
        .backgroundColor('#F5F5F5')
      Line()
        .width(200)
69
        .height(150)
70 71 72 73 74 75
        .startPoint([50, 50])
        .endPoint([150, 150])
        .strokeWidth(5)
        .stroke(Color.Orange)
        .strokeOpacity(0.5)
        .backgroundColor('#F5F5F5')
76 77 78 79
      // strokeDashOffset用于定义关联虚线strokeDashArray数组渲染时的偏移
      Line()
        .width(200)
        .height(150)
80 81
        .startPoint([0, 0])
        .endPoint([100, 100])
82
        .stroke(Color.Black)
83
        .strokeWidth(3)
T
tianyu 已提交
84
        .strokeDashArray([10, 3])
85
        .strokeDashOffset(5)
T
tianyu 已提交
86
        .backgroundColor('#F5F5F5')
87 88 89 90
      // 当坐标点设置的值超出Line组件的宽高范围时,线条会画出组件绘制区域
      Line()
        .width(50)
        .height(50)
T
tianyu 已提交
91 92
        .startPoint([0, 0])
        .endPoint([100, 100])
93
        .stroke(Color.Black)
T
tianyu 已提交
94 95
        .strokeWidth(3)
        .strokeDashArray([10, 3])
96 97
        .backgroundColor('#F5F5F5')
    }
Z
zengyawen 已提交
98 99 100 101
  }
}
```

T
tianyu 已提交
102
![zh-cn_image_0000001219982725](figures/zh-cn_image_0000001219982725.png)
T
tianyu 已提交
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

### 示例2

```ts
// xxx.ets
@Entry
@Component
struct LineExample1 {
  build() {
    Row({ space: 10 }) {
      // 当LineCapStyle值为Butt时
      Line()
        .width(100)
        .height(200)
        .startPoint([50, 50])
        .endPoint([50, 200])
119
        .stroke(Color.Black)
T
tianyu 已提交
120 121 122 123 124 125 126 127 128
        .strokeWidth(20)
        .strokeLineCap(LineCapStyle.Butt)
        .backgroundColor('#F5F5F5').margin(10)
      // 当LineCapStyle值为Round时
      Line()
        .width(100)
        .height(200)
        .startPoint([50, 50])
        .endPoint([50, 200])
129
        .stroke(Color.Black)
T
tianyu 已提交
130 131 132 133 134 135 136 137 138
        .strokeWidth(20)
        .strokeLineCap(LineCapStyle.Round)
        .backgroundColor('#F5F5F5')
      // 当LineCapStyle值为Square时
      Line()
        .width(100)
        .height(200)
        .startPoint([50, 50])
        .endPoint([50, 200])
139
        .stroke(Color.Black)
T
tianyu 已提交
140 141 142 143 144 145 146 147
        .strokeWidth(20)
        .strokeLineCap(LineCapStyle.Square)
        .backgroundColor('#F5F5F5')
    }
  }
}
```

Y
yamila 已提交
148 149 150 151 152 153 154 155 156 157 158 159
![zh-cn_image1_0000001219982725](figures/zh-cn_image1_0000001219982725.png)

### 示例3

```ts
// xxx.ets
@Entry
@Component
struct LineExample {
  build() {
    Column() {
      Line()
160 161
        .width(300)
        .height(30)
Y
yamila 已提交
162 163
        .startPoint([50, 30])
        .endPoint([300, 30])
164
        .stroke(Color.Black)
Y
yamila 已提交
165 166 167
        .strokeWidth(10)
      // 设置strokeDashArray的数组间隔为 50
      Line()
168 169
        .width(300)
        .height(30)
Y
yamila 已提交
170 171
        .startPoint([50, 20])
        .endPoint([300, 20])
172
        .stroke(Color.Black)
Y
yamila 已提交
173 174 175 176
        .strokeWidth(10)
        .strokeDashArray([50])
      // 设置strokeDashArray的数组间隔为 50, 10
      Line()
177 178
        .width(300)
        .height(30)
Y
yamila 已提交
179 180
        .startPoint([50, 20])
        .endPoint([300, 20])
181
        .stroke(Color.Black)
Y
yamila 已提交
182 183 184 185
        .strokeWidth(10)
        .strokeDashArray([50, 10])
      // 设置strokeDashArray的数组间隔为 50, 10, 20
      Line()
186 187
        .width(300)
        .height(30)
Y
yamila 已提交
188 189
        .startPoint([50, 20])
        .endPoint([300, 20])
190
        .stroke(Color.Black)
Y
yamila 已提交
191 192 193 194
        .strokeWidth(10)
        .strokeDashArray([50, 10, 20])
      // 设置strokeDashArray的数组间隔为 50, 10, 20, 30
      Line()
195 196
        .width(300)
        .height(30)
Y
yamila 已提交
197 198
        .startPoint([50, 20])
        .endPoint([300, 20])
199
        .stroke(Color.Black)
Y
yamila 已提交
200 201 202 203 204 205 206 207
        .strokeWidth(10)
        .strokeDashArray([50, 10, 20, 30])

    }
  }
}
```

208
![zh-cn_image2_0000001219982725](figures/zh-cn_image2_0000001219982725.PNG)