# 基础类型定义

> phone 12+ | 2in1 13+ | tablet 12+ | tv 19+ | wearable 18+

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

## Resource

type Resource = import('../api/global/resource').Resource

资源引用类型，用于设置组件属性的值。各类资源文件，需要放入特定子目录中存储管理，资源目录的示例请参考[资源分类](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/resource-categories-and-access#资源分类)。

|类型|说明|
|:-----------------------------------------------------------------------------------------------------------------------------------------|:------|
|import('../api/global/resource').[Resource](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-resource#resource-1)|资源引用类型。|

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

可以通过$r或者$rawfile创建Resource类型对象，不可以修改Resource中的各属性的值。

* $r('belonging.type.name')

  belonging：系统资源或者应用资源，相应的取值为'sys'和'app'；

  type：资源类型，支持'boolean'、'color'、'float'、'intarray'、'integer'、'pattern'、'plural'、'strarray'、'string'、'media'；

  name：资源名称，在资源定义时确定。
* $rawfile('filename')

  filename：工程中resources/rawfile目录下的文件名称。

> 说明
>
> * 引用资源类型时，需确保资源类型对象内的数据类型与当前以资源类型作为参数的属性方法本身的类型一致。例如某个属性方法支持设置string | Resource，那么在使用Resource引用类型时，其数据类型也应当为string。
>
> * 引用资源类型时，需确保资源类型对象用法为当前支持的用法，否则当前以资源类型作为参数的属性效果将和不设置该属性相同。
>
> * $rawfile不支持通过[预览器](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-previewer-arkts-js)预览。

## Length

type Length = string | number | Resource

长度类型，用于描述尺寸单位。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|string|需要显式指定[像素单位](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-pixel-units)，如'10px'，也可设置百分比字符串，如'100%'。 **说明：** 不指定像素单位时，默认单位vp，如'10'，等同于10。|
|number|默认单位vp。|
|[Resource](#resource)|资源引用类型，引入系统资源或者应用资源中的尺寸。|

## LengthMetricsUnit^12+^

type LengthMetricsUnit = import('../api/arkui/Graphics').LengthMetricsUnit

定义长度属性单位。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:------|
|import('../api/arkui/Graphics').[LengthMetricsUnit](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetricsunit12)|长度属性单位。|

## LengthMetrics^12+^

type LengthMetrics = import('../api/arkui/Graphics').LengthMetrics

定义长度属性。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:----|
|import('../api/arkui/Graphics').[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|长度属性。|

## ColorMetrics^12+^

declare type ColorMetrics = import('../api/arkui/Graphics').ColorMetrics

定义混合颜色。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:------------------------------------------------------------------------------------------------------------------------------------------------------|:----|
|import('../api/arkui/Graphics').[ColorMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#colormetrics12)|混合颜色。|

## ResourceStr

type ResourceStr = string | Resource

字符串类型，用于描述字符串入参可以使用的类型。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:--------------------|:------------------------|
|string|字符串类型。|
|[Resource](#resource)|资源引用类型，引入系统资源或者应用资源中的字符串。|

## Padding

type Padding = { top?: Length; right?: Length; bottom?: Length; left?: Length; }

内边距类型，用于描述组件不同方向的内边距。

引入该对象时，至少传入一个参数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:-----|:----------------|:-|:-------------------|
|top|[Length](#length)|否|上内边距，组件内元素距组件顶部的尺寸。|
|right|[Length](#length)|否|右内边距，组件内元素距组件右边界的尺寸。|
|bottom|[Length](#length)|否|下内边距，组件内元素距组件底部的尺寸。|
|left|[Length](#length)|否|左内边距，组件内元素距组件左边界的尺寸。|

## LocalizedPadding^12+^

内边距类型，用于描述组件不同方向的内边距。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:-----------------------------------------------------------------------------------------------------------------------------|:-|:-|:-----------------------------------------------------|
|top|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|上内边距，组件内元素距组件顶部的尺寸。|
|end|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|右内边距，组件内元素距组件右边界的尺寸。 从右至左显示语言模式下为 左内边距，组件内元素距组件左边界的尺寸。|
|bottom|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|下内边距，组件内元素距组件底部的尺寸。|
|start|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|左内边距，组件内元素距组件左边界的尺寸。 从右至左显示语言模式下为 右内边距，组件内元素距组件右边界的尺寸。|

## Margin

type Margin = Padding

外边距类型，用于描述组件不同方向的外边距。

引入该对象时，至少传入一个参数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:------------------|:--------------------------------|
|[Padding](#padding)|外边距类型，用于描述组件不同方向的外边距，其类型与内边距类型一致。|

## LocalizedMargin^12+^

type LocalizedMargin = LocalizedPadding

外边距类型，用于描述组件不同方向的外边距。

引入该对象时，至少传入一个参数。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:--------------------------------------|:--------------------------------|
|[LocalizedPadding](#localizedpadding12)|外边距类型，用于描述组件不同方向的外边距，其类型与内边距类型一致。|

## EdgeWidths^9+^

type EdgeWidths = { top?: Length; right?: Length; bottom?: Length; left?: Length; }

边框宽度类型，用于描述组件边框不同方向的宽度。

引入该对象时，至少传入一个参数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:-----|:----------------|:-|:-------|
|top|[Length](#length)|否|组件上边框宽度。|
|right|[Length](#length)|否|组件右边框宽度。|
|bottom|[Length](#length)|否|组件下边框宽度。|
|left|[Length](#length)|否|组件左边框宽度。|

## EdgeWidth^10+^

type EdgeWidth = EdgeWidths

边框宽度类型，用于描述组件边框不同方向的宽度。

引入该对象时，至少传入一个参数。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:-------------------------|:-----------|
|[EdgeWidths](#edgewidths9)|组件边框不同方向的宽度。|

## LocalizedEdgeWidths^12+^

边框宽度类型，用于描述组件边框不同方向的宽度。

引入该对象时，至少传入一个参数。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:-----------------------------------------------------------------------------------------------------------------------------|:-|:-|:----------------------------|
|top|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件上边框宽度。|
|end|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件右边框宽度。 从右至左显示语言模式下为组件左边框宽度。|
|bottom|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件下边框宽度。|
|start|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件左边框宽度。 从右至左显示语言模式下为组件右边框宽度。|

## BorderRadiuses^9+^

type BorderRadiuses = { topLeft?: Length; topRight?: Length; bottomLeft?: Length; bottomRight?: Length; }

圆角类型，用于描述组件边框圆角半径。

引用该对象时，至少传入一个参数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:----------|:----------------|:-|:---------|
|topLeft|[Length](#length)|否|组件左上角圆角半径。|
|topRight|[Length](#length)|否|组件右上角圆角半径。|
|bottomLeft|[Length](#length)|否|组件左下角圆角半径。|
|bottomRight|[Length](#length)|否|组件右下角圆角半径。|

## LocalizedBorderRadiuses^12+^

圆角类型，用于描述组件边框圆角半径。

引用该对象时，至少传入一个参数。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------|:-|:-|:--------------------------------|
|topStart|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件左上角圆角半径。 从右至左显示语言模式下为组件右上角圆角半径。|
|topEnd|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件右上角圆角半径。 从右至左显示语言模式下为组件左上角圆角半径。|
|bottomStart|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件左下角圆角半径。 从右至左显示语言模式下为组件右下角圆角半径。|
|bottomEnd|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)^12+^|否|是|组件右下角圆角半径。 从右至左显示语言模式下为组件左下角圆角半径。|

## EdgeColors^9+^

type EdgeColors = { top?: ResourceColor; right?: ResourceColor; bottom?: ResourceColor; left?: ResourceColor; }

边框颜色，用于描述组件边框四条边的颜色。

引入该对象时，至少传入一个参数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:-----|:------------------------------|:-|:-------|
|top|[ResourceColor](#resourcecolor)|否|组件上边框颜色。|
|right|[ResourceColor](#resourcecolor)|否|组件右边框颜色。|
|bottom|[ResourceColor](#resourcecolor)|否|组件下边框颜色。|
|left|[ResourceColor](#resourcecolor)|否|组件左边框颜色。|

## LocalizedEdgeColors^12+^

边框颜色，用于描述组件边框四条边的颜色。

引入该对象时，至少传入一个参数。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:------------------------------|:-|:-|:----------------------------|
|top|[ResourceColor](#resourcecolor)|否|是|组件上边框颜色。|
|end|[ResourceColor](#resourcecolor)|否|是|组件右边框颜色。 从右至左显示语言模式下为组件左边框颜色。|
|bottom|[ResourceColor](#resourcecolor)|否|是|组件下边框颜色。|
|start|[ResourceColor](#resourcecolor)|否|是|组件左边框颜色。 从右至左显示语言模式下为组件右边框颜色。|

## EdgeStyles^9+^

type EdgeStyles = { top?: BorderStyle; right?: BorderStyle; bottom?: BorderStyle; left?: BorderStyle; }

边框样式，用于描述组件边框四条边的样式。

引入该对象时，至少传入一个参数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:-----|:-------------------------------------------------------------------------------------------------------------|:-|:-------|
|top|[BorderStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#borderstyle)|否|组件上边框样式。|
|right|[BorderStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#borderstyle)|否|组件右边框样式。|
|bottom|[BorderStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#borderstyle)|否|组件下边框样式。|
|left|[BorderStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#borderstyle)|否|组件左边框样式。|

## Offset

type Offset = { dx: Length; dy: Length; }

相对布局完成位置坐标偏移量。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:-|:----------------|:-|:-------|
|dx|[Length](#length)|是|水平方向偏移量。|
|dy|[Length](#length)|是|竖直方向偏移量。|

## ResourceColor

type ResourceColor = [Color](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#color) | number | string | [Resource](#resource)

颜色类型，用于描述资源颜色类型。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:-------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------|
|[Color](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#color)|颜色枚举值。|
|number|HEX格式颜色，支持rgb或者argb。示例：0xffffff，0xffff0000。number无法识别传入位数，格式选择依据值的大小，例如0x00ffffff作rgb格式解析。|
|string|支持rgb、rgba或者argb的格式颜色。 rgb格式颜色示例：'#ffffff'、'rgb(255, 100, 255)'。 rgba格式颜色示例：'rgba(255, 100, 255, 0.5)'。 argb格式颜色示例：'#ff000000'。|
|[Resource](#resource)|使用引入资源的方式，引入系统资源或者应用资源中的颜色。|

## LengthConstrain

type LengthConstrain = { minLength: Length; maxLength: Length; }

长度约束，用于对组件最大、最小长度做限制。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|必填|说明|
|:--------|:----------------|:-|:------|
|minLength|[Length](#length)|是|组件最小长度。|
|maxLength|[Length](#length)|是|组件最大长度。|

## Font

设置文本样式。
> 说明
>
> 可以使用[loadFontSync](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-graphics-text#loadfontsync)注册自定义字体。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:-----------------------------------------------------------------------------------------------------------------------------|:-|:-|:----------------------------------------------------------------------------------|
|size|[Length](#length)|否|是|设置文本尺寸，Length为number类型时，使用fp单位。不支持设置百分比字符串。 默认值：16.0|
|weight|[FontWeight](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#fontweight) | number | string|否|是|设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，取值越大，字体越粗。 默认值：400 | FontWeight.Normal|
|family|string | [Resource](#resource)|否|是|字体列表。默认字体'HarmonyOS Sans'。 使用多个字体时，请用逗号','分隔，字体的优先级按顺序生效。例如：'Arial,HarmonyOS Sans'。|
|style|[FontStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#fontstyle)|否|是|设置文本的字体样式。 默认值：FontStyle.Normal|

## Area^8+^

区域类型，用于存储元素所占的区域信息。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-------------|:--------------------|:-|:-|:---------------------------------------------------------------------------------------------------------------|
|width|[Length](#length)|否|否|目标元素的宽度。 单位：vp|
|height|[Length](#length)|否|否|目标元素的高度。 单位：vp|
|position|[Position](#position)|否|否|目标元素左上角在以父元素为基准的[组件坐标系](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkui-glossary#组件坐标系)中的位置。|
|globalPosition|[Position](#position)|否|否|目标元素左上角在当前窗口坐标系中的位置。|

## Position

位置类型，用于表示一个坐标点。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-|:----------------|:-|:-|:----------|
|x|[Length](#length)|否|是|x轴坐标。 单位：vp|
|y|[Length](#length)|否|是|y轴坐标。 单位：vp|

## LocalizedPosition^12+^

位置类型，用于表示一个坐标点。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----|:------------------------------------------------------------------------------------------------------------------------|:-|:-|:----------------------------|
|start|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|LTR模式时x轴相对左边坐标，RTL模式x轴相对右边坐标。|
|top|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|y轴坐标。|

## Edges^12+^

位置类型，表示相对四边的偏移量。同时设置top和bottom，仅top生效；同时设置left和right，仅left生效。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:------------------------|:-|:-|:--------|
|top|[Dimension](#dimension10)|否|是|相对顶边的偏移量。|
|bottom|[Dimension](#dimension10)|否|是|相对底边的偏移量。|
|left|[Dimension](#dimension10)|否|是|相对左边的偏移量。|
|right|[Dimension](#dimension10)|否|是|相对右边的偏移量。|

## LocalizedEdges^12+^

位置类型，表示相对四边的偏移量。同时设置top和bottom，仅top生效；同时设置start和end，仅start生效。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:------------------------------------------------------------------------------------------------------------------------|:-|:-|:-----------------------------|
|top|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|相对顶边的偏移量。|
|bottom|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|相对底边的偏移量。|
|start|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|LTR模式时相对左边的偏移量，RTL模式时相对右边的偏移量。|
|end|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|LTR模式时相对右边的偏移量，RTL模式时相对左边的偏移量。|

## ConstraintSizeOptions

约束尺寸类型，用于描述组件布局时对尺寸大小的范围限制。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:--------|:----------------|:-|:-|:------|
|minWidth|[Length](#length)|否|是|元素最小宽度。|
|maxWidth|[Length](#length)|否|是|元素最大宽度。|
|minHeight|[Length](#length)|否|是|元素最小高度。|
|maxHeight|[Length](#length)|否|是|元素最大高度。|

> 说明
>
> 在[Row](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-container-row)、[Column](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-container-column)、[RelativeContainer](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-container-relativecontainer)组件中，width、height设置auto表示自适应子组件。在[TextInput](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-textinput)组件中，width设置auto表示自适应文本宽度。

## SizeOptions

宽高尺寸类型，用于描述组件布局时的宽高尺寸大小。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:----------------|:-|:-|:----|
|width|[Length](#length)|否|是|元素宽度。|
|height|[Length](#length)|否|是|元素高度。|

## BorderOptions

边框属性集合，用于描述边框相关信息。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-|:-|:-------------------------------------------------------------------------------------------------------------------------------------|
|width|[EdgeWidths](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#edgewidths9)^9+^ | [Length](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#length) | [LocalizedEdgeWidths](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#localizededgewidths12)^12+^|否|是|设置边框宽度。 **元服务API：** 从API version 11开始，该接口支持在元服务中使用。 **卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。|
|color|[EdgeColors](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#edgecolors9)^9+^ | [ResourceColor](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#resourcecolor) | [LocalizedEdgeColors](#localizededgecolors12)^12+^|否|是|设置边框颜色。 **元服务API：** 从API version 11开始，该接口支持在元服务中使用。 **卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。|
|radius|[BorderRadiuses](#borderradiuses9)^9+^ | [Length](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#length) | [LocalizedBorderRadiuses](#localizedborderradiuses12)^12+^|否|是|设置边框圆角半径。 **元服务API：** 从API version 11开始，该接口支持在元服务中使用。 **卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。|
|style|[EdgeStyles](#edgestyles9)^9+^ | [BorderStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#borderstyle)|否|是|设置边框样式。 **元服务API：** 从API version 11开始，该接口支持在元服务中使用。 **卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。|
|dashGap^12+^|[EdgeWidths](#edgewidths9) | [LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12) | [LocalizedEdgeWidths](#localizededgewidths12)|否|是|设置虚线的线段间距，仅在边框样式为虚线时生效。 不支持设置百分比。 **元服务API：** 从API version 12开始，该接口支持在元服务中使用。 **模型约束：** 此接口仅可在Stage模型下使用。 **卡片能力：** 该接口不支持在ArkTS卡片中使用。|
|dashWidth^12+^|[EdgeWidths](#edgewidths9) | [LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12) | [LocalizedEdgeWidths](#localizededgewidths12)|否|是|设置虚线的线段长度，仅在边框样式为虚线时生效。 不支持设置百分比。 **元服务API：** 从API version 12开始，该接口支持在元服务中使用。 **模型约束：** 此接口仅可在Stage模型下使用。 **卡片能力：** 该接口不支持在ArkTS卡片中使用。|

## ColorFilter^9+^

创建具有4*5矩阵的颜色过滤器。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

### constructor^9+^

constructor(value: number[])

ColorFilter的构造函数，创建具有4*5矩阵的颜色过滤器。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

**参数：**

|参数名|类型|必填|说明|
|:----|:-------|:-|:----------------------------------|
|value|number[]|是|4*5颜色矩阵的值，[m*n]位于m行和n列中矩阵值，矩阵是行优先的。|

## CustomBuilder^8+^

组件属性方法参数可使用CustomBuilder类型来自定义UI描述。

|名称|类型定义|描述|
|:------------|:-----------------|:---------------------------------------------------------------------------------------------------------|
|CustomBuilder|(() => any) | void|生成用户自定义组件，在使用时结合[@Builder](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-builder)使用。|

## CustomBuilderT<T>^23+^

type CustomBuilderT<T> = (t: T) => void

自定义UI描述，相比于CustomBuilder，本接口支持传入一个参数。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 23开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

**参数：**

|参数名|类型|必填|说明|
|:--|:-|:-|:-------------------------------------------------------------------------------------------------------------------|
|t|T|是|生成用户自定义组件，在使用时结合[@Builder](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-builder)使用，并允许传入一个参数。|

## MarkStyle^10+^对象说明

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----------|:--------------------------------------------------------------------------------------------------------|:-|:-|:------------------------------------------------------|
|strokeColor|[ResourceColor](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#resourcecolor)|否|是|内部图标颜色。默认值：Color.White|
|size|[Length](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#length)|否|是|内部图标大小，单位vp。默认大小与多选框组件宽度相同。 不支持百分比形式设置。设置为非法值时，按照默认值处理。|
|strokeWidth|[Length](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#length)|否|是|内部图标粗细，单位vp。不支持设置百分比。设置为非法值时，按照默认值处理。默认值：2|

## ModalTransition^10+^

全屏模态转场方式枚举类型，用于设置全屏模态转场类型。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|描述|
|:------|:-----------|
|NONE|全屏模态无转场动画。|
|DEFAULT|全屏模态上下切换动画。|
|ALPHA|全屏模态透明度渐变动画。|

## OutlineOptions^11+^对象说明

外描边选项设置。

**模型约束：** 此接口仅可在Stage模型下使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。

|名称|类型|只读|可选|说明|
|:-----|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-|:-|:--------------------------------------------------------------------------------|
|width|[EdgeOutlineWidths](#edgeoutlinewidths11对象说明) | [Dimension](#dimension10)|否|是|设置外描边宽度，不支持百分比。 默认值：0，外描边效果中width为必设项，否则不显示外描边。|
|color|[EdgeColors](#edgecolors9) | [ResourceColor](#resourcecolor) | [LocalizedEdgeColors](#localizededgecolors12)^12+^|否|是|设置外描边颜色。 默认值：Color.Black|
|radius|[OutlineRadiuses](#outlineradiuses11对象说明) | [Dimension](#dimension10)|否|是|设置外描边圆角半径，不支持百分比。 默认值：0 最大生效值：组件width/2 + outlineWidth或组件height/2 + outlineWidth。|
|style|[EdgeOutlineStyles](#edgeoutlinestyles11对象说明) | [OutlineStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-outline#outlinestyle枚举说明)|否|是|设置外描边样式。 默认值：OutlineStyle.SOLID|

## EdgeOutlineWidths^11+^对象说明

引入该对象时，至少传入一个参数。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

|名称|类型|只读|可选|说明|
|:-----|:------------------------|:-|:-|:-------|
|left|[Dimension](#dimension10)|否|是|左侧外描边宽度。|
|right|[Dimension](#dimension10)|否|是|右侧外描边宽度。|
|top|[Dimension](#dimension10)|否|是|上侧外描边宽度。|
|bottom|[Dimension](#dimension10)|否|是|下侧外描边宽度。|

## OutlineRadiuses^11+^对象说明

引用该对象时，至少传入一个参数。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----------|:--------------------------------------------------------------------------------------------------|:-|:-|:-------|
|topLeft|[Dimension](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#dimension10)|否|是|左上角圆角半径。|
|topRight|[Dimension](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#dimension10)|否|是|右上角圆角半径。|
|bottomLeft|[Dimension](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#dimension10)|否|是|左下角圆角半径。|
|bottomRight|[Dimension](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#dimension10)|否|是|右下角圆角半径。|

## EdgeOutlineStyles^11+^对象说明

引入该对象时，至少传入一个参数。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:---------------------------------------------------------------------------------------------------------------------------------|:-|:-|:-------|
|left|[OutlineStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-outline#outlinestyle枚举说明)|否|是|左侧外描边样式。|
|right|[OutlineStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-outline#outlinestyle枚举说明)|否|是|右侧外描边样式。|
|top|[OutlineStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-outline#outlinestyle枚举说明)|否|是|上侧外描边样式。|
|bottom|[OutlineStyle](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-outline#outlinestyle枚举说明)|否|是|下侧外描边样式。|

## Dimension^10+^

type Dimension = PX | VP | FP | LPX | Percentage | Resource

长度类型，用于描述尺寸单位。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:--------------------------|:------------------------|
|[PX](#px10)|需要指定以px像素单位，如'10px'。|
|[VP](#vp10)|需要指定数字或vp像素单位，如10或'10vp'。|
|[FP](#fp10)|需要指定以fp像素单位，如'10fp'。|
|[LPX](#lpx10)|需要指定以lpx像素单位，如'10lpx'。|
|[Percentage](#percentage10)|需要指定以百分比单位，如'10%'。|
|[Resource](#resource)|资源引用类型，引入系统资源或者应用资源中的尺寸。|

## PX^10+^

type PX = { number }px

长度类型，用于描述以px像素单位为单位的长度。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:-----------|:-------------------|
|{ number }px|需要指定以px像素单位，如'10px'。|

## VP^10+^

type VP = { number }vp | number

长度类型，用于描述以vp为单位的长度。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:--------------------|:------------------------|
|{ number }vp | number|需要指定数字或vp像素单位，如10或'10vp'。|

## FP^10+^

type FP = { number }fp

长度类型，用于描述以fp像素单位为单位的长度。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:-----------|:-------------------|
|{ number }fp|需要指定以fp像素单位，如'10fp'。|

## LPX^10+^

type LPX = { number }lpx

长度类型，用于描述以lpx像素单位为单位的长度。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:------------|:---------------------|
|{ number }lpx|需要指定以lpx像素单位，如'10lpx'。|

## Percentage^10+^

type Percentage = { number }%

长度类型，用于描述以百分比单位为单位的长度。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:----------|:-----------------|
|{ number }%|需要指定以百分比单位，如'10%'。|

## Degree^10+^

type Degree = ${number}deg

角度类型，用于描述以deg为单位的角度。

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:------------|:--------------------|
|{ number }deg|需要指定以deg为单位，如'10deg'。|

## TouchPoint^11+^

配置跟手点坐标，不配置时，默认居中。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-|:------------------------|:-|:-|:-------|
|x|[Dimension](#dimension10)|否|否|跟手点X轴坐标。|
|y|[Dimension](#dimension10)|否|否|跟手点Y轴坐标。|

## VoidCallback^12+^

type VoidCallback = () => void

无参数、无返回值的函数回调类型，用于定义不需要传递数据且不返回结果的回调场景。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

## Callback^12+^

type Callback<T, V = void> = (data: T) => V;

带参数的函数回调。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

## DividerStyleOptions^12+^

分割线样式属性集合, 用于描述分割线相关信息。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----------|:------------------------------------------------------------------------------------------------------------------------|:-|:-|:--------------|
|strokeWidth|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|分割线的线宽。|
|color|[ResourceColor](#resourcecolor)|否|是|分割线的颜色。|
|startMargin|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|分割线与菜单侧边起始端的距离。|
|endMargin|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|分割线与菜单侧边结束端的距离。|
|mode^19+^|[DividerMode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#dividermode19枚举说明)|否|是|设置分割线模式。|

## ChainWeightOptions^14+^对象说明

链中组件的布局权重。

**元服务API：** 从API version 14开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:---------|:-----|:-|:-|:------------------------------------|
|horizontal|number|否|是|组件在水平方向的布局权重，设置大于0的数字时生效。 默认值：0 异常值：0|
|vertical|number|否|是|组件在竖直方向的布局权重，设置大于0的数字时生效。 默认值：0 异常值：0|

## Configuration

数据类型。用于设置颜色模式和字体缩放倍数。

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

**元服务API：** 从API version 11开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:--------|:-----|:-|:-|:----|
|colorMode|string|是|否|颜色模式。|
|fontScale|number|是|否|字体缩放。|

## AccessibilityOptions^14+^对象说明

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:-|:-|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|accessibilityPreferred|boolean|否|是|若accessibilityPreferred设置为true，则深度遍历每个子节点时优先选择该子节点的无障碍文本accessibilityText。 若无障碍文本为空则选择本身Text文本，最终将拼接完成的文本设置给accessibilityText与Text都为空的父节点。 若accessibilityPreferred设置为false，表示不启用此功能。 默认值：false **元服务API：** 从API version 14开始，该接口支持在元服务中使用。|
|stateControllerRoleType^23+^|[AccessibilityRoleType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-accessibility#accessibilityroletype18枚举说明)|否|是|指定特定类型的子组件。配置[accessibilityGroup](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-accessibility#accessibilitygroup14)的容器组件进行无障碍聚合后，会将该特定类型的子组件的选中状态和状态播报文本作为聚合组件的状态和播报文本。从而聚合屏幕朗读下的状态播报，避免需要对子组件单独进行聚焦。 **说明：** 如果聚合组件内有多个相同类型的子组件，则以组件树上该聚合组件下的第一个查找到的子组件为控制组件。 不支持跨进程嵌入式组件内的特定类型，例如：卡片、EmbeddedUIExtension。 默认值：无指定组件 **元服务API：** 从API version 23开始，该接口支持在元服务中使用。|
|stateControllerId^23+^|string|否|是|指定特定[唯一标识ID](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-component-id#id)的子组件。配置[accessibilityGroup](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-accessibility#accessibilitygroup14)的容器组件进行无障碍聚合后，会将该特定标识的子组件的选中状态和状态播报文本作为聚合组件的状态和播报文本。从而聚合屏幕朗读下的状态播报，避免需要对子组件单独进行聚焦。 **说明：** 如果聚合组件内有多个相同类型的子组件，则以组件树上该聚合组件下的第一个查找到的子组件为控制组件。 如果与stateControllerRoleType同时配置，则优先匹配ID一致的组件。 不支持跨进程嵌入式组件内的特定类型，例如：卡片、EmbeddedUIExtension。 默认值：无指定组件 **元服务API：** 从API version 23开始，该接口支持在元服务中使用。|
|actionControllerRoleType^23+^|[AccessibilityRoleType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-accessibility#accessibilityroletype18枚举说明)|否|是|指定特定类型的子组件。配置[accessibilityGroup](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-accessibility#accessibilitygroup14)的容器组件进行无障碍聚合后，如果触发无障碍的控制操作时，会将操作转发给该特定类型的子组件。从而聚合屏幕朗读下的点击事件，避免需要对子组件单独进行聚焦。 **说明：** 如果聚合组件内有多个相同类型的子组件，则以组件树上该聚合组件下的第一个查找到的子组件为控制组件。 当前只支持无障碍点击操作。 不支持跨进程嵌入式组件内的特定类型，例如：卡片、EmbeddedUIExtension。 默认值：无指定组件 **元服务API：** 从API version 23开始，该接口支持在元服务中使用。|
|actionControllerId^23+^|string|否|是|指定特定[唯一标识ID](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-component-id#id)的子组件。配置[accessibilityGroup](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-universal-attributes-accessibility#accessibilitygroup14)的容器组件进行无障碍聚合后，如果触发无障碍的控制操作时，会将操作转发给该特定标识的子组件。从而聚合屏幕朗读下的点击事件，避免需要对子组件单独进行聚焦。 **说明：** 如果聚合组件内有多个相同类型的子组件，则以组件树上该聚合组件下的第一个查找到的子组件为控制组件。 当前只支持无障碍点击操作。 如果与actionControllerRoleType同时配置，则优先匹配ID一致的组件。 不支持跨进程嵌入式组件内的特定类型，例如：卡片、EmbeddedUIExtension。 默认值：无指定组件 **元服务API：** 从API version 23开始，该接口支持在元服务中使用。|

## ScrollBarMargin^20+^对象说明

滚动条边距。

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:----|:------------------------------------------------------------------------------------------------------------------------|:-|:-|:-------------------|
|start|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|滚动条起始边距。 默认值：0，单位：vp|
|end|[LengthMetrics](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-arkui-graphics#lengthmetrics12)|否|是|滚动条末尾边距。 默认值：0，单位：vp|

## ResponsiveFillType^22+^

type ResponsiveFillType = PresetFillType

响应式布局填充模式，用于WaterFlow、Grid、List、Swiper和LazyVWaterFlowLayout组件。LazyVWaterFlowLayout组件从API版本26.0.0开始支持。

**元服务API：** 从API version 22开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|类型|说明|
|:---------------------------------------------------------------------------------------------------------------------|:--------------|
|[PresetFillType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-appendix-enums#presetfilltype22)|为不同响应式断点规格指定列数。|

## ItemFillPolicy^22+^

定义一个适用于WaterFlow、Grid、List、Swiper和LazyVWaterFlowLayout组件的响应式布局策略。LazyVWaterFlowLayout组件从API版本26.0.0开始支持。

**元服务API：** 从API version 22开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-------|:------------------------------------------|:-|:-|:------------------------------------|
|fillType|[ResponsiveFillType](#responsivefilltype22)|否|是|为不同的响应式断点指定列数。默认值为BREAKPOINT_DEFAULT。|

## DirectionalEdgesT<T>^12+^

边缘宽度类型，用于描述组件边缘不同方向的宽度。支持全球化。

**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-----|:-|:-|:-|:-----------------------------------|
|start|T|否|否|起始边缘的属性。在LTR的方向下，为左边缘，在RTL的方向下，为右边缘。|
|end|T|否|否|终止边缘的属性。在LTR的方向下，为右边缘，在RTL的方向下，为左边缘。|
|top|T|否|否|顶部边缘的属性。|
|bottom|T|否|否|底部边缘的属性。|

## Bias^11+^对象说明

设置组件在锚点约束下的偏移参数。

以水平方向Bias为例，其值为组件到左锚点的距离 D~start~与组件到水平方向锚点间总距离 D~start~ + D~end~的比值。镜像语言下，D~start~为组件到右锚点的距离。下图中D~width~表示组件宽度。

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/26/v3/zVCkoRPmSdiw_yh_RcjR8Q/zh-cn_image_0000002747293145.png?HW-CC-KV=V1&HW-CC-Date=20260909T162937Z&HW-CC-Expire=31536000000&HW-CC-Sign=E98DA44D1AE1B277020745533EB853B961106C1B7677F5C5D713C2A296F6DEC4)

竖直方向同理，其值为组件到上锚点的距离D~top~与组件到竖直方向锚点间总距离D~top~ + D~bottom~的比值。下图中D~height~表示组件高度。

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/ce/v3/RVVdiHNUQMiMJJSK4utvVQ/zh-cn_image_0000002747213061.png?HW-CC-KV=V1&HW-CC-Date=20260909T162937Z&HW-CC-Expire=31536000000&HW-CC-Sign=FBF804BD5D8B469536C4C719CCFE0E7C2558C40BE0ABF23C97ADD6B255BCE562)

**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API version 12开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:---------|:-----|:-|:-|:------------------------------------------------------------------|
|horizontal|number|否|是|水平方向上的bias值。 当子组件的width属性有正确值并且有2个水平方向的锚点时生效，设置的值必须大于等于0。 默认值： 0.5|
|vertical|number|否|是|垂直方向上的bias值。 当子组件的height属性有正确值并且有2个垂直方向的锚点时生效，设置的值必须大于等于0。 默认值： 0.5|

## CacheCountInfo^22+^对象说明

缓存数量信息。

**元服务API：** 从API version 22开始，该接口支持在元服务中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-------|:-----|:-|:-|:--------------------------------------------------------------------------------------------------------|
|minCount|number|否|否|最小缓存数，当实际缓存数小于最小缓存数时，在滚动动画帧间空闲时隙加载缓存。 取值范围：[0, +∞)，小于0时按1处理。|
|maxCount|number|否|否|最大缓存数，当实际缓存数大于最大缓存数时，缓存内容会回收或释放，当UI空闲时（无动画或用户操作），会加载缓存到最大缓存数。 取值范围：[minCount, +∞)，小于minCount时按minCount处理。|

## Coordinate2D

描述一个二维坐标系。

**起始版本：** 26.0.0

**模型约束：** 此接口仅可在Stage模型下使用。

**元服务API：** 从API版本26.0.0开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:-|:-----|:-|:-|:---------|
|x|number|否|否|x轴坐标，单位vp。|
|y|number|否|否|y轴坐标，单位vp。|

## AccessibilityActionOptions^23+^对象说明

设置组件的无障碍操作的可选参数，用于限制或修改屏幕朗读等辅助应用发起的操作行为。仅[Slider](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-slider)组件支持使用。在其他组件使用该接口时，编译环节可正常通过，但接口功能不生效。

**元服务API：** 从API version 23开始，该接口支持在元服务中使用。

**卡片能力：** 从API version 23开始，该接口支持在ArkTS卡片中使用。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

|名称|类型|只读|可选|说明|
|:---------|:-----|:-|:-|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|scrollStep|number|否|是|无障碍手势触发的无障碍滚动操作中的组件操作步数。默认值基于组件默认值。 不支持的组件配置不生效。 当前支持组件：[slider](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-slider)，用于slider组件聚焦后通过手势上下扫动触发slider组件的滑动操作。滑动距离：scrollStep*[step](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-slider#slideroptions对象说明)。取值范围：[1, ([max](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-slider#slideroptions对象说明) - [min](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-slider#slideroptions对象说明))/[step](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-basic-components-slider#slideroptions对象说明)]，默认值为1。超出取值范围时取默认值1；在取值范围内，scrollStep为非整数时向下取整。|

## AccessibilityNextFocusParams

定义无障碍自定义下一个焦点处理过程中可使用的详细参数对象。

**起始版本：** 26.0.0

**卡片能力：** 从API版本26.0.0开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API版本26.0.0开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

**模型约束：** 此接口仅可在Stage模型下使用。

|名称|类型|只读|可选|说明|
|:--------------------|:------|:-|:-|:--------------------------------------------------------------------------------------------------------------|
|isConsiderDescendants|boolean|否|是|是否在无障碍自定义下一个焦点处理过程中查找后代节点中的焦点。 true表示在无障碍自定义下一个焦点处理过程中查找后代节点中的焦点；false表示在无障碍自定义下一个焦点处理过程中不查找后代节点中的焦点。 默认值：false|

## AccessibilityCustomAction

自定义无障碍操作接口。

**起始版本：** 26.0.0

**卡片能力：** 从API版本26.0.0开始，该接口支持在ArkTS卡片中使用。

**元服务API：** 从API版本26.0.0开始，该接口支持在元服务中使用。

**系统能力：** SystemCapability.ArkUI.ArkUI.Full

**模型约束：** 此接口仅可在Stage模型下使用。

|名称|类型|只读|可选|说明|
|:-------|:------------------------------|:-|:-|:-------------------------------------------------------|
|name|[ResourceStr](#resourcestr)|否|否|自定义操作的名称，用于标识和绑定操作回调。 **说明：** 名称的文本长度需在128字节以内，超出部分将被截断。|
|onAction|[VoidCallback](#voidcallback12)|否|否|处理自定义操作的回调。|