ts-drawing-components-polyline.md 3.0 KB
Newer Older
Z
zengyawen 已提交
1
# Polyline
Z
zengyawen 已提交
2

E
ester.zhou 已提交
3
The **\<Polyline>** component is used to draw a polyline.
Z
zengyawen 已提交
4

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


## Child Components
Z
zengyawen 已提交
11

E
ester.zhou 已提交
12
Not supported
Z
zengyawen 已提交
13 14


Z
zengyawen 已提交
15 16
## APIs

E
ester.zhou 已提交
17
Polyline(value?: {width?: string | number, height?: string | number})
Z
zengyawen 已提交
18 19

- Parameters
E
ester.zhou 已提交
20
  | Name| Type| Mandatory| Default Value| Description| 
Z
zengyawen 已提交
21
  | -------- | -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
22 23
  | width | string \| number | No| 0 | Width.| 
  | height | string \| number | No| 0 | Height.| 
Z
zengyawen 已提交
24 25 26 27


## Attributes

E
ester.zhou 已提交
28
In addition to the [universal attributes](ts-universal-attributes-size.md), the following attributes are supported.
Z
zengyawen 已提交
29

E
ester.zhou 已提交
30
| Name| Type| Default Value| Mandatory| Description| 
E
ester.zhou 已提交
31
| -------- | -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
32 33 34 35
| points | Array&lt;Point&gt; | [] | No| List of coordinates that the polyline passes through.| 
| fill | [ResourceColor](ts-types.md#resourcecolor) | Color.Black | No| Color of the fill area.|
| fillOpacity | number \| string \| [Resource](ts-types.md#resource)| 1 | No| Opacity of the fill area.|
| stroke | [ResourceColor](ts-types.md#resourcecolor) | Color.Black | No| Stroke color.|
E
ester.zhou 已提交
36 37 38 39 40
| 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.|
E
ester.zhou 已提交
41
| strokeOpacity | number \| string \| [Resource](ts-types.md#resource)| 1 | No| Stroke opacity.|
E
ester.zhou 已提交
42 43 44 45 46 47 48 49 50 51
| strokeWidth | Length | 1 | No| Stroke width.|
| antiAlias | boolean | true | No| Whether anti-aliasing is enabled.|

## Point

Describes the coordinates of a point.

| Name     | Type            | Description                                                        |
| --------- | -------------------- | ------------------------------------------------------------ |
| Point | [number, number] | Coordinates of a point. The first parameter is the x-coordinate, and the second parameter is the y-coordinate (relative coordinate).|
Z
zengyawen 已提交
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 69 70 71 72
@Entry
@Component
struct PolylineExample {
  build() {
    Column({ space: 5 }) {
      Flex({ justifyContent: FlexAlign.SpaceAround }) {
        // Draw a polyline in a 100 x 100 rectangle. The start point is (0, 0), the end point is (100, 100), and the passing point is (20,60).
        Polyline({ width: 100, height: 100 }).points([[0, 0], [20, 60], [100, 100]])
        // Draw a polyline in a 100 x 100 rectangle. The start point is (0, 0), the end point is (100, 100), and the passing point is (0,100).
        Polyline().width(100).height(100).points([[0, 0], [0, 100], [100, 100]])
      }.width('100%')
    }.margin({ top: 5 })
  }
}
```

E
ester.zhou 已提交
73
![en-us_image_0000001212218432](figures/en-us_image_0000001212218432.gif)