harmony 鸿蒙Circle

  • 2025-06-12
  • 浏览 (3)

Circle

用于绘制圆形的组件。

说明:

该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

接口

Circle(value?: CircleOptions)

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value CircleOptions 设置圆形尺寸

CircleOptions对象说明

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
width Length 宽度,取值范围≥0。
默认值:0
默认单位:vp
异常值按照默认值处理。
height Length 高度,取值范围≥0。
默认值:0
默认单位:vp
异常值按照默认值处理。

属性

除支持通用属性外,还支持以下属性:

fill

fill(value: ResourceColor)

设置填充区域的颜色,支持attributeModifier动态设置属性方法,异常值按照默认值处理。与通用属性foregroundColor同时设置时,后设置的属性生效。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor 填充区域颜色。
默认值:Color.Black

fillOpacity

fillOpacity(value: number|string|Resource)

设置填充区域透明度,支持attributeModifier动态设置属性方法。取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0,其余异常值按1.0处理。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number | string | Resource 填充区域透明度。
默认值:1

stroke

stroke(value: ResourceColor)

设置边框颜色,支持attributeModifier动态设置属性方法,不设置时,默认没有边框。异常值不会绘制边框。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor 边框颜色。

strokeDashArray

strokeDashArray(value: Array<any>)

设置边框间隙,支持attributeModifier动态设置属性方法。取值范围≥0,异常值按照默认值处理。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Array<any> 边框间隙。
默认值:[]
默认单位:vp

strokeDashOffset

strokeDashOffset(value: number|string)

设置边框绘制起点的偏移量,支持attributeModifier动态设置属性方法。异常值按照默认值处理。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number | string 边框绘制起点的偏移量。
默认值:0
默认单位:vp

strokeLineCap

strokeLineCap(value: LineCapStyle)

设置边框端点绘制样式,支持attributeModifier动态设置属性方法。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value LineCapStyle 边框端点绘制样式。
默认值:LineCapStyle.Butt

strokeLineJoin

strokeLineJoin(value: LineJoinStyle)

设置边框拐角绘制样式,支持attributeModifier动态设置属性方法。Circle组件无法形成拐角,该属性设置无效。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value LineJoinStyle 边框拐角绘制样式。
默认值:LineJoinStyle.Miter

strokeMiterLimit

strokeMiterLimit(value: number|string)

设置斜接长度与边框宽度比值的极限值,支持attributeModifier动态设置属性方法。Circle组件无法设置尖角图形,该属性设置无效。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number | string 斜接长度与边框宽度比值的极限值。
默认值:4

strokeOpacity

strokeOpacity(value: number|string|Resource)

设置边框透明度,支持attributeModifier动态设置属性方法。该属性的取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0,其余异常值按1.0处理。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number | string | Resource 边框透明度。
默认值:1

strokeWidth

strokeWidth(value: Length)

设置边框宽度,支持attributeModifier动态设置属性方法。该属性若为string类型,暂不支持百分比,百分比按照1px处理。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length 边框宽度,取值范围≥0。
默认值:1
默认单位:vp
异常值按照默认值处理。

antiAlias

antiAlias(value: boolean)

设置是否开启抗锯齿效果,支持attributeModifier动态设置属性方法。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value boolean 是否开启抗锯齿效果。
-true:开启抗锯齿。
-false:关闭抗锯齿。
默认值:true

示例

示例1(组件属性绘制)

通过fillOpacity、stroke、strokeDashArray属性可分别设置圆的透明度、边框颜色和边框间隙样式。

// xxx.ets
@Entry
@Component
struct CircleExample {
  build() {
    Column({ space: 10 }) {
      // 绘制一个直径为150的圆
      Circle({ width: 150, height: 150 })
      // 绘制一个直径为150、线条为红色虚线的圆环(宽高设置不一致时以短边为直径)
      Circle()
        .width(150)
        .height(200)
        .fillOpacity(0)
        .strokeWidth(3)
        .stroke(Color.Red)
        .strokeDashArray([1, 2])
    }.width('100%')
  }
}

zh-cn_image_0000001219744191

示例2(宽和高使用不同参数类型绘制圆)

width、height属性分别使用不同的长度类型绘制圆。

// xxx.ets
@Entry
@Component
struct CircleTypeExample {
  build() {
    Column({ space: 10 }) {
      // 绘制一个直径为50的圆
      Circle({ width: '50', height: '50' }) // 使用string类型
      // 绘制一个直径为100的圆
      Circle({ width: 100, height: 100 }) // 使用number类型
      // 绘制一个直径为150的圆
      Circle({ width: $r('app.string.CircleWidth'), height: $r('app.string.CircleHeight') }) // 使用Resource类型,需用户自定义
    }.width('100%')
  }
}

circleDemo2

示例3(使用attributeModifier动态设置Circle组件的属性)

以下示例展示了如何使用attributeModifier动态设置Circle组件的fill、fillOpacity、stroke、strokeDashArray、strokeDashOffset、strokeLineCap、strokeOpacity、strokeWidth和antiAlias属性。

// xxx.ets
class MyCircleModifier implements AttributeModifier<CircleAttribute> {
  applyNormalAttribute(instance: CircleAttribute): void {
    // 填充颜色#707070,填充透明度0.5,边框颜色#2787D9,边框间隙[20],向左偏移15,线条两端样式为半圆,边框透明度0.5,边框宽度10,抗锯齿开启
    instance.fill("#707070")
    instance.fillOpacity(0.5)
    instance.stroke("#2787D9")
    instance.strokeDashArray([20])
    instance.strokeDashOffset("15")
    instance.strokeLineCap(LineCapStyle.Round)
    instance.strokeOpacity(0.5)
    instance.strokeWidth(10)
    instance.antiAlias(true)
  }
}

@Entry
@Component
struct CircleModifierDemo {
  @State modifier: MyCircleModifier = new MyCircleModifier()

  build() {
    Column() {
      Circle({ width: 150, height: 150 })
        .attributeModifier(this.modifier)
        .offset({ x: 20, y: 20 })
    }
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙图像AI分析错误码

harmony 鸿蒙ArcButton

harmony 鸿蒙ArcSlider

harmony 鸿蒙Chip

harmony 鸿蒙ChipGroup

harmony 鸿蒙ComposeListItem

harmony 鸿蒙ComposeTitleBar

harmony 鸿蒙advanced.Counter

harmony 鸿蒙弹出框 (Dialog)

harmony 鸿蒙DialogV2

0  赞