目录

图形绘制通用属性

图形绘制组件的通用属性。

本模块首批接口从API版本7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

fill

fill(value: ResourceColor): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value ResourceColor 是

填充区域颜色。

默认值:Color.Black

异常值undefined、null、NaN和Infinity按照默认值处理。

返回值:

类型 说明
T 返回当前组件。

fillOpacity

fillOpacity(value: number | string | Resource): T

设置填充区域透明度,支持attributeModifier动态设置属性方法。

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value number | string | Resource 是

填充区域透明度。

说明:

number格式取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0,其余异常值按1.0处理。

string格式支持number格式取值的字符串形式,取值范围与number格式相同。

Resource格式支持系统资源或者应用资源中的字符串,取值范围和number格式相同。

异常值NaN按0.0处理,undefined、null和Infinity按1.0处理。

默认值:1.0

返回值:

类型 说明
T 返回当前组件。

stroke

stroke(value: ResourceColor): T

设置边框颜色,支持attributeModifier动态设置属性方法,不设置时,默认边框透明度为0,即无边框。

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value ResourceColor 是

边框颜色。

默认值:Color.Transparent

异常值undefined和null按照默认值处理,NaN和Infinity按照Color.Black处理。

返回值:

类型 说明
T 返回当前组件。

strokeDashArray

strokeDashArray(value: Array<any>): T

设置边框的虚线长度和虚线间隙长度,支持attributeModifier动态设置属性方法。取值范围≥0。异常值将按默认值处理。

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value Array<any> 是

定义Rect边框的虚线模式的数组,数组元素交替表示线段长度和间隙长度。

默认值:[](空数组)

默认单位:vp

异常值undefined和null按照默认值处理。

说明:

空数组:实线

偶数多元素数组:数组元素按顺序循环,如[a, b, c, d]表示线段长度a->间隙长度b->线段长度c->间隙长度d->线段长度a->...

奇数多元素数组:重复一次该数组元素,按偶数多元素数组的规则顺序循环,如[a, b, c]等效于[a, b, c, a, b, c],表示线段长度a->间隙长度b->线段长度c->间隙长度a->线段长度b->间隙长度c->线段长度a->...

返回值:

类型 说明
T 返回当前组件。

strokeDashOffset

strokeDashOffset(value: number | string): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value number | string 是

边框绘制起点的偏移量。

默认值:0

默认单位:vp

异常值undefined和null按照默认值处理,NaN和Infinity会导致strokeDashArray失效。

返回值:

类型 说明
T 返回当前组件。

strokeLineCap

strokeLineCap(value: LineCapStyle): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value LineCapStyle 是

边框端点绘制样式。

默认值:LineCapStyle.Butt

异常值undefined、null、NaN和Infinity按照默认值处理。

返回值:

类型 说明
T 返回当前组件。

strokeLineJoin

strokeLineJoin(value: LineJoinStyle): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value LineJoinStyle 是

边框拐角绘制样式。

默认值:LineJoinStyle.Miter

异常值undefined、null、NaN和Infinity按照默认值处理。

返回值:

类型 说明
T 返回当前组件。

strokeMiterLimit

strokeMiterLimit(value: number | string): T

设置斜接长度与边框宽度比值的极限值,支持attributeModifier动态设置属性方法。斜接长度表示外边框外边交点到内边交点的距离,边框宽度即strokeWidth属性的值。该属性取值需在strokeLineJoin属性取值LineJoinStyle.Miter时生效。

该属性的合法值范围应当大于等于1.0,当取值范围在[0,1)时按1.0处理,其余异常值按默认值处理。

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value number | string 是

斜接长度与边框宽度比值的极限值。

默认值:4

异常值undefined、null和NaN按照默认值处理,Infinity会导致stroke失效。

返回值:

类型 说明
T 返回当前组件。

strokeOpacity

strokeOpacity(value: number | string | Resource): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value number | string | Resource 是

边框透明度。

默认值:stroke接口设置的透明度。

异常值NaN按0.0处理,undefined、null和Infinity按1.0处理。

返回值:

类型 说明
T 返回当前组件。

strokeWidth

strokeWidth(value: Length): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value Length 是

边框宽度,取值范围≥0。

默认值:1

默认单位:vp

异常值undefined、null和NaN按照默认值处理,Infinity按0处理。

返回值:

类型 说明
T 返回当前组件。

antiAlias

antiAlias(value: boolean): T

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

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

元服务API: 从API版本11开始,该接口支持在元服务中使用。

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

参数:

参数名 类型 必填 说明
value boolean 是

是否开启抗锯齿效果。

true:开启抗锯齿;false:关闭抗锯齿。

默认值:true

异常值undefined和null按照false处理。

返回值:

类型 说明
T 返回当前组件。