文档管理中心

TextClock

TextClock组件通过文本将当前系统时间显示在设备上,支持不同时区的时间显示和时间格式自定义,最高精度到秒级。适用于需要在应用界面上实时展示系统时间、支持多时区显示的场景,可帮助开发者快速实现时间文本展示功能,无需手动计算和更新时间。

组件不可见时,时间变动将停止。组件的可见状态基于onVisibleAreaChange处理,可见阈值ratios大于0即视为可见状态。

说明

该组件从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

子组件

PhonePC/2in1TabletTVWearable

接口

PhonePC/2in1TabletTVWearable

TextClock(options?: TextClockOptions)

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

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

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

参数:

展开
参数名 类型 必填 说明
options TextClockOptions 通过文本显示当前系统时间的组件参数。不传入时使用默认配置,各属性默认值详见TextClockOptions。

TextClockOptions18+对象说明

PhonePC/2in1TabletTVWearable

用于构建TextClock组件的选项。

说明

为规范匿名对象的定义,API 18版本修改了此处的元素定义。其中,保留了历史匿名对象的起始版本信息,会出现外层元素@since版本号高于内层元素版本号的情况,但这不影响接口的使用。

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

元服务API: 从API version 18开始,该接口支持在元服务中使用。

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

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

展开
名称 类型 只读 可选 说明
timeZoneOffset8+ number

设置时区偏移量,单位:小时。

取值范围为[-14, 12],表示东十二区到西十二区,其中负值表示东时区,正值表示西时区,比如东八区为-8。设置值为该取值范围内的浮点数时会进行取整,舍弃小数部分。

对横跨国际日界线的国家或地区,用-13(UTC+13)和-14(UTC+14)来保证整个国家或者区域处在相同的时间,当设置的值不在取值范围内时,将使用当前系统的时区偏移量。

默认值:当前系统的时区偏移量

设置值为{ 9.5, 3.5, -3.5, -4.5, -5.5, -5.75, -6.5, -9.5, -10.5, -12.75 }集合中的浮点数时不进行取整。

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

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

controller8+ TextClockController

绑定一个控制器,用来控制文本时钟的状态。当需要通过代码控制时钟的启动与停止时传入此参数;不传入时,时钟仍会正常运行显示,但无法通过代码控制启停。

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

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

属性

PhonePC/2in1TabletTVWearable

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

format

PhonePC/2in1TabletTVWearable

format(value: ResourceStr)

设置显示时间格式,如“yyyy/MM/dd”、“yyyy-MM-dd”。

y:年(yyyy表示完整年份,yy表示年份后两位)

M:月(若想使用01月则使用MM)

d:日(若想使用01日则使用dd)

E:星期(若想使用星期六则使用EEEE,若想使用周六则使用E、EE、EEE)

H:小时(24小时制)

h:小时(12小时制)

m:分钟

s:秒

SS:厘秒(format中S个数<3,全部按厘秒处理)

SSS:毫秒(format中S个数>=3,全部按毫秒处理)

a:上午/下午(当设置小时制式为H时,该参数不生效)

日期间隔符:"年月日"、“/”、"-"、"."(可以自定义间隔符样式,字母不可以作为间隔符,汉字可以作为间隔符处理)

允许自行拼接组合显示格式,即:年、月、日、星期、时、分、秒、毫秒可拆分为子元素,可自行排布组合。时间更新频率最高为一秒一次,不建议单独设置厘秒和毫秒格式。

当设置无效字母时(非上述字母被认为是无效字母),该字母会被忽略。如果format全是无效字母时,显示格式跟随系统语言和系统小时制。例如系统语言为中文时,12小时制显示格式为yyyy/MM/dd aa hh:mm:ss.SSS,24小时制显示格式为yyyy/MM/dd HH:mm:ss.SSS。

若format为空字符串("")或者undefined,则使用默认值。

非卡片中默认值:12小时制:aa hh:mm:ss,24小时制:HH:mm:ss。

卡片中默认值:12小时制:hh:mm,24小时制:HH:mm 。

卡片中使用时,最小时间单位为分钟。如果设置格式中有秒或厘秒,则按默认值处理。

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

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

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

参数:

展开
参数名 类型 必填 说明
value ResourceStr

显示时间格式。

从API version 20开始,支持Resource类型。

以下是format输入的格式样式及对应的显示效果:

展开
输入格式 显示效果
yyyy年M月d日 EEEE 2023年2月4日 星期六
yyyy年M月d日 2023年2月4日
M月d日 EEEE 2月4日 星期六
M月d日 2月4日
MM/dd/yyyy 02/04/2023
EEEE MM月dd日 星期六 02月04日
yyyy(完整年份) 2023年
yy(年份后两位) 23年
MM(完整月份) 02月
M(月份) 2月
dd(完整日期) 04日
d(日期) 4日
EEEE(完整星期) 星期六
E、EE、EEE(简写星期) 周六
yyyy年M月d日 2023年2月4日
yyyy/M/d 2023/2/4
yyyy-M-d 2023-2-4
yyyy.M.d 2023.2.4
HH:mm:ss(时:分:秒) 17:00:04
aa hh:mm:ss(时:分:秒) 上午 5:00:04
hh:mm:ss(时:分:秒) 5:00:04
HH:mm(时:分) 17:00
aa hh:mm(时:分) 上午 5:00
hh:mm(时:分) 5:00
mm:ss(分:秒) 00:04
mm:ss.SS(分:秒.厘秒) 00:04.91
mm:ss.SSS(分:秒.毫秒) 00:04.536
hh:mm:ss aa 5:00:04 上午
HH 17

fontColor

PhonePC/2in1TabletTVWearable

fontColor(value: ResourceColor)

设置字体颜色。

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

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

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

参数:

展开
参数名 类型 必填 说明
value ResourceColor

字体颜色。

Wearable设备上默认值:'#c5ffffff',其他设备默认值:'#e6182431'

fontSize

PhonePC/2in1TabletTVWearable

fontSize(value: Length)

设置字体大小。

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

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

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

参数:

展开
参数名 类型 必填 说明
value Length

字体大小。fontSize为number类型时,使用fp单位。

字体默认大小16fp。不支持设置百分比字符串,传入百分比字符串时使用默认值。

fontStyle

PhonePC/2in1TabletTVWearable

fontStyle(value: FontStyle)

设置字体样式。

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

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

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

参数:

展开
参数名 类型 必填 说明
value FontStyle

字体样式。

默认值:FontStyle.Normal,表示标准的字体样式(非斜体)。

fontWeight

PhonePC/2in1TabletTVWearable

fontWeight(value: number | FontWeight | string)

设置文本的字体粗细,设置过大可能会导致不同字体下的文字出现截断。

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

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

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

参数:

展开
参数名 类型 必填 说明
value number | FontWeight | string

文本的字体粗细,number类型取值范围为[100, 900],取值间隔为100,取值越大,字体越粗。number类型取值范围外的默认值为400。string类型支持:number类型取值的字符串形式(如400),以及枚举值'lighter'(对应300)、'regular'(对应400)、'medium'(对应500)、'bold'(对应700)、'bolder'(对应900),分别对应FontWeight中相应的枚举值。

默认值:FontWeight.Normal

fontFamily

PhonePC/2in1TabletTVWearable

fontFamily(value: ResourceStr)

设置字体列表。

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

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

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

参数:

展开
参数名 类型 必填 说明
value ResourceStr

字体列表。默认字体'HarmonyOS Sans'。

应用当前支持'HarmonyOS Sans'字体和注册自定义字体

卡片当前仅支持'HarmonyOS Sans'字体。

textShadow11+

PhonePC/2in1TabletTVWearable

textShadow(value: ShadowOptions | Array<ShadowOptions>)

设置文字阴影效果。该接口支持以数组形式入参,实现多重文字阴影。不支持fill字段和智能取色模式。

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

元服务API: 从API version 12开始,该接口支持在元服务中使用。

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

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

参数:

展开
参数名 类型 必填 说明
value ShadowOptions | Array<ShadowOptions>

文字阴影效果。支持单个阴影对象或阴影数组实现多重阴影效果。ShadowOptions对象包含radius(模糊半径)、color(阴影颜色)、offsetX(X轴偏移)、offsetY(Y轴偏移)等属性。

不支持fill字段,不支持智能取色模式。具体属性说明请参考ShadowOptions对象说明

fontFeature11+

PhonePC/2in1TabletTVWearable

fontFeature(value: string)

设置文字特性效果,比如数字等宽的特性。

格式为:normal | <feature-tag-value>

<feature-tag-value>的格式为:<string> [ <integer> | on | off ]

<feature-tag-value>的个数可以有多个,中间用','隔开。

例如,使用等宽时钟数字的输入格式为:"ss01" on。

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

元服务API: 从API version 12开始,该接口支持在元服务中使用。

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

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

参数:

展开
参数名 类型 必填 说明
value string 文字特性效果,用于设置文字的OpenType特性。格式为:normal | <feature-tag-value>,其中<feature-tag-value>格式为:<string> [ <integer> | on | off ]。可设置多个特性,中间用','隔开。例如,使用等宽时钟数字的格式为:'"ss01" on'。

contentModifier12+

PhonePC/2in1TabletTVWearable

contentModifier(modifier: ContentModifier<TextClockConfiguration>)

定制TextClock内容区的方法。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

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

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

参数:

展开
参数名 类型 必填 说明
modifier ContentModifier<TextClockConfiguration>

在TextClock组件上,定制内容区的方法。

modifier: 内容修改器,开发者需要自定义class实现ContentModifier接口。

dateTimeOptions12+

PhonePC/2in1TabletTVWearable

dateTimeOptions(dateTimeOptions: Optional<DateTimeOptions>)

设置小时是否显示前导0。

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

元服务API: 从API version 12开始,该接口支持在元服务中使用。

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

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

参数:

展开
参数名 类型 必填 说明
dateTimeOptions Optional<DateTimeOptions>

设置小时是否显示前导0,只支持设置hour参数,参数值为{hour: "2-digit"}时表示显示前导0,参数值为{hour: "numeric"}时表示不显示前导0。

默认值:undefined,默认状态下,24小时制显示前导0,12小时制不显示前导0。

事件

PhonePC/2in1TabletTVWearable

除支持通用事件外,还支持以下事件:

onDateChange

PhonePC/2in1TabletTVWearable

onDateChange(event: (value: number) => void)

提供时间变化回调,该事件回调间隔为秒。

组件不可见时不回调。

非卡片中使用时,该事件回调间隔为秒。

卡片中使用时,该事件回调间隔为分钟。

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

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

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

参数:

展开
参数名 类型 必填 说明
value number Unix Time Stamp,即自1970年1月1日(UTC)起经过的秒数。

TextClockController

PhonePC/2in1TabletTVWearable

TextClock容器组件的控制器,可以将该控制器绑定到TextClock组件,通过它控制文本时钟的启动与停止。一个TextClock组件仅支持绑定一个控制器。

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

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

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

导入对象

收起
自动换行
深色代码主题
复制
  1. controller: TextClockController = new TextClockController();

constructor

PhonePC/2in1TabletTVWearable

constructor()

TextClockController的构造函数。

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

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

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

start

PhonePC/2in1TabletTVWearable

start()

启动文本时钟。使用前需先将TextClockController绑定到TextClock组件。

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

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

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

stop

PhonePC/2in1TabletTVWearable

stop()

停止文本时钟。使用前需先将TextClockController绑定到TextClock组件。

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

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

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

TextClockConfiguration12+对象说明

PhonePC/2in1TabletTVWearable

开发者需要自定义class实现ContentModifier接口。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

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

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

展开
名称 类型 只读 可选 说明
timeZoneOffset number

当前文本时钟时区偏移量。

取值范围为[-14, 12],表示东十二区到西十二区,其中负值表示东时区,正值表示西时区,比如东八区为-8。设置值为该取值范围内的浮点数时会进行取整,舍弃小数部分。当设置的值不在取值范围内时,将使用当前系统的时区偏移量。

started boolean

指示文本时钟是否启动。

true:表示启动文本时钟。

false:表示停止文本时钟。

默认值:true

timeValue number 当前文本时钟时区的UTC秒数。

示例

PhonePC/2in1TabletTVWearable

示例1(支持启停的文本样式时钟)

该示例展示了TextClock组件的基本使用方法,通过format属性设置时钟文本的格式。

点击"start TextClock"按钮,按钮回调函数会调用TextClockController启动文本时钟。点击"stop TextClock"按钮,会调用TextClockController停止文本时钟。

示例中的组件通过设置onDateChange回调函数,在文本时钟更新时,持续修改accumulateTime的内容。

收起
自动换行
深色代码主题
复制
  1. @Entry
  2. @Component
  3. struct Second {
  4. @State accumulateTime: number = 0;
  5. // 导入对象
  6. controller: TextClockController = new TextClockController();
  7. build() {
  8. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
  9. Text('Current milliseconds is ' + this.accumulateTime)
  10. .fontSize(20)
  11. // 以12小时制显示东八区的系统时间,精确到秒。
  12. TextClock({ timeZoneOffset: -8, controller: this.controller })
  13. .format('aa hh:mm:ss')
  14. .onDateChange((value: number) => {
  15. this.accumulateTime = value;
  16. })
  17. .margin(20)
  18. .fontSize(30)
  19. Button('start TextClock')
  20. .margin({ bottom: 10 })
  21. .onClick(() => {
  22. // 启动文本时钟
  23. this.controller.start();
  24. })
  25. Button('stop TextClock')
  26. .onClick(() => {
  27. // 停止文本时钟
  28. this.controller.stop();
  29. })
  30. }
  31. .width('100%')
  32. .height('100%')
  33. }
  34. }

示例2(设定文本阴影样式)

该示例通过textShadow属性设置时钟文本的阴影样式。

收起
自动换行
深色代码主题
复制
  1. @Entry
  2. @Component
  3. struct TextClockExample {
  4. @State textShadows: ShadowOptions | Array<ShadowOptions> = [{
  5. radius: 10,
  6. color: Color.Red,
  7. offsetX: 10,
  8. offsetY: 0
  9. }, {
  10. radius: 10,
  11. color: Color.Black,
  12. offsetX: 20,
  13. offsetY: 0
  14. }, {
  15. radius: 10,
  16. color: Color.Brown,
  17. offsetX: 30,
  18. offsetY: 0
  19. }, {
  20. radius: 10,
  21. color: Color.Green,
  22. offsetX: 40,
  23. offsetY: 0
  24. }, {
  25. radius: 10,
  26. color: Color.Yellow,
  27. offsetX: 100,
  28. offsetY: 0
  29. }];
  30. build() {
  31. Column({ space: 8 }) {
  32. TextClock().fontSize(50).textShadow(this.textShadows)
  33. }
  34. }
  35. }

示例3(设定自定义内容区)

该示例实现了自定义文本时钟样式的功能,自定义样式实现了一个时间选择器组件:通过文本时钟的时区偏移量与UTC秒数,来动态改变时间选择器的选中值,实现时钟效果。同时,根据文本时钟的启动状态,实现时间选择器的12小时制与24小时制的切换。

收起
自动换行
深色代码主题
复制
  1. class MyTextClockStyle implements ContentModifier<TextClockConfiguration> {
  2. currentTimeZoneOffset: number = new Date().getTimezoneOffset() / 60;
  3. title: string = '';
  4. constructor(title: string) {
  5. this.title = title;
  6. }
  7. applyContent(): WrappedBuilder<[TextClockConfiguration]> {
  8. return wrapBuilder(buildTextClock);
  9. }
  10. }
  11. @Builder
  12. function buildTextClock(config: TextClockConfiguration) {
  13. Row() {
  14. Column() {
  15. Text((config.contentModifier as MyTextClockStyle).title)
  16. .fontSize(20)
  17. .margin(20)
  18. TimePicker({
  19. // 根据UTC秒数和时区偏移量计算本地时间:config.timeValue为UTC秒数,需乘1000转为毫秒;
  20. // currentTimeZoneOffset为当前系统时区偏移量,timeZoneOffset为目标时区偏移量,
  21. // 二者之差乘以3600000得到时区调整的毫秒数
  22. selected: (new Date(config.timeValue * 1000 +
  23. ((config.contentModifier as MyTextClockStyle).currentTimeZoneOffset - config.timeZoneOffset) * 60 * 60 *
  24. 1000)),
  25. format: TimePickerFormat.HOUR_MINUTE_SECOND
  26. })
  27. .useMilitaryTime(!config.started)
  28. }
  29. }
  30. }
  31. @Entry
  32. @Component
  33. struct TextClockExample {
  34. @State accumulateTime1: number = 0;
  35. @State timeZoneOffset: number = -8;
  36. controller1: TextClockController = new TextClockController();
  37. controller2: TextClockController = new TextClockController();
  38. build() {
  39. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
  40. Text('Current milliseconds is ' + this.accumulateTime1)
  41. .fontSize(20)
  42. .margin({ top: 20 })
  43. TextClock({ timeZoneOffset: this.timeZoneOffset, controller: this.controller1 })
  44. .format('aa hh:mm:ss')
  45. .onDateChange((value: number) => {
  46. this.accumulateTime1 = value;
  47. })
  48. .margin(20)
  49. .fontSize(30)
  50. TextClock({ timeZoneOffset: this.timeZoneOffset, controller: this.controller2 })
  51. .format('aa hh:mm:ss')
  52. .fontSize(30)
  53. .contentModifier(new MyTextClockStyle('ContentModifier:'))
  54. Button('start TextClock')
  55. .margin({ top: 20, bottom: 10 })
  56. .onClick(() => {
  57. // 启动文本时钟
  58. this.controller1.start();
  59. this.controller2.start();
  60. })
  61. Button('stop TextClock')
  62. .margin({ bottom: 30 })
  63. .onClick(() => {
  64. // 停止文本时钟
  65. this.controller1.stop();
  66. this.controller2.stop();
  67. })
  68. }
  69. .width('100%')
  70. .height('100%')
  71. }
  72. }

示例4(设置前导零)

该示例演示了dateTimeOptions属性为小时字段增加或去除前导0的功能。24小时制的小时字段默认带有前导0,可通过dateTimeOptions属性去除前导0,12小时制的小时字段默认不带有前导0,可通过dateTimeOptions属性增加前导0。

收起
自动换行
深色代码主题
复制
  1. @Entry
  2. @Component
  3. struct TextClockExample {
  4. build() {
  5. Column({ space: 8 }) {
  6. Row() {
  7. Text('24小时制去除前导0:')
  8. .fontSize(20)
  9. TextClock()
  10. .fontSize(20)
  11. .format('HH:mm:ss')
  12. .dateTimeOptions({ hour: 'numeric' })
  13. }
  14. Row() {
  15. Text('12小时制增加前导0:')
  16. .fontSize(20)
  17. TextClock()
  18. .fontSize(20)
  19. .format('aa hh:mm:ss')
  20. .dateTimeOptions({ hour: '2-digit' })
  21. }
  22. }
  23. .alignItems(HorizontalAlign.Start)
  24. }
  25. }

示例5(设置文字显示样式)

该示例演示了使用fontFeaturefontColorfontStylefontWeightfontFamily属性设置时钟文字显示样式的功能。

收起
自动换行
深色代码主题
复制
  1. @Entry
  2. @Component
  3. struct Index {
  4. build() {
  5. Column() {
  6. Text('fontFeature').fontColor(0xCCCCCC)
  7. // 设置文本特性
  8. TextClock()
  9. .fontFeature('\"sinf\" off')
  10. TextClock()
  11. .fontFeature('\"sinf\" on')
  12. .margin('10%')
  13. // 设置字体颜色
  14. Text('fontColor').fontColor(0xCCCCCC)
  15. TextClock()
  16. .fontColor(Color.Black)
  17. TextClock()
  18. .fontColor(Color.Blue)
  19. .margin('10%')
  20. Text('fontStyle').fontColor(0xCCCCCC)
  21. // 设置字体样式
  22. TextClock()
  23. .fontStyle(FontStyle.Normal)
  24. TextClock()
  25. .fontStyle(FontStyle.Italic)
  26. .margin('10%')
  27. Text('fontWeight').fontColor(0xCCCCCC)
  28. // 设置字体粗细
  29. TextClock()
  30. .fontWeight(FontWeight.Normal)
  31. TextClock()
  32. .fontWeight(FontWeight.Bold)
  33. .margin('10%')
  34. Text('fontFamily').fontColor(0xCCCCCC)
  35. // 设置字体
  36. TextClock()
  37. .fontFamily('HarmonyOS Sans')
  38. }
  39. .width('100%')
  40. .height('100%')
  41. }
  42. }

在 API参考 中进行搜索
请输入您想要搜索的关键词