1# @ohos.measure (文本计算) 2 3本模块提供文本宽度、高度等相关计算。 4 5> **说明** 6> 7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 9> 该模块不支持在[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)的文件声明处使用，即不能在UIAbility的生命周期中调用，需要在创建组件实例后使用。 10> 11> 从API version 12开始，可以通过UIContext中的getMeasureUtils方法获取当前UI上下文关联的[MeasureUtils](js-apis-arkui-UIContext.md#measureutils12)实例 12> 13> 如需更多测算文本参数，建议使用图形对应测算接口[Paragraph](../apis-arkgraphics2d/js-apis-graphics-text.md#paragraph)接口。 14> 15> 为保障时序正确，推荐需要测算文本的开发者自行监听字体缩放变化，保证测算结果的准确性。 16 17## 导入模块 18 19```ts 20import { MeasureText } from '@kit.ArkUI' 21``` 22 23## MeasureText.measureText 24 25measureText(options: MeasureOptions): number 26 27计算指定文本的宽度。 28 29**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 30 31**系统能力：** SystemCapability.ArkUI.ArkUI.Full 32 33**参数：** 34 35| 参数名 | 类型 | 必填 | 说明 | 36| ------- | ------------------------------- | ---- | --------- | 37| options | [MeasureOptions](#measureoptions) | 是 | 被计算文本描述信息。 | 38 39**返回值：** 40 41| 类型 | 说明 | 42| ------------ | --------- | 43| number | 文本宽度。<br/>单位：px | 44 45 46**示例：** 47 48> **说明** 49> 50>推荐通过[UIContext](js-apis-arkui-UIContext.md#uicontext)中的[getMeasureUtils](./js-apis-arkui-UIContext.md#getmeasureutils12)方法获取当前UI上下文关联的[MeasureUtils](js-apis-arkui-UIContext.md#measureutils12)实例 51 52```ts 53import { MeasureText } from '@kit.ArkUI' 54 55@Entry 56@Component 57struct Index { 58 @State textWidth: number = MeasureText.measureText({ // 建议使用 this.getUIContext().getMeasureUtils().measureText()接口 59 textContent: "Hello word", 60 fontSize: '50px' 61 }) 62 63 build() { 64 Row() { 65 Column() { 66 Text(`The width of 'Hello World': ${this.textWidth}`) 67 } 68 .width('100%') 69 } 70 .height('100%') 71 } 72} 73``` 74 75## MeasureText.measureTextSize<sup>10+</sup> 76 77measureTextSize(options: MeasureOptions): SizeOptions 78 79计算指定文本的宽度和高度。 80 81**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 82 83**系统能力：** SystemCapability.ArkUI.ArkUI.Full 84 85**参数：** 86 87| 参数名 | 类型 | 必填 | 说明 | 88| ------- | ------------------------------- | ---- | --------- | 89| options | [MeasureOptions](#measureoptions) | 是 | 被计算文本描述信息。 | 90 91**返回值：** 92 93| 类型 | 说明 | 94| ------------ | --------- | 95| [SizeOptions](arkui-ts/ts-types.md#sizeoptions) | 返回文本所占布局宽度和高度。<br/>**说明:** <br/>文本宽度以及高度返回值单位均为px。 | 96 97 98**示例：** 99 100> **说明** 101> 102>推荐通过[UIContext](js-apis-arkui-UIContext.md#uicontext)中的[getMeasureUtils](./js-apis-arkui-UIContext.md#getmeasureutils12)方法获取当前UI上下文关联的[MeasureUtils](js-apis-arkui-UIContext.md#measureutils12)实例 103 104```ts 105import { MeasureText } from '@kit.ArkUI' 106 107@Entry 108@Component 109struct Index { 110 textSize : SizeOptions = MeasureText.measureTextSize({ // 建议使用 this.getUIContext().getMeasureUtils().measureText()接口 111 textContent: "Hello word", 112 fontSize: '50px' 113 }) 114 build() { 115 Row() { 116 Column() { 117 Text(`The width of 'Hello World': ${this.textSize.width}`) 118 Text(`The height of 'Hello World': ${this.textSize.height}`) 119 } 120 .width('100%') 121 } 122 .height('100%') 123 } 124} 125``` 126 127## MeasureOptions 128 129被计算文本属性。 130 131**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 132 133**系统能力：** SystemCapability.ArkUI.ArkUI.Full 134 135| 名称 | 类型 | 必填 | 说明 | 136| -------------- | -------------------------------------------------------------------------------------------------- | ---- | ----------------------------------------------- | 137| textContent | string \| [Resource](arkui-ts/ts-types.md#resource) | 是 | 设置被计算文本内容。 | 138| constraintWidth<sup>10+</sup> | number \| string \| [Resource](arkui-ts/ts-types.md#resource) | 否 | 设置被计算文本布局宽度。<br/>**说明：** <br/>默认单位为vp，不支持设置百分比字符串。若不设置，则文本SizeOption宽度为单行布局所占最大宽度值，若设置则为设置值。 | 139| fontSize | number \| string \| [Resource](arkui-ts/ts-types.md#resource) | 否 | 设置被计算文本字体大小，fontSize为number类型时，使用vp单位。<br/>默认值：16<br/>**说明：** <br/>不支持设置百分比字符串。<br/>从API version 12开始，fontSize为number类型时，使用fp单位。 | 140| fontStyle | number \| [FontStyle](arkui-ts/ts-appendix-enums.md#fontstyle) | 否 | 设置被计算文本字体样式。<br>默认值：FontStyle.Normal | 141| fontWeight | number \| string \| [FontWeight](arkui-ts/ts-appendix-enums.md#fontweight) | 否 | 设置被计算文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。string类型仅支持number类型取值的字符串形式，例如"400"，以及"bold"、"bolder"、"lighter"、"regular"、"medium"，分别对应FontWeight中相应的枚举值。<br/>默认值：FontWeight.Normal| 142| fontFamily | string \| [Resource](arkui-ts/ts-types.md#resource) | 否 | 设置被计算文本字体列表。默认字体'HarmonyOS Sans'，且当前只支持这种字体。| 143| letterSpacing | number \| string | 否 | 设置被计算文本字符间距。| 144| textAlign<sup>10+</sup> | number \| [TextAlign](arkui-ts/ts-appendix-enums.md#textalign) | 否 | 设置被计算文本水平方向的对齐方式。<br/>默认值：TextAlign.Start| 145| overflow<sup>10+</sup> | number \| [TextOverflow](arkui-ts/ts-appendix-enums.md#textoverflow) | 否 | 设置被计算文本超长时的截断方式。| 146| maxLines<sup>10+</sup> | number | 否 | 设置被计算文本最大行数。| 147| lineHeight<sup>10+</sup> | number \| string \| [Resource](arkui-ts/ts-types.md#resource) | 否 | 设置被计算文本行高。| 148| baselineOffset<sup>10+</sup> | number \| string | 否 | 设置被计算文本基线的偏移量。<br />默认值：0 | 149| textCase<sup>10+</sup> | number \| [TextCase](arkui-ts/ts-appendix-enums.md#textcase) | 否 | 设置被计算文本大小写。<br />默认值：TextCase.Normal | 150| textIndent<sup>11+</sup> | number \| string | 否 | 设置首行文本缩进，默认值0。 | 151| wordBreak<sup>11+</sup> | [WordBreak](arkui-ts/ts-appendix-enums.md#wordbreak11) | 否 | 设置断行规则。 <br />默认值：WordBreak.BREAK_WORD <br/>**说明：** <br/>WordBreak.BREAK_ALL与{overflow: TextOverflow.Ellipsis}，`maxLines`组合使用可实现英文单词按字母截断，超出部分以省略号显示。 |