Circle

The <Circle> component is used to draw a circle.

NOTE

This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.

Child Components

Not supported

APIs

Circle(options?: {width?: string | number, height?: string | number})

Since API version 9, this API is supported in ArkTS widgets.

Parameters

Name Type Mandatory Description
width string | number No Width of the circle.
Default value: 0
height string | number No Height of the circle.
Default value: 0

Attributes

In addition to the universal attributes, the following attributes are supported.

Name Type Description
fill ResourceColor Color of the fill area.
Default value: Color.Black
Since API version 9, this API is supported in ArkTS widgets.
fillOpacity number | string | Resource Opacity of the fill area.
Default value: 1
Since API version 9, this API is supported in ArkTS widgets.
stroke ResourceColor Stroke color. If this attribute is not set, the component does not have any stroke.
Since API version 9, this API is supported in ArkTS widgets.
strokeDashArray Array<Length> Stroke dashes.
Default value: []
Since API version 9, this API is supported in ArkTS widgets.
strokeDashOffset number | string Offset of the start point for drawing the stroke.
Default value: 0
Since API version 9, this API is supported in ArkTS widgets.
strokeLineCap LineCapStyle Cap style of the stroke.
Default value: LineCapStyle.Butt
Since API version 9, this API is supported in ArkTS widgets.
strokeLineJoin LineJoinStyle Join style of the stroke.
Default value: LineJoinStyle.Miter
Since API version 9, this API is supported in ArkTS widgets.
NOTE
This attribute does not work for the <circle> component, which does not have corners.
strokeMiterLimit number | string Limit on the ratio of the miter length to the value of strokeWidth used to draw a miter join.
Default value: 4
Since API version 9, this API is supported in ArkTS widgets.
NOTE
This attribute does not take effect for the <Circle> component, because it does not have a miter join.
strokeOpacity number | string | Resource Stroke opacity.
Default value: 1
Since API version 9, this API is supported in ArkTS widgets.
NOTE
The value range is [0.0, 1.0]. If the set value is less than 0.0, 0.0 will be used. If the set value is greater than 1.0, 1.0 will be used.
strokeWidth Length Stroke width.
Default value: 1
Since API version 9, this API is supported in ArkTS widgets.
NOTE
The value cannot be a percentage.
antiAlias boolean Whether anti-aliasing is enabled.
Default value: true
Since API version 9, this API is supported in ArkTS widgets.

Example

// xxx.ets
@Entry
@Component
struct CircleExample {
  build() {
    Column({ space: 10 }) {
      // Draw a circle whose diameter is 150.
      Circle({ width: 150, height: 150 })
      // Draw a circle whose diameter is 150 and stroke color is red. (If the width and height values are different, the smaller value will be used as the diameter.)
      Circle()
        .width(150)
        .height(200)
        .fillOpacity(0)
        .strokeWidth(3)
        .stroke(Color.Red)
        .strokeDashArray([1, 2])
    }.width('100%')
  }
}

en-us_image_0000001219744191