• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Circle
2
3 用于绘制圆形的组件。
4
5>  **说明:**
6>
7>  该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9
10## 子组件
11
1213
14
15## 接口
16
17Circle(options?: {width?: string | number, height?: string | number})
18
19从API version 9开始,该接口支持在ArkTS卡片中使用。
20
21**参数:**
22
23| 参数名 | 参数类型 | 必填 | 参数描述 |
24| -------- | -------- | -------- | -------- |
25| width | string \| number | 否 | 宽度。<br>默认值:0<br/>**说明:**<br/>异常值按照默认值处理。 |
26| height | string \| number | 否 | 高度。<br>默认值:0<br/>**说明:**<br/>异常值按照默认值处理。 |
27
28## 属性
29
30除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:
31
32| 名称 | 类型 | 默认值 | 描述 |
33| -------- | -------- | -------- | -------- |
34| fill | [ResourceColor](ts-types.md#resourcecolor) | Color.Black | 设置填充区域颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>异常值按照默认值处理。 |
35| fillOpacity | number&nbsp;\|&nbsp;string&nbsp;\| [Resource](ts-types.md#resource)	 | 1 | 设置填充区域透明度。 <br/>取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0,其余异常值按1.0处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
36| stroke | [ResourceColor](ts-types.md#resourcecolor) | - | 设置边框颜色,不设置时,默认没有边框。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>异常值不会绘制边框。 |
37| strokeDashArray | Array&lt;any&gt; | [] | 设置边框间隙。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>异常值按照默认值处理。 |
38| strokeDashOffset | number&nbsp;\|&nbsp;string  | 0 | 边框绘制起点的偏移量。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>异常值按照默认值处理。 |
39| strokeLineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle) | LineCapStyle.Butt | 设置边框端点绘制样式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
40| strokeLineJoin | [LineJoinStyle](ts-appendix-enums.md#linejoinstyle) | LineJoinStyle.Miter |  设置边框拐角绘制样式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>Circle组件无法形成拐角,该属性设置无效。 |
41| strokeMiterLimit | number&nbsp;\|&nbsp;string | 4 | 设置斜接长度与边框宽度比值的极限值。<br>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>Circle组件无法设置尖角图形,该属性设置无效。 |
42| strokeOpacity | number&nbsp;\|&nbsp;string&nbsp;\| [Resource](ts-types.md#resource) | 1 | 设置边框透明度。<br>默认值:1<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>该属性的取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0,其余异常值按1.0处理 。 |
43| strokeWidth | [Length](ts-types.md#length) | 1 | 设置边框宽度。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>该属性若为string类型, 暂不支持百分比,百分比按照1px处理。 |
44| antiAlias | boolean | true | 是否开启抗锯齿效果。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
45
46
47
48## 示例
49
50```ts
51// xxx.ets
52@Entry
53@Component
54struct CircleExample {
55  build() {
56    Column({ space: 10 }) {
57      // 绘制一个直径为150的圆
58      Circle({ width: 150, height: 150 })
59      // 绘制一个直径为150、线条为红色虚线的圆环(宽高设置不一致时以短边为直径)
60      Circle()
61        .width(150)
62        .height(200)
63        .fillOpacity(0)
64        .strokeWidth(3)
65        .stroke(Color.Red)
66        .strokeDashArray([1, 2])
67    }.width('100%')
68  }
69}
70```
71
72![zh-cn_image_0000001219744191](figures/zh-cn_image_0000001219744191.png)
73