ts-drawing-components-circle.md 2.2 KB
Newer Older
Z
zengyawen 已提交
1
# Circle
Z
zengyawen 已提交
2

E
ester.zhou 已提交
3
 The **\<Circle>** component is used to draw a circle.
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

Z
zengyawen 已提交
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
Circle(options?: {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 of the circle.|
  | height | string \| number | No| 0 | Height of the circle.|
Z
zengyawen 已提交
24 25 26

## Attributes

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

| Name| Type| Default Value| Mandatory| Description|
Z
zengyawen 已提交
30
| -------- | -------- | -------- | -------- | -------- |
E
ester.zhou 已提交
31 32 33 34 35 36 37 38 39 40 41
| fill | [ResourceColor](../../ui/ts-types.md) | Color.Black | No| Color of the fill area.|
| fillOpacity | number \| string \| [Resource](../../ui/ts-types.md#resource-type)| 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-type)| 1 | No| Stroke opacity.|
| strokeWidth | Length | 1 | No| Stroke width.|
| antiAlias | boolean | true | No| Whether anti-aliasing is enabled.|
Z
zengyawen 已提交
42 43 44 45


## Example

Mr-YX's avatar
Mr-YX 已提交
46
```ts
E
ester.zhou 已提交
47
// xxx.ets
Z
zengyawen 已提交
48 49 50 51 52 53 54 55 56 57 58 59 60 61
@Entry
@Component
struct CircleExample {
  build() {
    Flex({ justifyContent: FlexAlign.SpaceAround }) {
      // Draw a circle whose diameter is 150.
      Circle({ width: 150, height: 150 })
      // Draw a circle whose diameter is 150.
      Circle().width(150).height(150)
    }.width('100%').margin({ top: 5 })
  }
}
```

E
ester.zhou 已提交
62
![en-us_image_0000001256978353](figures/en-us_image_0000001256978353.png)