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

Z
zengyawen 已提交
3

E
ester.zhou 已提交
4
The **\<Line>** component is used to draw a straight line.
Z
zengyawen 已提交
5

E
ester.zhou 已提交
6 7 8
>  **NOTE**
>
>  This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
Z
zengyawen 已提交
9 10 11


## Required Permissions
Z
zengyawen 已提交
12 13 14

None

Z
zengyawen 已提交
15 16

## Child Components
Z
zengyawen 已提交
17

E
ester.zhou 已提交
18
Not supported
Z
zengyawen 已提交
19 20


Z
zengyawen 已提交
21 22
## APIs

E
ester.zhou 已提交
23
Line(options?: {width?: string | number, height?: string | number})
Z
zengyawen 已提交
24 25

- Parameters
E
ester.zhou 已提交
26
  | Name| Type| Mandatory| Default Value| Description|
Z
zengyawen 已提交
27
  | -------- | -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
28 29
  | width | string \| number | No| 0 | Width of the line. |
  | height | string \| number | No| 0 | Height of the line. |
Z
zengyawen 已提交
30 31 32 33


## Attributes

E
ester.zhou 已提交
34 35 36
In addition to the [universal attributes](ts-universal-attributes-size.md), the following attributes are supported.

| Name| Type| Default Value| Mandatory| Description|
Z
zengyawen 已提交
37
| -------- | -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50
| startPoint | Array | [0, 0] | Yes  | Coordinates (relative coordinates) of the start point of the line. |
| endPoint   | Array | [0, 0] | Yes  | Coordinates (relative coordinates) of the end point of the line. |
| fill | [ResourceColor](../../ui/ts-types.md) | Color.Black | No| Color of the fill area.|
| fillOpacity | number \| string \| [Resource](../../ui/ts-types.md#resource)| 1 | No| Opacity of the fill area.|
| stroke | [ResourceColor](../../ui/ts-types.md) | Color.Black | No| Stroke color.|
| strokeDashArray | Array&lt;Length&gt; | [] | No| Stroke dashes.|
| strokeDashOffset | number \| string | 0 | No| Offset of the start point for drawing the stroke.|
| strokeLineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle) | LineCapStyle.Butt | No| Cap style of the stroke.|
| strokeLineJoin | [LineJoinStyle](ts-appendix-enums.md#linejoinstyle) | LineJoinStyle.Miter | No| Join style of the stroke.|
| strokeMiterLimit | number \| string | 4 | No| Limit value when the sharp angle is drawn as a miter.|
| strokeOpacity | number \| string \| [Resource](../../ui/ts-types.md#resource)| 1 | No| Stroke opacity.|
| strokeWidth | Length | 1 | No| Stroke width.|
| antiAlias | boolean | true | No| Whether anti-aliasing is enabled.|
Z
zengyawen 已提交
51 52 53 54


## Example

Mr-YX's avatar
Mr-YX 已提交
55
```ts
E
ester.zhou 已提交
56
// xxx.ets
Z
zengyawen 已提交
57 58 59 60 61 62 63 64 65 66 67 68
@Entry
@Component
struct LineExample {
  build() {
    Column() {
      Line({ width: 50, height: 100 }).startPoint([0, 0]).endPoint([50, 100])
      Line().width(200).height(200).startPoint([50, 50]).endPoint([150, 150])
    }.margin({ top: 5 })
  }
}
```

E
ester.zhou 已提交
69
![en-us_image_0000001256858387](figures/en-us_image_0000001256858387.jpg)