OpenHarmony应用开发-全局UI方法-枚举说明/ 已停止维护的组件
版本:v3.2 Release
枚举说明
Color
从API version 9开始,该接口支持在ArkTS卡片中使用。
颜色名称 | 颜色值 | 颜色示意 |
Black | 0x000000 | |
Blue | 0x0000ff | |
Brown | 0xa52a2a | |
Gray | 0x808080 | |
Grey | 0x808080 | |
Green | 0x008000 | |
Orange | 0xffa500 | |
Pink | 0xffc0cb | |
Red | 0xff0000 | |
White | 0xffffff | |
Yellow | 0xffff00 | |
Transparent9+ | rgba(0,0,0,0) | 透明色 |
ImageFit
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Contain | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。 |
Cover | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。 |
Auto | 自适应显示 |
Fill | 不保持宽高比进行放大缩小,使得图片充满显示边界。 |
ScaleDown | 保持宽高比显示,图片缩小或者保持不变。 |
None | 保持原有尺寸显示。 |
BorderStyle
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Dotted | 显示为一系列圆点,圆点半径为borderWidth的一半。 |
Dashed | 显示为一系列短的方形虚线。 |
Solid | 显示为一条实线。 |
LineJoinStyle
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Bevel | 使用斜角连接路径段。 |
Miter | 使用尖角连接路径段。 |
Round | 使用圆角连接路径段。 |
TouchType
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Down | 手指按下时触发。 |
Up | 手指抬起时触发。 |
Move | 手指按压态在屏幕上移动时触发。 |
Cancel | 触摸事件取消时触发。 |
MouseButton
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Left | 鼠标左键。 |
Right | 鼠标右键。 |
Middle | 鼠标中键。 |
Back | 鼠标左侧后退键。 |
Forward | 鼠标左侧前进键。 |
None | 无按键。 |
MouseAction
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Press | 鼠标按键按下。 |
Release | 鼠标按键松开。 |
Move | 鼠标移动。 |
Hover | 鼠标悬浮。 |
Curve
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Linear | 表示动画从头到尾的速度都是相同的。 |
Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25, 0.1, 0.25, 1.0)。 |
EaseIn | 表示动画以低速开始,CubicBezier(0.42, 0.0, 1.0, 1.0)。 |
EaseOut | 表示动画以低速结束,CubicBezier(0.0, 0.0, 0.58, 1.0)。 |
EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42, 0.0, 0.58, 1.0)。 |
FastOutSlowIn | 标准曲线,cubic-bezier(0.4, 0.0, 0.2, 1.0)。 |
LinearOutSlowIn | 减速曲线,cubic-bezier(0.0, 0.0, 0.2, 1.0)。 |
FastOutLinearIn | 加速曲线,cubic-bezier(0.4, 0.0, 1.0, 1.0)。 |
ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0, 0.0, 0.0, 1.0)。 |
Sharp | 锐利曲线,cubic-bezier(0.33, 0.0, 0.67, 1.0)。 |
Rhythm | 节奏曲线,cubic-bezier(0.7, 0.0, 0.2, 1.0)。 |
Smooth | 平滑曲线,cubic-bezier(0.4, 0.0, 0.4, 1.0)。 |
Friction | 阻尼曲线,CubicBezier(0.2, 0.0, 0.2, 1.0)。 |
AnimationStatus
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Initial | 动画初始状态。 |
Running | 动画处于播放状态。 |
Paused | 动画处于暂停状态。 |
Stopped | 动画处于停止状态。 |
FillMode
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
None | 动画未执行时不会将任何样式应用于目标,动画播放完成之后恢复初始默认状态。 |
Forwards | 目标将保留动画执行期间最后一个关键帧的状态。 |
Backwards | 动画将在应用于目标时立即应用第一个关键帧中定义的值,并在delay期间保留此值。第一个关键帧取决于playMode,playMode为Normal或Alternate时为from的状态,playMode为Reverse或AlternateReverse时为to的状态。 |
Both | 动画将遵循Forwards和Backwards的规则,从而在两个方向上扩展动画属性。 |
PlayMode
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Normal | 动画按正常播放。 |
Reverse | 动画反向播放。 |
Alternate | 动画在奇数次(1、3、5…)正向播放,在偶数次(2、4、6…)反向播放。 |
AlternateReverse | 动画在奇数次(1、3、5…)反向播放,在偶数次(2、4、6…)正向播放。 |
KeyType
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Down | 按键按下。 |
Up | 按键松开。 |
KeySource
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Unknown | 输入设备类型未知。 |
Keyboard | 输入设备类型为键盘。 |
Edge
名称 | 描述 |
Top | 竖直方向上边缘 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Center(deprecated) | 竖直方向居中位置 从API version 9开始废弃 |
Bottom | 竖直方向下边缘 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Baseline(deprecated) | 交叉轴方向文本基线位置 从API version 9开始废弃 |
Start | 水平方向起始位置 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Middle(deprecated) | 水平方向居中位置 从API version 9开始废弃 |
End | 水平方向末尾位置 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Week
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Mon | 星期一 |
Tue | 星期二 |
Wed | 星期三 |
Thur | 星期四 |
Fri | 星期五 |
Sat | 星期六 |
Sun | 星期日 |
Direction
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Ltr | 元素从左到右布局。 |
Rtl | 元素从右到左布局。 |
Auto | 使用系统默认布局方向。 |
BarState
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Off | 不显示。 |
On | 常驻显示。 |
Auto | 按需显示(触摸时显示,2s后消失)。 |
EdgeEffect
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 |
Fade | 阴影效果,滑动到边缘后会有圆弧状的阴影。 |
None | 滑动到边缘后无效果。 |
Alignment
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
TopStart | 顶部起始端。 |
Top | 顶部横向居中。 |
TopEnd | 顶部尾端。 |
Start | 起始端纵向居中。 |
Center | 横向和纵向居中。 |
End | 尾端纵向居中。 |
BottomStart | 底部起始端。 |
Bottom | 底部横向居中。 |
BottomEnd | 底部尾端。 |
TransitionType
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
All | 指定当前的Transition动效生效在组件的所有变化场景。 |
Insert | 指定当前的Transition动效生效在组件的插入显示场景。 |
Delete | 指定当前的Transition动效生效在组件的删除隐藏场景。 |
RelateType
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
FILL | 缩放当前子组件以填充满父组件 |
FIT | 缩放当前子组件以自适应父组件 |
Visibility
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Hidden | 隐藏,但参与布局进行占位。 |
Visible | 显示。 |
None | 隐藏,但不参与布局,不进行占位。 |
LineCapStyle
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Butt | 线条两端为平行线,不额外扩展。 |
Round | 在线条两端延伸半个圆,直径等于线宽。 |
Square | 在线条两端延伸一个矩形,宽度等于线宽的一半,高度等于线宽。 |
Axis
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Vertical | 方向为纵向。 |
Horizontal | 方向为横向。 |
HorizontalAlign
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Start | 按照语言方向起始端对齐。 |
Center | 居中对齐,默认对齐方式。 |
End | 按照语言方向末端对齐。 |
FlexAlign
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Start | 元素在主轴方向首端对齐,第一个元素与行首对齐,同时后续的元素与前一个对齐。 |
Center | 元素在主轴方向中心对齐,第一个元素与行首的距离与最后一个元素与行尾距离相同。 |
End | 元素在主轴方向尾部对齐,最后一个元素与行尾对齐,其他元素与后一个对齐。 |
SpaceBetween | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。第一个元素与行首对齐,最后一个元素与行尾对齐。 |
SpaceAround | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。第一个元素到行首的距离和最后一个元素到行尾的距离是相邻元素之间距离的一半。 |
SpaceEvenly | Flex主轴方向均匀分配弹性元素,相邻元素之间的距离、第一个元素与行首的间距、最后一个元素到行尾的间距都完全一样。 |
ItemAlign
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Auto | 使用Flex容器中默认配置。 |
Start | 元素在Flex容器中,交叉轴方向首部对齐。 |
Center | 元素在Flex容器中,交叉轴方向居中对齐。 |
End | 元素在Flex容器中,交叉轴方向底部对齐。 |
Stretch | 元素在Flex容器中,交叉轴方向拉伸填充。容器为Flex且设置Wrap为FlexWrap.Wrap或FlexWrap.WrapReverse时,元素拉伸到与当前行/列交叉轴长度最长的元素尺寸。其余情况在元素未设置尺寸时,拉伸到容器尺寸。 |
Baseline | 元素在Flex容器中,交叉轴方向文本基线对齐。 |
FlexDirection
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Row | 主轴与行方向一致作为布局模式。 |
RowReverse | 与Row方向相反方向进行布局。 |
Column | 主轴与列方向一致作为布局模式。 |
ColumnReverse | 与Column相反方向进行布局。 |
FlexWrap
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
NoWrap | Flex容器的元素单行/列布局,子项不允许超出容器。 |
Wrap | Flex容器的元素多行/列排布,子项允许超出容器。 |
WrapReverse | Flex容器的元素反向多行/列排布,子项允许超出容器。 |
VerticalAlign
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Top | 顶部对齐。 |
Center | 居中对齐,默认对齐方式。 |
Bottom | 底部对齐。 |
ImageRepeat
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
X | 只在水平轴上重复绘制图片。 |
Y | 只在竖直轴上重复绘制图片。 |
XY | 在两个轴上重复绘制图片。 |
NoRepeat | 不重复绘制图片。 |
ImageSize
从API version 9开始,该接口支持在ArkTS卡片中使用。
类型 | 描述 |
Cover | 默认值,保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。 |
Contain | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。 |
Auto | 保持原图的比例不变。 |
GradientDirection
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Left | 从右向左。 |
Top | 从下向上。 |
Right | 从左向右。 |
Bottom | 从上向下。 |
LeftTop | 左上。 |
LeftBottom | 左下。 |
RightTop | 右上。 |
RightBottom | 右下。 |
None | 无。 |
SharedTransitionEffectType
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Static | 目标页面元素的位置保持不变,可以配置透明度动画。目前,只有为重定向到目标页面而配置的静态效果才会生效。 |
Exchange | 将源页面元素移动到目标页面元素位置并适当缩放。 |
FontStyle
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Normal | 标准的字体样式。 |
Italic | 斜体的字体样式。 |
FontWeight
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Lighter | 字体较细。 |
Normal | 字体粗细正常。 |
Regular | 字体粗细正常。 |
Medium | 字体粗细适中。 |
Bold | 字体较粗。 |
Bolder | 字体非常粗。 |
TextAlign
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Start | 水平对齐首部。 |
Center | 水平居中对齐。 |
End | 水平对齐尾部。 |
TextOverflow
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Clip | 文本超长时进行裁剪显示。 |
Ellipsis | 文本超长时显示不下的文本用省略号代替。 |
None | 文本超长时不进行裁剪。 |
TextDecorationType
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Underline | 文字下划线修饰。 |
LineThrough | 穿过文本的修饰线。 |
Overline | 文字上划线修饰。 |
None | 不使用文本装饰线。 |
TextCase
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Normal | 保持文本原有大小写。 |
LowerCase | 文本采用全小写。 |
UpperCase | 文本采用全大写。 |
ResponseType8+
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
LongPress | 通过长按触发菜单弹出。 |
RightClick | 通过鼠标右键触发菜单弹出。 |
HoverEffect8+
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Auto | 使用组件的系统默认悬浮效果。 |
Scale | 放大缩小效果。 |
Highlight | 背景淡入淡出的强调效果。 |
None | 不设置效果。 |
Placement8+
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Left | 气泡提示位于组件左侧,与组件左侧中心对齐。 |
Right | 气泡提示位于组件右侧,与组件右侧中心对齐。 |
Top | 气泡提示位于组件上侧,与组件上侧中心对齐。 |
Bottom | 气泡提示位于组件下侧,与组件下侧中心对齐。 |
TopLeft | 气泡提示位于组件上侧,从API Version 9开始,与组件左侧边缘对齐。 |
TopRight | 气泡提示位于组件上侧,从API Version 9开始,与组件右侧边缘对齐。 |
BottomLeft | 气泡提示位于组件下侧,从API Version 9开始,与组件左侧边缘对齐。 |
BottomRight | 气泡提示位于组件下侧,从API Version 9开始,与组件右侧边缘对齐。 |
LeftTop9+ | 气泡提示位于组件左侧,与组件上侧边缘对齐。 |
LeftBottom9+ | 气泡提示位于组件左侧,与组件下侧边缘对齐。 |
RightTop9+ | 气泡提示位于组件右侧,与组件上侧边缘对齐。 |
RightBottom9+ | 气泡提示位于组件右侧,与组件下侧边缘对齐。 |
CopyOptions9+
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
None | 不支持复制。 |
InApp | 支持应用内复制。 |
LocalDevice | 支持设备内复制。 |
HitTestMode9+
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Default | 自身节点和子节点都响应触摸事件的命中测试,但会阻止被该节点屏蔽的其他节点的命中测试。 |
Block | 自身节点响应触摸事件的命中测试,但阻止被该节点屏蔽的子节点和其他节点的命中测试。 |
Transparent | 自身节点和子节点响应触摸事件的命中测试,并允许对被该节点屏蔽的其他节点进行命中测试。 |
None | 自身节点不会响应触摸事件的命中测试,但子节点会对触摸事件进行命中测试。 |
已停止维护的组件
GridContainer
纵向排布栅格布局容器,仅在栅格布局场景中使用。
说明:
从API Version 9 开始,该组件不再维护,推荐使用新组件GridCol、GridRow。
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
可以包含子组件。
接口
GridContainer(value?: { columns?: number | ‘auto’, sizeType?: SizeType, gutter?: number | string, margin?: number | string})
参数:
参数名 | 类型 | 必填 | 说明 |
columns | number | ‘auto’ | 否 | 设置当前布局总列数。 默认值:‘auto’ |
sizeType | SizeType | 否 | 选用设备宽度类型。 默认值:SizeType.Auto |
gutter | number | string | 否 | 栅格布局列间距,不支持百分比。 |
margin | number | string | 否 | 栅格布局两侧间距,不支持百分比。 |
SizeType枚举说明
名称 | 描述 |
XS | 最小宽度类型设备。 |
SM | 小宽度类型设备。 |
MD | 中等宽度类型设备。 |
LG | 大宽度类型设备。 |
Auto | 根据设备类型进行选择。 |
属性
支持通用属性和Column组件的属性方法。
事件
支持通用事件。
示例
// xxx.ets
@Entry
@Component
struct GridContainerExample {
@State sizeType: SizeType = SizeType.XS
build() {
Column({ space: 5 }) {
GridContainer({ columns: 12, sizeType: this.sizeType, gutter: 10, margin: 20 }) {
Row() {
Text('1')
.useSizeType({
xs: { span: 6, offset: 0 },
sm: { span: 2, offset: 0 },
md: { span: 2, offset: 0 },
lg: { span: 2, offset: 0 }
})
.height(50).backgroundColor(0x4682B4).textAlign(TextAlign.Center)
Text('2')
.useSizeType({
xs: { span: 2, offset: 6 },
sm: { span: 6, offset: 2 },
md: { span: 2, offset: 2 },
lg: { span: 2, offset: 2 }
})
.height(50).backgroundColor(0x00BFFF).textAlign(TextAlign.Center)
Text('3')
.useSizeType({
xs: { span: 2, offset: 8 },
sm: { span: 2, offset: 8 },
md: { span: 6, offset: 4 },
lg: { span: 2, offset: 4 }
})
.height(50).backgroundColor(0x4682B4).textAlign(TextAlign.Center)
Text('4')
.useSizeType({
xs: { span: 2, offset: 10 },
sm: { span: 2, offset: 10 },
md: { span: 2, offset: 10 },
lg: { span: 6, offset: 6 }
})
.height(50).backgroundColor(0x00BFFF).textAlign(TextAlign.Center)
}
}.width('90%')
Text('Click Simulate to change the device width').fontSize(9).width('90%').fontColor(0xCCCCCC)
Row() {
Button('XS')
.onClick(() => {
this.sizeType = SizeType.XS
}).backgroundColor(0x317aff)
Button('SM')
.onClick(() => {
this.sizeType = SizeType.SM
}).backgroundColor(0x317aff)
Button('MD')
.onClick(() => {
this.sizeType = SizeType.MD
}).backgroundColor(0x317aff)
Button('LG')
.onClick(() => {
this.sizeType = SizeType.LG
}).backgroundColor(0x317aff)
}
}.width('100%').margin({ top: 5 })
}
}