往期鸿蒙全套实战文章必看:(文中附带全栈鸿蒙学习资料)
@ohos.measure (文本计算)
本模块提供文本宽度、高度等相关计算。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该模块不支持在UIAbility的文件声明处使用,即不能在UIAbility的生命周期中调用,需要在创建组件实例后使用。
从API version 12开始,可以通过UIContext中的getMeasureUtils方法获取当前UI上下文关联的MeasureUtils实例
如需更多测算文本参数,建议使用图形对应测算接口Paragraph接口。
为保障时序正确,推荐需要测算文本的开发者自行监听字体缩放变化,保证测算结果的准确性。
导入模块
import { MeasureText } from '@kit.ArkUI'
MeasureText.measureText
measureText(options: MeasureOptions): number
计算指定文本的宽度。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | MeasureOptions | 是 | 被计算文本描述信息。 |
返回值:
| 类型 | 说明 |
|---|---|
| number | 文本宽度。 单位:px |
示例:
说明
推荐通过UIContext中的getMeasureUtils方法获取当前UI上下文关联的MeasureUtils实例
import { MeasureText } from '@kit.ArkUI'
@Entry
@Component
struct Index {
@State textWidth: number = MeasureText.measureText({ // 建议使用 this.getUIContext().getMeasureUtils().measureText()接口
textContent: "Hello word",
fontSize: '50px'
})
build() {
Row() {
Column() {
Text(`The width of 'Hello World': ${this.textWidth}`)
}
.width('100%')
}
.height('100%')
}
}
MeasureText.measureTextSize10+
measureTextSize(options: MeasureOptions): SizeOptions
计算指定文本的宽度和高度。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | MeasureOptions | 是 | 被计算文本描述信息。 |
返回值:
| 类型 | 说明 |
|---|---|
| SizeOptions | 返回文本所占布局宽度和高度。 说明: 文本宽度以及高度返回值单位均为px。 |
示例:
说明
推荐通过UIContext中的getMeasureUtils方法获取当前UI上下文关联的MeasureUtils实例
import { MeasureText } from '@kit.ArkUI'
@Entry
@Component
struct Index {
textSize : SizeOptions = MeasureText.measureTextSize({ // 建议使用 this.getUIContext().getMeasureUtils().measureText()接口
textContent: "Hello word",
fontSize: '50px'
})
build() {
Row() {
Column() {
Text(`The width of 'Hello World': ${this.textSize.width}`)
Text(`The height of 'Hello World': ${this.textSize.height}`)
}
.width('100%')
}
.height('100%')
}
}
MeasureOptions
被计算文本属性。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| textContent | string | Resource | 是 | 设置被计算文本内容。 |
| constraintWidth10+ | number | string | Resource | 否 | 设置被计算文本布局宽度。 说明: 默认单位为vp,不支持设置百分比字符串。若不设置,则文本SizeOption宽度为单行布局所占最大宽度值,若设置则为设置值。 |
| fontSize | number | string | Resource | 否 | 设置被计算文本字体大小,fontSize为number类型时,使用vp单位。 默认值:16 说明: 不支持设置百分比字符串。 从API version 12开始,fontSize为number类型时,使用fp单位。 |
| fontStyle | number | FontStyle | 否 | 设置被计算文本字体样式。 默认值:FontStyle.Normal |
| fontWeight | number | string | FontWeight | 否 | 设置被计算文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。string类型仅支持number类型取值的字符串形式,例如"400",以及"bold"、"bolder"、"lighter"、"regular"、"medium",分别对应FontWeight中相应的枚举值。 默认值:FontWeight.Normal |
| fontFamily | string | Resource | 否 | 设置被计算文本字体列表。默认字体'HarmonyOS Sans',且当前只支持这种字体。 |
| letterSpacing | number | string | 否 | 设置被计算文本字符间距。 |
| textAlign10+ | number | TextAlign | 否 | 设置被计算文本水平方向的对齐方式。 默认值:TextAlign.Start |
| overflow10+ | number | TextOverflow | 否 | 设置被计算文本超长时的截断方式。 |
| maxLines10+ | number | 否 | 设置被计算文本最大行数。 |
| lineHeight10+ | number | string | Resource | 否 | 设置被计算文本行高。 |
| baselineOffset10+ | number | string | 否 | 设置被计算文本基线的偏移量。 默认值:0 |
| textCase10+ | number | TextCase | 否 | 设置被计算文本大小写。 默认值:TextCase.Normal |
| textIndent11+ | number | string | 否 | 设置首行文本缩进,默认值0。 |
| wordBreak11+ | WordBreak | 否 | 设置断行规则。 默认值:WordBreak.BREAK_WORD 说明: WordBreak.BREAK_ALL与{overflow: TextOverflow.Ellipsis},maxLines组合使用可实现英文单词按字母截断,超出部分以省略号显示。 |
鸿蒙5.0开发:@ohos.measure文本计算



被折叠的 条评论
为什么被折叠?



