HarmonyOS API：@ohos.i18n (国际化-I18n)

joytrian

发布于 2023-4-4 16:03

浏览

0收藏

版本：v3.1 Beta

@ohos.i18n (国际化-I18n)

更新时间: 2023-02-17 09:19

本模块提供系统相关的或者增强的国际化能力，包括区域管理、电话号码处理、日历等，相关接口为ECMA 402标准中未定义的补充接口。

Intl模块提供了ECMA 402标准定义的基础国际化接口，与本模块共同使用可提供完整地国际化支持能力。

说明

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
I18N模块包含国际化能力增强接口（未在ECMA 402中定义），包括区域管理、电话号码处理、日历等，国际化基础能力请参考Intl模块。

导入模块

import I18n from '@ohos.i18n';1.

System⁹⁺

getDisplayCountry⁹⁺

static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string

获取指定国家的本地化显示文本。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
country	string	是	指定国家。
locale	string	是	显示指定国家的区域ID。
sentenceCase	boolean	否	本地化显示文本是否要首字母大写。

返回值：

类型	说明
string	指定国家的本地化显示文本。

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

错误码ID	错误信息
890001	Unspported para value.

示例：

try {
  let displayCountry = I18n.System.getDisplayCountry("zh-CN", "en-GB");
} catch(error) {
  console.error(`call System.getDisplayCountry failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.

getDisplayLanguage⁹⁺

static getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string

获取指定语言的本地化显示文本。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
language	string	是	指定语言。
locale	string	是	显示指定语言的区域ID。
sentenceCase	boolean	否	本地化显示文本是否要首字母大写。

返回值：

类型	说明
string	指定语言的本地化显示文本。

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

错误码ID	错误信息
890001	Unspported para value.

示例：

try {
  let displayLanguage = I18n.System.getDisplayLanguage("zh", "en-GB");
} catch(error) {
  console.error(`call System.getDisplayLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.

i18n.isRTL⁷⁺

isRTL(locale: string): boolean

获取是否为从右至左显示语言。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	是	指定区域ID。

返回值：

类型	说明
boolean	true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。

示例：

I18n.isRTL("zh-CN");// 中文不是RTL语言，返回false
I18n.isRTL("ar-EG");// 阿语是RTL语言，返回true1.
2.

i18n.getCalendar⁸⁺

getCalendar(locale: string, type? : string): Calendar

获取日历对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	是	合法的locale值，例如zh-Hans-CN。
type	string	否	合法的日历类型，目前合法的类型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。当type没有给出时，采用区域默认的日历类型。

返回值：

类型	说明
Calendar	日历对象。

示例：

I18n.getCalendar("zh-Hans", "chinese"); // Obtain the Calendar object for the Chinese lunar calendar.1.

Calendar⁸⁺

setTime⁸⁺

setTime(date: Date): void

设置日历对象内部的时间日期。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
date	Date	是	将要设置的日历对象的内部时间日期。

示例：

let calendar = I18n.getCalendar("en-US", "gregory");
let date = new Date(2021, 10, 7, 8, 0, 0, 0);
calendar.setTime(date);1.
2.
3.

setTime⁸⁺

setTime(time: number): void

设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
time	number	是	time为从1970.1.1 00:00:00 GMT逝去的毫秒数。

示例：

let calendar = I18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000);1.
2.

set⁸⁺

set(year: number, month: number, date:number, hour?: number, minute?: number, second?: number): void

设置日历对象的年、月、日、时、分、秒。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
year	number	是	设置的年。
month	number	是	设置的月。
date	number	是	设置的日。
hour	number	否	设置的小时。
minute	number	否	设置的分钟。
second	number	否	设置的秒。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:001.
2.

setTimeZone⁸⁺

setTimeZone(timezone: string): void

设置日历对象的时区。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
timezone	string	是	设置的时区id，如“Asia/Shanghai”。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");1.
2.

getTimeZone⁸⁺

getTimeZone(): string

获取日历对象的时区。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
string	日历对象的时区id。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
let timezone = calendar.getTimeZone(); // timezone = "Asia/Shanghai"1.
2.
3.

getFirstDayOfWeek⁸⁺

getFirstDayOfWeek(): number

获取日历对象的一周起始日。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	获取一周的起始日，1代表周日，7代表周六。

示例：

let calendar = I18n.getCalendar("en-US", "gregory");
let firstDayOfWeek = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 11.
2.

setFirstDayOfWeek⁸⁺

setFirstDayOfWeek(value: number): void

设置每一周的起始日。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
value	number	是	设置一周的起始日，1代表周日，7代表周六。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(3);
let firstDayOfWeek = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 31.
2.
3.

getMinimalDaysInFirstWeek⁸⁺

getMinimalDaysInFirstWeek(): number

获取一年中第一周的最小天数。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	一年中第一周的最小天数。

示例：

let calendar = I18n.getCalendar("zh-Hans");
let minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 11.
2.

setMinimalDaysInFirstWeek⁸⁺

setMinimalDaysInFirstWeek(value: number): void

设置一年中第一周的最小天数。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
value	number	是	一年中第一周的最小天数。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3);
let minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 31.
2.
3.

get⁸⁺

get(field: string): number

获取日历对象中与field相关联的值。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
field	string	是	通过field来获取日历对象相应的值。目前支持的field值有 era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week, day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month。

返回值：

类型	说明
number	与field相关联的值，如当前Calendar对象的内部日期的年份为1990，get("year")返回1990。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
let hourOfDay = calendar.get("hour_of_day"); // hourOfDay = 81.
2.
3.

getDisplayName⁸⁺

getDisplayName(locale: string): string

获取日历对象在locale所指定的区域的名字。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	是	locale指定获取哪个区域下该calendar的名字，如buddhist在en-US上显示的名称为“Buddhist Calendar”。

返回值：

类型	说明
string	日历在locale所指示的区域的名字。

示例：

let calendar = I18n.getCalendar("en-US", "buddhist");
let calendarName = calendar.getDisplayName("zh"); // calendarName = "佛历"1.
2.

isWeekend⁸⁺

isWeekend(date?: Date): boolean

判断给定的日期是否在日历中是周末。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
date	Date	否	判断日期在日历中是否是周末。如果date没有给出，判断calendar当前日期是否为周末。

返回值：

类型	说明
boolean	当所判断的日期为周末时，返回 true，否则返回false。

示例：

let calendar = I18n.getCalendar("zh-Hans");
calendar.set(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
calendar.isWeekend(); // false
let date = new Date(2011, 11, 6, 9, 0, 0);
calendar.isWeekend(date); // true1.
2.
3.
4.
5.

PhoneNumberFormat⁸⁺

constructor⁸⁺

constructor(country: string, options?: PhoneNumberFormatOptions)

创建电话号码格式化对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
country	string	是	表示电话号码所属国家或地区代码。
options	PhoneNumberFormatOptions	否	电话号码格式化对象的相关选项。

示例：

let phoneNumberFormat= new I18n.PhoneNumberFormat("CN", {"type": "E164"});1.

isValidNumber⁸⁺

isValidNumber(number: string): boolean

判断传入的电话号码格式是否正确。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
number	string	是	待判断的电话号码。

返回值：

类型	说明
boolean	返回true表示电话号码的格式正确，返回false表示电话号码的格式错误。

示例：

let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
let isValidNumber = phonenumberfmt.isValidNumber("15812312312"); // isValidNumber = true1.
2.

format⁸⁺

format(number: string): string

对电话号码进行格式化。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
number	string	是	待格式化的电话号码。

返回值：

类型	说明
string	格式化后的电话号码。

示例：

let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
let formattedPhoneNumber = phonenumberfmt.format("15812312312"); // formattedPhoneNumber = "158 1231 2312"1.
2.

getLocationName⁹⁺

getLocationName(number: string, locale: string): string

获取电话号码归属地。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
number	string	是	电话号码
locale	string	是	区域ID

返回值：

类型	说明
string	电话号码归属地。

示例：

let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
let locationName = phonenumberfmt.getLocationName("15812312345", "zh-CN"); // locationName = "广东省湛江市"1.
2.

PhoneNumberFormatOptions⁹⁺

表示电话号码格式化对象可设置的属性。

系统能力：SystemCapability.Global.I18n

名称	类型	可读	可写	说明
type	string	是	是	表示对电话号码格式化的类型，取值范围："E164", "INTERNATIONAL", "NATIONAL", "RFC3966"。

UnitInfo⁸⁺

度量衡单位信息。

系统能力：SystemCapability.Global.I18n

名称	类型	可读	可写	说明
unit	string	是	是	单位的名称，如："meter", "inch", "cup"等。
measureSystem	string	是	是	单位的度量体系，取值包括："SI", "US", "UK"。

getInstance⁸⁺

getInstance(locale?:string): IndexUtil

创建并返回IndexUtil对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	否	包含区域设置信息的字符串，包括语言以及可选的脚本和区域。

返回值：

类型	说明
IndexUtil	locale对应的IndexUtil对象。

示例：

let indexUtil= I18n.getInstance("zh-CN");1.

IndexUtil⁸⁺

getIndexList⁸⁺

getIndexList(): Array<string>

获取当前locale对应的索引列表。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
Array<string>	返回当前locale对应的索引列表。

示例：

let indexUtil = I18n.getInstance("zh-CN");
// indexList = [ "...", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N",
//              "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "..." ]
let indexList = indexUtil.getIndexList();1.
2.
3.
4.

addLocale⁸⁺

addLocale(locale: string): void

将新的locale对应的索引加入当前索引列表。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	是	包含区域设置信息的字符串，包括语言以及可选的脚本和区域。

示例：

let indexUtil = I18n.getInstance("zh-CN");
indexUtil.addLocale("en-US");1.
2.

getIndex⁸⁺

getIndex(text: string): string

获取text对应的索引。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
text	string	是	待计算索引值的输入文本。

返回值：

类型	说明
string	输入文本对应的索引值。

示例：

let indexUtil= I18n.getInstance("zh-CN");
let index = indexUtil.getIndex("hi");  // index = "H"1.
2.

i18n.getLineInstance⁸⁺

getLineInstance(locale: string): BreakIterator

获取一个用于断句的BreakIterator对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	是	合法的locale值，例如zh-Hans-CN。生成的BreakIterator将按照locale所指定的区域的规则来进行断句。

返回值：

类型	说明
BreakIterator	用于进行断句的处理器。

示例：

let iterator = I18n.getLineInstance("en");1.

BreakIterator⁸⁺

setLineBreakText⁸⁺

setLineBreakText(text: string): void

设置BreakIterator要处理的文本。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
text	string	是	指定BreakIterator进行断句的文本。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); // 设置短句文本1.
2.

getLineBreakText⁸⁺

getLineBreakText(): string

获取BreakIterator当前处理的文本。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
string	BreakIterator对象正在处理的文本

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let breakText = iterator.getLineBreakText(); // breakText = "Apple is my favorite fruit."1.
2.
3.

current⁸⁺

current(): number

获取BreakIterator对象在当前处理的文本中的位置。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	BreakIterator在当前所处理的文本中的位置。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let currentPos = iterator.current(); // currentPos = 01.
2.
3.

first⁸⁺

first(): number

将BreakIterator对象设置到第一个可断句的分割点。第一个分割点总是被处理的文本的起始位置。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	被处理文本的第一个分割点的偏移量。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let firstPos = iterator.first(); // firstPos = 01.
2.
3.

last⁸⁺

last(): number

将BreakIterator对象的位置设置到最后一个可断句的分割点。最后一个分割点总是被处理文本末尾的下一个位置。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	被处理的文本的最后一个分割点的偏移量

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let lastPos = iterator.last(); // lastPos = 271.
2.
3.

next⁸⁺

next(index?: number): number

如果index给出，并且index是一个正数将BreakIterator向后移动number个可断句的分割点，如果n是一个负数，向前移动相应个分割点。若index没有给出，则相当于index = 1。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
index	number	否	BreakIterator将要移动的分割点数，正数代表向后移动，负数代表向前移动。若index没有给出，则按照index=1处理。

返回值：

类型	说明
number	返回移动了index个分割点后，当前BreakIterator在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let pos = iterator.first(); // pos = 0
pos = iterator.next(); // pos = 6
pos = iterator.next(10); // pos = -11.
2.
3.
4.
5.

previous⁸⁺

previous(): number

将BreakIterator移动到前一个分割点处。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	返回移动到前一个分割点后，当前BreakIterator在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let pos = iterator.first(); // pos = 0
pos = iterator.next(3); // pos = 12
pos = iterator.previous(); // pos = 91.
2.
3.
4.
5.

following⁸⁺

following(offset: number): number

将BreakIterator设置到由offset指定的位置的后面一个分割点。返回移动后BreakIterator的位置。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
offset	number	是	将BreakIterator对象的位置设置到由offset所指定的位置的下一个分割点。

返回值：

类型	说明
number	返回BreakIterator移动后的位置，如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let pos = iterator.following(0); // pos = 6
pos = iterator.following(100); // pos = -1
pos = iterator.current(); // pos = 271.
2.
3.
4.
5.

isBoundary⁸⁺

isBoundary(offset: number): boolean

如果offset所指定的文本位置是一个分割点，那么返回true，否则返回false。如果返回true, 将BreakIterator对象设置到offset所指定的位置, 否则相当于调用following(offset)。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
offset	number	是	指定需要进行判断的位置

返回值：

类型	说明
boolean	如果是一个分割点返回true, 否则返回false。

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
let isBoundary = iterator.isBoundary(0); // isBoundary = true;
isBoundary = iterator.isBoundary(5); // isBoundary = false;1.
2.
3.
4.

i18n.getTimeZone⁷⁺

getTimeZone(zoneID?: string): TimeZone

获取时区ID对应的时区对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
zondID	string	否	时区ID。

返回值：

类型	说明
TimeZone	时区ID对应的时区对象。

示例：

let timezone = I18n.getTimeZone();1.

TimeZone

getID

getID(): string

获取时区对象的ID。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
string	时区对象对应的时区ID。

示例：

let timezone = I18n.getTimeZone();
let timezoneID = timezone.getID(); // timezoneID = "Asia/Shanghai"1.
2.

getDisplayName

getDisplayName(locale?: string, isDST?: boolean): string

获取时区对象在指定区域的表示。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	否	区域ID。
isDST	boolean	否	表示获取时区对象的表示时是否考虑夏令时。

返回值：

类型	说明
string	时区对象在指定区域的表示。

示例：

let timezone = I18n.getTimeZone();
let timezoneName = timezone.getDisplayName("zh-CN", false); // timezoneName = "中国标准时间"1.
2.

getRawOffset

getRawOffset(): number

获取时区对象表示的时区与UTC时区的偏差。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	时区对象表示的时区与UTC时区的偏差。

示例：

let timezone = I18n.getTimeZone();
let offset = timezone.getRawOffset(); // offset = 288000001.
2.

getOffset

getOffset(date?: number): number

获取某一时刻时区对象表示的时区与UTC时区的偏差。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
number	某一时刻时区对象表示的时区与UTC时区的偏差。

示例：

let timezone = I18n.getTimeZone();
let offset = timezone.getOffset(1234567890); // offset = 288000001.
2.

getAvailableIDs⁹⁺

static getAvailableIDs(): Array<string>

获取系统支持的时区ID。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
Array<string>	系统支持的时区ID列表

示例：

// ids = ["America/Adak", "America/Anchorage", "America/Bogota", "America/Denver", "America/Los_Angeles", "America/Montevideo", "America/Santiago", "America/Sao_Paulo", "Asia/Ashgabat", "Asia/Hovd", "Asia/Jerusalem", "Asia/Magadan", "Asia/Omsk", "Asia/Shanghai", "Asia/Tokyo", "Asia/Yerevan", "Atlantic/Cape_Verde", "Australia/Lord_Howe", "Europe/Dublin", "Europe/London", "Europe/Moscow", "Pacific/Auckland", "Pacific/Easter", "Pacific/Pago-Pago"], 当前共支持24个时区
let ids = I18n.TimeZone.getAvailableIDs();1.
2.

getAvailableZoneCityIDs⁹⁺

static getAvailableZoneCityIDs(): Array<string>

获取系统支持的时区城市ID。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
Array<string>	系统支持的时区城市ID列表

示例：

// cityIDs = ["Auckland", "Magadan", "Lord Howe Island", "Tokyo", "Shanghai", "Hovd", "Omsk", "Ashgabat", "Yerevan", "Moscow", "Tel Aviv", "Dublin", "London", "Praia", "Montevideo", "Brasília", "Santiago", "Bogotá", "Easter Island", "Salt Lake City", "Los Angeles", "Anchorage", "Adak", "Pago Pago"]，当前共支持24个时区城
let cityIDs = I18n.TimeZone.getAvailableZoneCityIDs();1.
2.

getCityDisplayName⁹⁺

static getCityDisplayName(cityID: string, locale: string): string

获取某时区城市在locale下的本地化显示。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
cityID	string	是	时区城市ID
locale	string	是	区域ID

返回值：

类型	说明
string	时区城市在locale下的本地化显示

示例：

let displayName = I18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN"); // displayName = "上海(中国)"1.

getTimezoneFromCity⁹⁺

static getTimezoneFromCity(cityID: string): TimeZone

创建某时区城市对应的时区对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
cityID	string	是	时区城市ID

返回值：

类型	说明
TimeZone	时区城市对应的时区对象

示例：

let timezone = I18n.TimeZone.getTimezoneFromCity("Shanghai");1.

Transliterator⁹⁺

getAvailableIDs⁹⁺

static getAvailableIDs(): string[]

获取音译支持的ID列表。

系统能力：SystemCapability.Global.I18n

返回值：

类型	说明
string[]	音译支持的ID列表。

示例：

// ids = ["ASCII-Latin", "Accents-Any", "Amharic-Latin/BGN", ...]，共支持671个id
// 每一个id由使用中划线分割的两部分组成，格式为 source-destination
let ids = I18n.Transliterator.getAvailableIDs();1.
2.
3.

getInstance⁹⁺

static getInstance(id: string): Transliterator

创建音译对象。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
id	string	是	音译支持的ID。

返回值：

类型	说明
Transliterator	音译对象。

示例：

let transliterator = I18n.Transliterator.getInstance("Any-Latn");1.

transform⁹⁺

transform(text: string): string

将输入字符串从源格式转换为目标格式。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
text	string	是	输入字符串。

返回值：

类型	说明
string	转换后的字符串。

示例：

let transliterator = I18n.Transliterator.getInstance("Any-Latn");
let res = transliterator.transform("中国"); // res = "zhōng guó"1.
2.

Unicode⁹⁺

isDigit⁹⁺

static isDigit(char: string): boolean

判断字符串char是否是数字。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是数字，返回false表示输入的字符不是数字。

示例：

let isdigit = I18n.Unicode.isDigit("1");  // isdigit = true1.

isSpaceChar⁹⁺

static isSpaceChar(char: string): boolean

判断字符串char是否是空格符。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。

示例：

let isspacechar = I18n.Unicode.isSpaceChar("a");  // isspacechar = false1.

isWhitespace⁹⁺

static isWhitespace(char: string): boolean

判断字符串char是否是空白符。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。

示例：

let iswhitespace = I18n.Unicode.isWhitespace("a");  // iswhitespace = false1.

isRTL⁹⁺

static isRTL(char: string): boolean

判断字符串char是否是从右到左语言的字符。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。

示例：

let isrtl = I18n.Unicode.isRTL("a");  // isrtl = false1.

isIdeograph⁹⁺

static isIdeograph(char: string): boolean

判断字符串char是否是表意文字。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。

示例：

let isideograph = I18n.Unicode.isIdeograph("a");  // isideograph = false1.

isLetter⁹⁺

static isLetter(char: string): boolean

判断字符串char是否是字母。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是字母，返回false表示输入的字符不是字母。

示例：

let isletter = I18n.Unicode.isLetter("a");  // isletter = true1.

isLowerCase⁹⁺

static isLowerCase(char: string): boolean

判断字符串char是否是小写字母。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。

示例：

let islowercase = I18n.Unicode.isLowerCase("a");  // islowercase = true1.

isUpperCase⁹⁺

static isUpperCase(char: string): boolean

判断字符串char是否是大写字母。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。

示例：

let isuppercase = I18n.Unicode.isUpperCase("a");  // isuppercase = false1.

getType⁹⁺

static getType(char: string): string

获取输入字符串的一般类别值。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
string	输入字符的一般类别值。

示例：

let type = I18n.Unicode.getType("a"); // type = "U_LOWERCASE_LETTER"1.

I18NUtil⁹⁺

unitConvert⁹⁺

static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string

将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
fromUnit	UnitInfo	是	要被转换的单位。
toUnit	UnitInfo	是	要转换为的单位。
value	number	是	要被转换的单位的数量值。
locale	string	是	格式化时使用的区域参数，如：zh-Hans-CN。
style	string	否	格式化使用的风格，取值包括："long", "short", "narrow"。

返回值：

类型	说明
string	按照toUnit的单位格式化后，得到的字符串。

示例：

let res = I18n.I18NUtil.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); // res = 236.588 liters1.

getDateOrder⁹⁺

static getDateOrder(locale: string): string

获取某一区域的日期的年、月、日排列顺序。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
locale	string	是	格式化时使用的区域参数，如：zh-Hans-CN。

返回值：

类型	说明
string	返回某一区域的日期的年、月、日排列顺序

示例：

let order = I18n.I18NUtil.getDateOrder("zh-CN");  // order = "y-L-d"1.

i18n.getDisplayCountry^(deprecated)

getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string

获取指定国家的本地化显示文本。

从API version 9开始不再维护，建议使用System.getDisplayCountry代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
country	string	是	指定国家。
locale	string	是	显示指定国家的区域ID。
sentenceCase	boolean	否	本地化显示文本是否要首字母大写。

返回值：

类型	说明
string	指定国家的本地化显示文本。

示例：

let countryName = I18n.getDisplayCountry("zh-CN", "en-GB", true); // countryName = true
countryName = I18n.getDisplayCountry("zh-CN", "en-GB"); // countryName = true1.
2.

i18n.getDisplayLanguage^(deprecated)

getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string

获取指定语言的本地化显示文本。

从API version 9开始不再维护，建议使用System.getDisplayLanguage代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
language	string	是	指定语言。
locale	string	是	显示指定语言的区域ID。
sentenceCase	boolean	否	本地化显示文本是否要首字母大写。

返回值：

类型	说明
string	指定语言的本地化显示文本。

示例：

let languageName = I18n.getDisplayLanguage("zh", "en-GB", true); // languageName = "Chinese"
languageName = I18n.getDisplayLanguage("zh", "en-GB"); // languageName = "Chinese"1.
2.

Util^(deprecated)

unitConvert^(deprecated)

static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string

将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。

从API version 8开始支持，从API version 9开始不再维护，建议使用unitConvert代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
fromUnit	UnitInfo	是	要被转换的单位。
toUnit	UnitInfo	是	要转换为的单位。
value	number	是	要被转换的单位的数量值。
locale	string	是	格式化时使用的区域参数，如：zh-Hans-CN。
style	string	否	格式化使用的风格，取值包括："long", "short", "narrow"。

返回值：

类型	说明
string	按照toUnit的单位格式化后，得到的字符串。

Character^(deprecated)

isDigit^{(deprecated)+}

static isDigit(char: string): boolean

判断字符串char是否是数字。

从API version 8开始支持，从API version 9开始不再维护，建议使用isDigit代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是数字，返回false表示输入的字符不是数字。

isSpaceChar^(deprecated)

static isSpaceChar(char: string): boolean

判断字符串char是否是空格符。

从API version 8开始支持，从API version 9开始不再维护，建议使用isSpaceChar代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。

isWhitespace^(deprecated)

static isWhitespace(char: string): boolean

判断字符串char是否是空白符。

从API version 8开始支持，从API version 9开始不再维护，建议使用isWhitespace代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。

isRTL^(deprecated)

static isRTL(char: string): boolean

判断字符串char是否是从右到左语言的字符。

从API version 8开始支持，从API version 9开始不再维护，建议使用isRTL代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。

isIdeograph^(deprecated)

static isIdeograph(char: string): boolean

判断字符串char是否是表意文字。

从API version 8开始支持，从API version 9开始不再维护，建议使用isIdeograph代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。

isLetter^(deprecated)

static isLetter(char: string): boolean

判断字符串char是否是字母。

从API version 8开始支持，从API version 9开始不再维护，建议使用isLetter代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是字母，返回false表示输入的字符不是字母。

isLowerCase^(deprecated)

static isLowerCase(char: string): boolean

判断字符串char是否是小写字母。

从API version 8开始支持，从API version 9开始不再维护，建议使用isLowerCase代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。

isUpperCase^(deprecated)

static isUpperCase(char: string): boolean

判断字符串char是否是大写字母。

从API version 8开始支持，从API version 9开始不再维护，建议使用isUpperCase代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
boolean	返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。

getType^(deprecated)

static getType(char: string): string

获取输入字符串的一般类别值。

从API version 8开始支持，从API version 9开始不再维护，建议使用getType代替。

系统能力：SystemCapability.Global.I18n

参数：

参数名	类型	必填	说明
char	string	是	输入字符。

返回值：

类型	说明
string	输入字符的一般类别值。

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-i18n-0000001455863530-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001455863530__导入模块

分类

卡片开发

三方库

标签

HarmonyOS API

已于2023-4-4 16:03:36修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@ohos.i18n (国际化-I18n)

@ohos.i18n (国际化-I18n)

导入模块

System9+

getDisplayCountry9+

getDisplayLanguage9+

i18n.isRTL7+

i18n.getCalendar8+

Calendar8+

setTime8+

setTime8+

set8+

setTimeZone8+

getTimeZone8+

getFirstDayOfWeek8+

setFirstDayOfWeek8+

getMinimalDaysInFirstWeek8+

setMinimalDaysInFirstWeek8+

get8+

getDisplayName8+

isWeekend8+

PhoneNumberFormat8+

constructor8+

isValidNumber8+

format8+

getLocationName9+

PhoneNumberFormatOptions9+

UnitInfo8+

getInstance8+

IndexUtil8+

getIndexList8+

addLocale8+

getIndex8+

i18n.getLineInstance8+

BreakIterator8+

setLineBreakText8+

getLineBreakText8+

current8+

first8+

last8+

next8+

previous8+

following8+

isBoundary8+

i18n.getTimeZone7+

TimeZone

getID

getDisplayName

getRawOffset

getOffset

getAvailableIDs9+

getAvailableZoneCityIDs9+

getCityDisplayName9+

getTimezoneFromCity9+

Transliterator9+

getAvailableIDs9+

getInstance9+

transform9+

Unicode9+

isDigit9+

isSpaceChar9+

isWhitespace9+

isRTL9+

isIdeograph9+

isLetter9+

isLowerCase9+

isUpperCase9+

getType9+

I18NUtil9+

unitConvert9+

getDateOrder9+

i18n.getDisplayCountry(deprecated)

i18n.getDisplayLanguage(deprecated)

Util(deprecated)

unitConvert(deprecated)

Character(deprecated)

isDigit(deprecated)+

System⁹⁺

getDisplayCountry⁹⁺

getDisplayLanguage⁹⁺

i18n.isRTL⁷⁺

i18n.getCalendar⁸⁺

Calendar⁸⁺

setTime⁸⁺

setTime⁸⁺

set⁸⁺

setTimeZone⁸⁺

getTimeZone⁸⁺

getFirstDayOfWeek⁸⁺

setFirstDayOfWeek⁸⁺

getMinimalDaysInFirstWeek⁸⁺

setMinimalDaysInFirstWeek⁸⁺

get⁸⁺

getDisplayName⁸⁺

isWeekend⁸⁺

PhoneNumberFormat⁸⁺

constructor⁸⁺

isValidNumber⁸⁺

format⁸⁺

getLocationName⁹⁺

PhoneNumberFormatOptions⁹⁺

UnitInfo⁸⁺

getInstance⁸⁺

IndexUtil⁸⁺

getIndexList⁸⁺

addLocale⁸⁺

getIndex⁸⁺

i18n.getLineInstance⁸⁺

BreakIterator⁸⁺

setLineBreakText⁸⁺

getLineBreakText⁸⁺

current⁸⁺

first⁸⁺

last⁸⁺

next⁸⁺

previous⁸⁺

following⁸⁺

isBoundary⁸⁺

i18n.getTimeZone⁷⁺

getAvailableIDs⁹⁺

getAvailableZoneCityIDs⁹⁺

getCityDisplayName⁹⁺

getTimezoneFromCity⁹⁺

Transliterator⁹⁺

getAvailableIDs⁹⁺

getInstance⁹⁺

transform⁹⁺

Unicode⁹⁺

isDigit⁹⁺

isSpaceChar⁹⁺

isWhitespace⁹⁺

isRTL⁹⁺

isIdeograph⁹⁺

isLetter⁹⁺

isLowerCase⁹⁺

isUpperCase⁹⁺

getType⁹⁺

I18NUtil⁹⁺

unitConvert⁹⁺

getDateOrder⁹⁺

i18n.getDisplayCountry^(deprecated)

i18n.getDisplayLanguage^(deprecated)

Util^(deprecated)

unitConvert^(deprecated)

Character^(deprecated)

isDigit^{(deprecated)+}

isSpaceChar^(deprecated)

isWhitespace^(deprecated)

isRTL^(deprecated)

isIdeograph^(deprecated)

isLetter^(deprecated)

isLowerCase^(deprecated)

isUpperCase^(deprecated)

getType^(deprecated)