diff --git a/zh-cn/application-dev/reference/apis/js-apis-i18n.md b/zh-cn/application-dev/reference/apis/js-apis-i18n.md index fcad6c2747f3151dfb27ed595624bacdbae92cff..aa5a732590d9b3f8e13686e8f522233b757b656e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-i18n.md +++ b/zh-cn/application-dev/reference/apis/js-apis-i18n.md @@ -11,6 +11,7 @@ > - 在本项目SDK中，国际化数据暂时仅支持简体中文、香港繁体、台湾繁体、美式英语、藏语、维吾尔语6种语言，其他语言支持待后续版本根据需要补充；使用非支持的语言，可能会回溯到英文特性或者返回空值。 + ## 导入模块 ```js @@ -28,15 +29,15 @@ static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------- | ---- | ---------------- | | country | string | 是 | 指定国家。 | | locale | string | 是 | 显示指定国家的区域ID。 | -| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | +| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。默认值：true。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------------- | @@ -50,12 +51,15 @@ static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean | ------ | ---------------------- | | 890001 | param value not valid | -**示例：** - ```js +**示例：** + ```ts + import { BusinessError } from '@ohos.base'; + try { - let displayCountry = I18n.System.getDisplayCountry("zh-CN", "en-GB"); // displayCountry = "China" - } catch(error) { - console.error(`call System.getDisplayCountry failed, error code: ${error.code}, message: ${error.message}.`); + let displayCountry: string = I18n.System.getDisplayCountry("zh-CN", "en-GB"); // displayCountry = "China" + } catch (error) { + let err: BusinessError = error as BusinessError; + console.error(`call System.getDisplayCountry failed, error code: ${err.code}, message: ${err.message}.`); } ``` @@ -67,15 +71,15 @@ static getDisplayLanguage(language: string, locale: string, sentenceCase?: boole **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------- | ---- | ---------------- | | language | string | 是 | 指定语言。 | | locale | string | 是 | 显示指定语言的区域ID。 | -| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | +| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。默认值：true。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------------- | @@ -89,12 +93,15 @@ static getDisplayLanguage(language: string, locale: string, sentenceCase?: boole | ------ | ---------------------- | | 890001 | param value not valid | -**示例：** - ```js +**示例：** + ```ts + import { BusinessError } from '@ohos.base'; + try { - let displayLanguage = I18n.System.getDisplayLanguage("zh", "en-GB"); // displayLanguage = Chinese + let displayLanguage: string = I18n.System.getDisplayLanguage("zh", "en-GB"); // displayLanguage = Chinese } catch(error) { - console.error(`call System.getDisplayLanguage failed, error code: ${error.code}, message: ${error.message}.`); + let err: BusinessError = error as BusinessError; + console.error(`call System.getDisplayLanguage failed, error code: ${err.code}, message: ${err.message}.`); } ``` @@ -106,26 +113,21 @@ static getSystemLanguage(): string **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------- | | string | 系统语言ID。 | -**错误码：** - -以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 - -| 错误码ID | 错误信息 | -| ------ | ---------------------- | -| 890001 | param value not valid | +**示例：** + ```ts + import { BusinessError } from '@ohos.base'; -**示例：** - ```js try { - let systemLanguage = I18n.System.getSystemLanguage(); // systemLanguage为当前系统语言 + let systemLanguage: string = I18n.System.getSystemLanguage(); // systemLanguage为当前系统语言 } catch(error) { - console.error(`call System.getSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`); + let err: BusinessError = error as BusinessError; + console.error(`call System.getSystemLanguage failed, error code: ${err.code}, message: ${err.message}.`); } ``` @@ -137,26 +139,21 @@ static getSystemRegion(): string **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------- | | string | 系统地区ID。 | -**错误码：** - -以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 - -| 错误码ID | 错误信息 | -| ------ | ---------------------- | -| 890001 | param value not valid | +**示例：** + ```ts + import { BusinessError } from '@ohos.base'; -**示例：** - ```js try { - let systemRegion = I18n.System.getSystemRegion(); // 获取系统当前地区设置 + let systemRegion: string = I18n.System.getSystemRegion(); // 获取系统当前地区设置 } catch(error) { - console.error(`call System.getSystemRegion failed, error code: ${error.code}, message: ${error.message}.`); + let err: BusinessError = error as BusinessError; + console.error(`call System.getSystemRegion failed, error code: ${err.code}, message: ${err.message}.`); } ``` @@ -168,26 +165,21 @@ static getSystemLocale(): string **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------- | | string | 系统区域ID。 | -**错误码：** - -以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 - -| 错误码ID | 错误信息 | -| ------ | ---------------------- | -| 890001 | param value not valid | +**示例：** + ```ts + import { BusinessError } from '@ohos.base'; -**示例：** - ```js try { - let systemLocale = I18n.System.getSystemLocale(); // 获取系统当前Locale + let systemLocale: string = I18n.System.getSystemLocale(); // 获取系统当前Locale } catch(error) { - console.error(`call System.getSystemLocale failed, error code: ${error.code}, message: ${error.message}.`); + let err: BusinessError = error as BusinessError; + console.error(`call System.getSystemLocale failed, error code: ${err.code}, message: ${err.message}.`); } ``` @@ -199,26 +191,21 @@ static is24HourClock(): boolean **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ---------------------------------------- | | boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 | -**错误码：** - -以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 - -| 错误码ID | 错误信息 | -| ------ | ---------------------- | -| 890001 | param value not valid | +**示例：** + ```ts + import { BusinessError } from '@ohos.base'; -**示例：** - ```js try { - let is24HourClock = I18n.System.is24HourClock(); // 系统24小时开关是否开启 + let is24HourClock: boolean = I18n.System.is24HourClock(); // 系统24小时开关是否开启 } catch(error) { - console.error(`call System.is24HourClock failed, error code: ${error.code}, message: ${error.message}.`); + let err: BusinessError = error as BusinessError; + console.error(`call System.is24HourClock failed, error code: ${err.code}, message: ${err.message}.`); } ``` @@ -230,20 +217,20 @@ isRTL(locale: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | | locale | string | 是 | 指定区域ID。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ---------------------------------------- | | boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 | -**示例：** - ```js +**示例：** + ```ts I18n.isRTL("zh-CN");// 中文不是RTL语言，返回false I18n.isRTL("ar-EG");// 阿语是RTL语言，返回true ``` @@ -286,16 +273,16 @@ setTime(date: Date): void **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ---- | ---- | ----------------- | | date | Date | 是 | 将要设置的日历对象的内部时间日期。 | -**示例：** - ```js - let calendar = I18n.getCalendar("en-US", "gregory"); - let date = new Date(2021, 10, 7, 8, 0, 0, 0); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("en-US", "gregory"); + let date: Date = new Date(2021, 10, 7, 8, 0, 0, 0); calendar.setTime(date); ``` @@ -308,15 +295,15 @@ setTime(time: number): void **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ---------------------------------------- | | time | number | 是 | time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 | -**示例：** - ```js - let calendar = I18n.getCalendar("en-US", "gregory"); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("en-US", "gregory"); calendar.setTime(10540800000); ``` @@ -329,20 +316,20 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------ | | year | number | 是 | 设置的年。 | | month | number | 是 | 设置的月。 | | date | number | 是 | 设置的日。 | -| hour | number | 否 | 设置的小时。 | -| minute | number | 否 | 设置的分钟。 | -| second | number | 否 | 设置的秒。 | +| hour | number | 否 | 设置的小时。默认值：系统小时。 | +| minute | number | 否 | 设置的分钟。默认值：系统分钟。 | +| second | number | 否 | 设置的秒。默认值：系统秒。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("zh-Hans"); calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 ``` @@ -355,15 +342,15 @@ setTimeZone(timezone: string): void **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------- | | timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("zh-Hans"); calendar.setTimeZone("Asia/Shanghai"); ``` @@ -376,17 +363,17 @@ getTimeZone(): string **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ---------- | | string | 日历对象的时区id。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("zh-Hans"); calendar.setTimeZone("Asia/Shanghai"); - let timezone = calendar.getTimeZone(); // timezone = "Asia/Shanghai" + let timezone: string = calendar.getTimeZone(); // timezone = "Asia/Shanghai" ``` @@ -398,16 +385,16 @@ getFirstDayOfWeek(): number **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | --------------------- | | number | 获取一周的起始日，1代表周日，7代表周六。 | -**示例：** - ```js - let calendar = I18n.getCalendar("en-US", "gregory"); - let firstDayOfWeek = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 1 +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("en-US", "gregory"); + let firstDayOfWeek: number = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 1 ``` @@ -419,17 +406,17 @@ setFirstDayOfWeek(value: number): void **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | --------------------- | | value | number | 是 | 设置一周的起始日，1代表周日，7代表周六。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("zh-Hans"); calendar.setFirstDayOfWeek(3); - let firstDayOfWeek = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 3 + let firstDayOfWeek: number = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 3 ``` @@ -441,16 +428,16 @@ getMinimalDaysInFirstWeek(): number **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------------ | | number | 一年中第一周的最小天数。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); - let minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 1 +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("zh-Hans"); + let minimalDaysInFirstWeek: number = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 1 ``` @@ -462,17 +449,17 @@ setMinimalDaysInFirstWeek(value: number): void **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ------------ | | value | number | 是 | 一年中第一周的最小天数。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.Calendar = I18n.getCalendar("zh-Hans"); calendar.setMinimalDaysInFirstWeek(3); - let minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 3 + let minimalDaysInFirstWeek: number = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 3 ``` @@ -484,23 +471,23 @@ get(field: string): number **系统能力**：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。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.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 = 8 + let hourOfDay: number = calendar.get("hour_of_day"); // hourOfDay = 8 ``` @@ -508,28 +495,28 @@ get(field: string): number isWeekend(date?: Date): boolean -判断给定的日期是否在日历中是周末。 +判断指定的日期在日历中是否为周末。 **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ---- | ---- | ---------------------------------------- | -| date | Date | 否 | 判断日期在日历中是否是周末。如果不传日期参数，则判断当前日期是否为周末。 | +| date | Date | 否 | 指定的日期。若不填，则判断当前日期是否为周末。默认值：系统日期。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ----------------------------------- | -| boolean | 当所判断的日期为周末时，返回 true，否则返回false。 | +| boolean | 若判断指定日期为周末时，返回true，否则返回false。 | -**示例：** - ```js - let calendar = I18n.getCalendar("zh-Hans"); +**示例：** + ```ts + let calendar: I18n.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); + let date: Date = new Date(2011, 11, 6, 9, 0, 0); calendar.isWeekend(date); // true ``` @@ -542,21 +529,21 @@ getTimeZone(zoneID?: string): TimeZone **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ----- | -| zondID | string | 否 | 时区ID。 | +| zondID | string | 否 | 时区ID。默认值：系统时区。 | -**返回值：** +**返回值：** | 类型 | 说明 | | -------- | ------------ | -| TimeZone | 时区ID对应的时区对象。 | +| [TimeZone](#timezone) | 时区ID对应的时区对象。 | -**示例：** - ```js - let timezone = I18n.getTimeZone(); +**示例：** + ```ts + let timezone: I18n.TimeZone = I18n.getTimeZone(); ``` @@ -571,16 +558,16 @@ getID(): string **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------------ | | string | 时区对象对应的时区ID。 | -**示例：** - ```js - let timezone = I18n.getTimeZone(); - let timezoneID = timezone.getID(); // timezoneID = "Asia/Shanghai" +**示例：** + ```ts + let timezone: I18n.TimeZone = I18n.getTimeZone(); + let timezoneID: string = timezone.getID(); // timezoneID = "Asia/Shanghai" ``` @@ -592,16 +579,16 @@ getRawOffset(): number **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------------------- | | number | 时区对象表示的时区与UTC时区的偏差。 | -**示例：** - ```js - let timezone = I18n.getTimeZone(); - let offset = timezone.getRawOffset(); // offset = 28800000 +**示例：** + ```ts + let timezone: I18n.TimeZone = I18n.getTimeZone(); + let offset: number = timezone.getRawOffset(); // offset = 28800000 ``` @@ -613,16 +600,22 @@ getOffset(date?: number): number **系统能力**：SystemCapability.Global.I18n -**返回值：** +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------ | +| date | number | 否 | 待计算偏差的时刻 | + +**返回值：** | 类型 | 说明 | | ------ | ----------------------- | -| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 | +| number | 某一时刻时区对象表示的时区与UTC时区的偏差。默认值：系统时间。 | -**示例：** - ```js - let timezone = I18n.getTimeZone(); - let offset = timezone.getOffset(1234567890); // offset = 28800000 +**示例：** + ```ts + let timezone: I18n.TimeZone = I18n.getTimeZone(); + let offset: number = timezone.getOffset(1234567890); // offset = 28800000 ``` @@ -634,16 +627,16 @@ static getAvailableIDs(): Array<string> **系统能力**：SystemCapability.Global.I18n -**返回值：** +**返回值：** | 类型 | 说明 | | ------------------- | ----------- | | Array<string> | 系统支持的时区ID列表 | -**示例：** +**示例：** ```ts // 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(); + let ids: Array = I18n.TimeZone.getAvailableIDs(); ``` @@ -658,21 +651,21 @@ static isDigit(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ------------------------------------ | | boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 | -**示例：** - ```js - let isdigit = I18n.Unicode.isDigit("1"); // isdigit = true +**示例：** + ```ts + let isdigit: boolean = I18n.Unicode.isDigit("1"); // isdigit = true ``` @@ -684,21 +677,21 @@ static isSpaceChar(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | -------------------------------------- | | boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 | -**示例：** - ```js - let isspacechar = I18n.Unicode.isSpaceChar("a"); // isspacechar = false +**示例：** + ```ts + let isspacechar: boolean = I18n.Unicode.isSpaceChar("a"); // isspacechar = false ``` @@ -710,21 +703,21 @@ static isWhitespace(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | -------------------------------------- | | boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 | -**示例：** - ```js - let iswhitespace = I18n.Unicode.isWhitespace("a"); // iswhitespace = false +**示例：** + ```ts + let iswhitespace: boolean = I18n.Unicode.isWhitespace("a"); // iswhitespace = false ``` @@ -736,21 +729,21 @@ static isRTL(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ---------------------------------------- | | boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 | -**示例：** - ```js - let isrtl = I18n.Unicode.isRTL("a"); // isrtl = false +**示例：** + ```ts + let isrtl: boolean = I18n.Unicode.isRTL("a"); // isrtl = false ``` @@ -762,21 +755,21 @@ static isIdeograph(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ---------------------------------------- | | boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 | -**示例：** - ```js - let isideograph = I18n.Unicode.isIdeograph("a"); // isideograph = false +**示例：** + ```ts + let isideograph: boolean = I18n.Unicode.isIdeograph("a"); // isideograph = false ``` @@ -788,21 +781,21 @@ static isLetter(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ------------------------------------ | | boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 | -**示例：** - ```js - let isletter = I18n.Unicode.isLetter("a"); // isletter = true +**示例：** + ```ts + let isletter: boolean = I18n.Unicode.isLetter("a"); // isletter = true ``` @@ -814,21 +807,21 @@ static isLowerCase(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ---------------------------------------- | | boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 | -**示例：** - ```js - let islowercase = I18n.Unicode.isLowerCase("a"); // islowercase = true +**示例：** + ```ts + let islowercase: boolean = I18n.Unicode.isLowerCase("a"); // islowercase = true ``` @@ -840,21 +833,21 @@ static isUpperCase(char: string): boolean **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------- | ---------------------------------------- | | boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 | -**示例：** - ```js - let isuppercase = I18n.Unicode.isUpperCase("a"); // isuppercase = false +**示例：** + ```ts + let isuppercase: boolean = I18n.Unicode.isUpperCase("a"); // isuppercase = false ``` @@ -866,21 +859,57 @@ static getType(char: string): string **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----- | | char | string | 是 | 输入字符。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ----------- | -| string | 输入字符的一般类别值。 | - -**示例：** - ```js - let type = I18n.Unicode.getType("a"); // type = "U_LOWERCASE_LETTER" +| string | 输入字符的一般类别值。| + +一般类别值如下，更详细的介绍可以参考Unicode标准。 + +| 名称 | 值 | 说明 | +| ---- | -------- | ---------- | +| U_UNASSIGNED | U_UNASSIGNED | 表示未分配和非字符代码点对应类别。 | +| U_GENERAL_OTHER_TYPES | U_GENERAL_OTHER_TYPES | 与 U_UNASSIGNED 相同。 | +| U_UPPERCASE_LETTER | U_UPPERCASE_LETTER | 表示大写字母。 | +| U_LOWERCASE_LETTER | U_LOWERCASE_LETTER | 表示小写字母。 | +| U_TITLECASE_LETTER | U_TITLECASE_LETTER | 表示首字母大写。 | +| U_MODIFIER_LETTER | U_MODIFIER_LETTER | 表示字母修饰符。 | +| U_OTHER_LETTER | U_OTHER_LETTER | 表示其它字母，不属于大写字母、小写字母、首字母大写或修饰符字母的字母。 | +| U_NON_SPACING_MARK | U_NON_SPACING_MARK | 表示非间距标记，如重音符号'，变音符号#。 | +| U_ENCLOSING_MARK | U_ENCLOSING_MARK | 表示封闭标记和能围住其它字符的标记，如圆圈、方框等。 | +| U_COMBINING_SPACING_MARK | U_COMBINING_SPACING_MARK | 表示间距标记，如元音符号[ ]。 | +| U_DECIMAL_DIGIT_NUMBER | U_DECIMAL_DIGIT_NUMBER | 表示十进制数字。 | +| U_LETTER_NUMBER | U_LETTER_NUMBER | 表示字母数字，罗马数字。 | +| U_OTHER_NUMBER | U_OTHER_NUMBER | 表示其它作为加密符号和记号的数字，非阿拉伯数字的数字表示符，如@、#、（1）、①等。 | +| U_SPACE_SEPARATOR | U_SPACE_SEPARATOR | 表示空白分隔符，如空格符、不间断空格、固定宽度的空白符。 | +| U_LINE_SEPARATOR | U_LINE_SEPARATOR | 表示行分隔符。| +| U_PARAGRAPH_SEPARATOR | U_PARAGRAPH_SEPARATOR | 表示段落分割符。 | +| U_CONTROL_CHAR | U_CONTROL_CHAR | 表示控制字符。 | +| U_FORMAT_CHAR | U_FORMAT_CHAR | 表示格式字符。 | +| U_PRIVATE_USE_CHAR | U_PRIVATE_USE_CHAR | 表示私人使用区代码点类别，例如公司 logo。 | +| U_SURROGATE | U_SURROGATE | 表示代理项，在UTF-16中用来表示补充字符的方法。 | +| U_DASH_PUNCTUATION | U_DASH_PUNCTUATION | 表示短划线标点。 | +| U_START_PUNCTUATION | U_START_PUNCTUATION | 表示开始标点，如左括号。 | +| U_END_PUNCTUATION | U_END_PUNCTUATION | 表示结束标点，如右括号。 | +| U_INITIAL_PUNCTUATION | U_INITIAL_PUNCTUATION | 表示前引号，如左双引号、左单引号。 | +| U_FINAL_PUNCTUATION | U_FINAL_PUNCTUATION | 表示后引号，如右双引号、右单引号。 | +| U_CONNECTOR_PUNCTUATION | U_CONNECTOR_PUNCTUATION | 表示连接符标点。 | +| U_OTHER_PUNCTUATION | U_OTHER_PUNCTUATION | 表示其他标点。 | +| U_MATH_SYMBOL | U_MATH_SYMBOL | 表示数学符号。 | +| U_CURRENCY_SYMBOL | U_CURRENCY_SYMBOL | 表示货币符号。 | +| U_MODIFIER_SYMBOL | U_MODIFIER_SYMBOL | 表示修饰符号。 | +| U_OTHER_SYMBOL | U_OTHER_SYMBOL | 表示其它符号。 | + +**示例：** + ```ts + let type: string = I18n.Unicode.getType("a"); // type = "U_LOWERCASE_LETTER" ``` @@ -890,23 +919,23 @@ static getType(char: string): string static getDateOrder(locale: string): string -获取某一区域的日期的年、月、日排列顺序。 +获取该区域日期中年、月、日的排列顺序。 **系统能力**：SystemCapability.Global.I18n -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------- | | locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 | -**返回值：** +**返回值：** | 类型 | 说明 | | ------ | ------------------- | -| string | 返回某一区域的日期的年、月、日排列顺序 | +| string | 返回该区域年、月、日的排列顺序。 | -**示例：** - ```js - let order = I18n.I18NUtil.getDateOrder("zh-CN"); // order = "y-L-d" +**示例：** + ```ts + let order: string = I18n.I18NUtil.getDateOrder("zh-CN"); // order = "y-L-d" ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-intl.md b/zh-cn/application-dev/reference/apis/js-apis-intl.md index be0b57182e9ed75b158f125d89076e37a3b3e784..102589293414f994f4a82f225a7074bee2f5c998 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-intl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-intl.md @@ -27,7 +27,7 @@ import Intl from '@ohos.intl'; | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------- | ------- | ---- | ---- | ---------------------------------------- | -| language | string | 是 | 否 | 与区域设置关联的语， 如：zh。 | +| language | string | 是 | 否 | 与区域设置相关的语言，如：zh。 | | script | string | 是 | 否 | 语言的书写方式，如：Hans。 | | region | string | 是 | 否 | 与区域设置相关的地区，如：CN。 | | baseName | string | 是 | 否 | Locale的基本核心信息（由语言脚本与地区组成），如：zh-Hans-CN。 | @@ -36,7 +36,7 @@ import Intl from '@ohos.intl'; | collation | string | 是 | 否 | 区域的排序规则，取值包括："big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。 | | hourCycle | string | 是 | 否 | 区域的时制信息，取值包括："h12", "h23", "h11", "h24"。 | | numberingSystem | string | 是 | 否 | 区域使用的数字系统，取值包括："adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 | -| numeric | boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理。 | +| numeric | boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理。默认值：false。 | ### constructor8+ @@ -48,7 +48,7 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```js + ```ts // 默认构造函数使用系统当前locale创建Locale对象 let locale = new Intl.Locale(); // 返回系统当前localel @@ -68,11 +68,11 @@ constructor(locale: string, options?: LocaleOptions) | 参数名 | 类型 | 必填 | 说明 | | -------------------- | -------------------------------- | ---- | ---------------------------- | -| locale | string | 是 | 包含区域信息的字符串，包括语言以、脚本、国家或地区。 | -| options | [LocaleOptions](#localeoptions6) | 否 | 用于创建区域对象的选项。 | +| locale | string | 是 | 区域信息的字符串，由语言、脚本、国家或地区组成。 | +| options | [LocaleOptions](#localeoptions6) | 否 | 用于创建区域对象的选项。 | **示例：** - ```js + ```ts // 创建 "zh-CN" Locale对象 let locale = new Intl.Locale("zh-CN"); let localeID = locale.toString(); // localeID = "zh-CN" @@ -94,7 +94,7 @@ toString(): string | string | 区域对象的字符串表示。 | **示例：** - ```js + ```ts // 创建 "en-GB" Locale对象 let locale = new Intl.Locale("en-GB"); let localeID = locale.toString(); // localeID = "en-GB" @@ -116,7 +116,7 @@ maximize(): Locale | [Locale](#locale) | 最大化后的区域对象。 | **示例：** - ```js + ```ts // 创建 "zh" Locale对象 let locale = new Intl.Locale("zh"); // 补齐Locale对象的脚本和地区 @@ -146,7 +146,7 @@ minimize(): Locale | [Locale](#locale) | 最小化后的区域对象。 | **示例：** - ```js + ```ts // 创建 "zh-Hans-CN" Locale对象 let locale = new Intl.Locale("zh-Hans-CN"); // 去除Locale对象的脚本和地区 @@ -164,7 +164,7 @@ minimize(): Locale ## LocaleOptions6+ 表示区域初始化选项。 -在API9中，LocaleOptions中的属性修改为可选属性。 +从API9开始，LocaleOptions中的属性改为可选。 **系统能力**：SystemCapability.Global.I18n @@ -174,7 +174,7 @@ minimize(): Locale | collation | string | 是 | 是 | 排序参数，取值包括："big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 | | hourCycle | string | 是 | 是 | 时制格式，取值包括："h11", "h12", "h23", "h24"。 | | numberingSystem | string | 是 | 是 | 数字系统，取值包括："adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 | -| numeric | boolean | 是 | 是 | 是否使用12小时制。 | +| numeric | boolean | 是 | 是 | 是否使用12小时制。默认值：false。 | | caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序，取值范围："upper", "lower", "false"。 | @@ -190,7 +190,7 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```js + ```ts // 使用系统当前locale创建DateTimeFormat对象 let datefmt= new Intl.DateTimeFormat(); ``` @@ -209,17 +209,17 @@ constructor(locale: string | Array<string>, options?: DateTimeOptions) | 参数名 | 类型 | 必填 | 说明 | | -------------------- | ------------------------------------ | ---- | ---------------------------- | | locale | string \| Array<string> | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 | -| options | [DateTimeOptions](#datetimeoptions6) | 否 | 用于创建时间日期格式化的选项。 | +| options | [DateTimeOptions](#datetimeoptions6) | 否 | 用于创建时间日期格式化的选项。若所有选项均未设置时，year、month、day三个属性的默认值为numeric。 | **示例：** - ```js + ```ts // 使用 "zh-CN" locale创建DateTimeFormat对象，日期风格为full，时间风格为medium let datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' }); ``` **示例：** - ```js + ```ts // 使用 ["ban", "zh"] locale列表创建DateTimeFormat对象，因为ban为非法LocaleID，因此使用zh Locale创建DateTimeFormat对象 let datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' }); ``` @@ -246,7 +246,7 @@ format(date: Date): string | string | 格式化后的时间日期字符串 | **示例：** - ```js + ```ts let date = new Date(2021, 11, 17, 3, 24, 0); // 使用 en-GB locale创建DateTimeFormat对象 let datefmt = new Intl.DateTimeFormat("en-GB"); @@ -280,7 +280,7 @@ formatRange(startDate: Date, endDate: Date): string | string | 格式化后的时间日期段字符串。 | **示例：** - ```js + ```ts let startDate = new Date(2021, 11, 17, 3, 24, 0); let endDate = new Date(2021, 11, 18, 3, 24, 0); // 使用 en-GB locale创建DateTimeFormat对象 @@ -304,7 +304,7 @@ resolvedOptions(): DateTimeOptions | [DateTimeOptions](#datetimeoptions6) | DateTimeFormat 对象的格式化选项。 | **示例：** - ```js + ```ts let datefmt = new Intl.DateTimeFormat("en-GB", { dateStyle: 'full', timeStyle: 'medium' }); // 返回DateTimeFormat对象的配置项 let options = datefmt.resolvedOptions(); @@ -316,7 +316,7 @@ resolvedOptions(): DateTimeOptions ## DateTimeOptions6+ 表示时间日期格式化选项。 -在API9中，DateTimeOptions中的属性修改为可选属性。 +从API9开始，DateTimeOptions中的属性改为可选。 **系统能力**：SystemCapability.Global.I18n @@ -328,7 +328,7 @@ resolvedOptions(): DateTimeOptions | hourCycle | string | 是 | 是 | 时制格式，取值包括："h11", "h12", "h23", "h24"。 | | timeZone | string | 是 | 是 | 使用的时区（合法的IANA时区ID）。 | | numberingSystem | string | 是 | 是 | 数字系统，取值包括："adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 | -| hour12 | boolean | 是 | 是 | 是否使用12小时制。 | +| hour12 | boolean | 是 | 是 | 是否使用12小时制。若hour12和hourCycle未设置且系统24小时开关打开时，hour12属性的默认值为false。 | | weekday | string | 是 | 是 | 工作日的显示格式，取值包括："long", "short", "narrow"。 | | era | string | 是 | 是 | 时代的显示格式，取值包括："long", "short", "narrow"。 | | year | string | 是 | 是 | 年份的显示格式，取值包括："numeric", "2-digit"。 | @@ -355,7 +355,7 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```js + ```ts // 使用系统当前locale创建NumberFormat对象 let numfmt = new Intl.NumberFormat(); ``` @@ -377,7 +377,7 @@ constructor(locale: string | Array<string>, options?: NumberOptions) | options | [NumberOptions](#numberoptions6) | 否 | 用于创建数字格式化的选项。 | **示例：** - ```js + ```ts // 使用 en-GB locale创建NumberFormat对象，style设置为decimal，notation设置为scientific let numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"}); ``` @@ -405,7 +405,7 @@ format(number: number): string; **示例：** - ```js + ```ts // 使用 ["en-GB", "zh"] locale列表创建NumberFormat对象，因为en-GB为合法LocaleID，因此使用en-GB创建NumberFormat对象 let numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); let formattedNumber = numfmt.format(1223); // formattedNumber = 1.223E3 @@ -428,7 +428,7 @@ resolvedOptions(): NumberOptions **示例：** - ```js + ```ts let numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); // 获取NumberFormat对象配置项 let options = numfmt.resolvedOptions(); @@ -440,31 +440,31 @@ resolvedOptions(): NumberOptions ## NumberOptions6+ 表示设备支持的能力。 -在API9中，NumberOptions中的属性修改为可选属性。 +从API9开始，NumberOptions中的属性改为可选。 **系统能力**：SystemCapability.Global.I18n | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------------ | ------- | ---- | ---- | ---------------------------------------- | -| locale | string | 是 | 否 | 区域参数， 如："zh-Hans-CN"。 | +| locale | string | 是 | 否 | 区域参数， 如："zh-Hans-CN"。locale属性默认值为系统Locale。 | | currency | string | 是 | 是 | 货币单位， 如："EUR"，"CNY"，"USD"等。 | -| currencySign | string | 是 | 是 | 货币单位的符号显示，取值包括： "symbol"，"narrowSymbol"，"code"，"name" 。 | -| currencyDisplay | string | 是 | 是 | 货币的显示方式，取值包括："symbol", "narrowSymbol", "code", "name"。 | +| currencySign | string | 是 | 是 | 货币单位的符号显示，取值包括： "standard"，"accounting"。currencySign属性默认值为standard。 | +| currencyDisplay | string | 是 | 是 | 货币的显示方式，取值包括："symbol", "narrowSymbol", "code", "name"。currencyDisplay属性默认值为symbol。 | | unit | string | 是 | 是 | 单位名称，如："meter"，"inch"，“hectare”等。 | -| unitDisplay | string | 是 | 是 | 单位的显示格式，取值包括："long", "short", "narrow"。 | -| unitUsage8+ | string | 是 | 是 | 单位的使用场景，取值包括："default", "area-land-agricult", "area-land-commercl", "area-land-residntl", "length-person", "length-person-small", "length-rainfall", "length-road", "length-road-small", "length-snowfall", "length-vehicle", "length-visiblty", "length-visiblty-small", "length-person-informal", "length-person-small-informal", "length-road-informal", "speed-road-travel", "speed-wind", "temperature-person", "temperature-weather", "volume-vehicle-fuel"。 | -| signDisplay | string | 是 | 是 | 数字符号的显示格式，取值包括："auto", "never", "always", "expectZero"。 | -| compactDisplay | string | 是 | 是 | 紧凑型的显示格式，取值包括："long", "short"。 | -| notation | string | 是 | 是 | 数字的格式化规格，取值包括："standard", "scientific", "engineering", "compact"。 | -| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法，取值包括："lookup", "best fit"。 | -| style | string | 是 | 是 | 数字的显示格式，取值包括："decimal", "currency", "percent", "unit"。 | -| numberingSystem | string | 是 | 是 | 数字系统，取值包括："adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。 | -| useGrouping | boolean | 是 | 是 | 是否分组显示。 | -| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。 | -| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。 | -| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。 | -| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数，取值范围：1~21。 | -| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数，取值范围：1~21。 | +| unitDisplay | string | 是 | 是 | 单位的显示格式，取值包括："long", "short", "narrow"。unitDisplay属性默认值为short。 | +| unitUsage8+ | string | 是 | 是 | 单位的使用场景，取值包括："default", "area-land-agricult", "area-land-commercl", "area-land-residntl", "length-person", "length-person-small", "length-rainfall", "length-road", "length-road-small", "length-snowfall", "length-vehicle", "length-visiblty", "length-visiblty-small", "length-person-informal", "length-person-small-informal", "length-road-informal", "speed-road-travel", "speed-wind", "temperature-person", "temperature-weather", "volume-vehicle-fuel"。unitUsage属性默认值为default。 | +| signDisplay | string | 是 | 是 | 数字符号的显示格式，取值包括："auto", "never", "always", "expectZero"。signDisplay属性默认值为auto。 | +| compactDisplay | string | 是 | 是 | 紧凑型的显示格式，取值包括："long", "short"。compactDisplay属性默认值为short。 | +| notation | string | 是 | 是 | 数字的格式化规格，取值包括："standard", "scientific", "engineering", "compact"。notation属性默认值为standard。 | +| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法，取值包括："lookup", "best fit"。localeMatcher属性默认值为best fit。 | +| style | string | 是 | 是 | 数字的显示格式，取值包括："decimal", "currency", "percent", "unit"。style属性默认值为decimal。 | +| numberingSystem | string | 是 | 是 | 数字系统，取值包括："adlm", "ahom", "arab", "arabext", "bali", "beng", "bhks", "brah", "cakm", "cham", "deva", "diak", "fullwide", "gong", "gonm", "gujr", "guru", "hanidec", "hmng", "hmnp", "java", "kali", "khmr", "knda", "lana", "lanatham", "laoo", "latn", "lepc", "limb", "mathbold", "mathdbl", "mathmono", "mathsanb", "mathsans", "mlym", "modi", "mong", "mroo", "mtei", "mymr", "mymrshan", "mymrtlng", "newa", "nkoo", "olck", "orya", "osma", "rohg", "saur", "segment", "shrd", "sind", "sinh", "sora", "sund", "takr", "talu", "tamldec", "telu", "thai", "tibt", "tirh", "vaii", "wara", "wcho"。numberingSystem属性默认值为locale的默认数字系统。 | +| useGrouping | boolean | 是 | 是 | 是否分组显示。useGrouping属性默认值为auto。 | +| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。minimumIntegerDigits属性默认值为1。 | +| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。minimumFractionDigits属性默认值为0。 | +| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。maximumFractionDigits属性默认值为3。 | +| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数，取值范围：1~21。minimumSignificantDigits属性默认值为1。 | +| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数，取值范围：1~21。maximumSignificantDigits属性默认值为21。 | ## Collator8+ @@ -479,7 +479,7 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```js + ```ts // 使用系统locale创建Collator对象 let collator = new Intl.Collator(); ``` @@ -498,10 +498,10 @@ constructor(locale: string | Array<string>, options?: CollatorOptions) | 参数名 | 类型 | 必填 | 说明 | | -------------------- | ------------------------------------ | ---- | ---------------------------- | | locale | string \| Array<string> | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 | -| options | [CollatorOptions](#collatoroptions8) | 否 | 用于创建排序对象的选项。 | +| options | [CollatorOptions](#collatoroptions8) | 否 | 用于创建排序对象的选项。 | **示例：** - ```js + ```ts // 使用 zh-CN locale创建Collator对象，localeMatcher设置为lookup，usage设置为sort let collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"}); ``` @@ -529,7 +529,7 @@ compare(first: string, second: string): number | number | 比较结果。当number为负数，表示first排序在second之前；当number为0，表示first与second排序相同；当number为正数，表示first排序在second之后。 | **示例：** - ```js + ```ts // 使用en-GB locale创建Collator对象 let collator = new Intl.Collator("en-GB"); // 比较 "first" 和 "second" 的先后顺序 @@ -552,7 +552,7 @@ resolvedOptions(): CollatorOptions | [CollatorOptions](#collatoroptions8) | 返回的Collator对象的属性。 | **示例：** - ```js + ```ts let collator = new Intl.Collator("zh-Hans", { usage: 'sort', ignorePunctuation: true }); // 获取Collator对象的配置项 let options = collator.resolvedOptions(); @@ -564,19 +564,19 @@ resolvedOptions(): CollatorOptions ## CollatorOptions8+ 表示Collator可设置的属性。 -在API9中，CollatorOptions中的属性修改为可选属性。 +从API9中，CollatorOptions中的属性改为可选。 **系统能力**：SystemCapability.Global.I18n | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------- | ------- | ---- | ---- | ---------------------------------------- | -| localeMatcher | string | 是 | 是 | locale匹配算法，取值范围："best fit", "lookup"。 | -| usage | string | 是 | 是 | 比较的用途，取值范围："sort", "search"。 | -| sensitivity | string | 是 | 是 | 表示字符串中的哪些差异会导致非零结果值，取值范围："base", "accent", "case", "letiant"。 | -| ignorePunctuation | boolean | 是 | 是 | 表示是否忽略标点符号，取值范围：true, false。 | -| collation | string | 是 | 是 | 排序规则，取值范围："big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。 | -| numeric | boolean | 是 | 是 | 是否使用数字排序，取值范围：true, false。 | -| caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序，取值范围："upper", "lower", "false"。 | +| localeMatcher | string | 是 | 是 | locale匹配算法，取值范围："best fit", "lookup"。localeMatcher属性默认值为best fit。 | +| usage | string | 是 | 是 | 比较的用途，取值范围："sort", "search"。usage属性默认值为sort。 | +| sensitivity | string | 是 | 是 | 表示字符串中的哪些差异会导致非零结果值，取值范围："base", "accent", "case", "letiant"。sensitivity属性默认值为variant。 | +| ignorePunctuation | boolean | 是 | 是 | 表示是否忽略标点符号，取值范围：true, false。ignorePunctuation属性默认值为false。 | +| collation | string | 是 | 是 | 排序规则，取值范围："big5han", "compat", "dict", "direct", "ducet", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed", "searchjl", "stroke", "trad", "unihan", "zhuyin"。collation属性默认值为default。 | +| numeric | boolean | 是 | 是 | 是否使用数字排序，取值范围：true, false。numeric属性默认值为false。 | +| caseFirst | string | 是 | 是 | 表示大写、小写的排序顺序，取值范围："upper", "lower", "false"。caseFirst属性默认值为false | ## PluralRules8+ @@ -591,7 +591,7 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```js + ```ts // 使用系统locale创建PluralRules对象 let pluralRules = new Intl.PluralRules(); ``` @@ -610,10 +610,10 @@ constructor(locale: string | Array<string>, options?: PluralRulesOptions) | 参数名 | 类型 | 必填 | 说明 | | -------------------- | ---------------------------------------- | ---- | ---------------------------- | | locale | string \| Array<string> | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 | -| options | [PluralRulesOptions](#pluralrulesoptions8) | 否 | 用于创建单复数对象的选项。 | +| options | [PluralRulesOptions](#pluralrulesoptions8) | 否 | 用于创建单复数对象的选项。 | **示例：** - ```js + ```ts // 使用 zh-CN locale创建PluralRules对象，localeMatcher设置为lookup，type设置为cardinal let pluralRules= new Intl.PluralRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"}); ``` @@ -640,7 +640,7 @@ select(n: number): string | string | 单复数类别，取值包括："zero"，"one"，"two", "few", "many", "others"。 | **示例：** - ```js + ```ts // 使用 zh-Hans locale创建PluralRules对象 let zhPluralRules = new Intl.PluralRules("zh-Hans"); // 计算 zh-Hans locale中数字1对应的单复数类别 @@ -656,19 +656,19 @@ select(n: number): string ## PluralRulesOptions8+ 表示PluralRules对象可设置的属性。 -在API9中，PluralRulesOptions中的属性修改为可选属性。 +从API9开始，PluralRulesOptions中的属性改为可选。 **系统能力**：SystemCapability.Global.I18n | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------------ | ------ | ---- | ---- | ---------------------------------------- | -| localeMatcher | string | 是 | 是 | locale匹配算法，取值包括："best fit", "lookup"。 | -| type | string | 是 | 是 | 排序的类型，取值包括："cardinal", "ordinal"。 | -| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。 | -| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。 | -| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。 | -| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数，取值范围：1~21。 | -| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数，取值范围：1~21。 | +| localeMatcher | string | 是 | 是 | locale匹配算法，取值包括："best fit", "lookup"。localeMatcher属性默认值为best fit。 | +| type | string | 是 | 是 | 排序的类型，取值包括："cardinal", "ordinal"。type属性默认值为cardinal。 | +| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。minimumIntegerDigits属性默认值为1。 | +| minimumFractionDigits | number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。minimumFractionDigits属性默认值为0。 | +| maximumFractionDigits | number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。maximumFractionDigits属性默认值为3。 | +| minimumSignificantDigits | number | 是 | 是 | 表示要使用的最低有效位数，取值范围：1~21。minimumSignificantDigits属性默认值为1。 | +| maximumSignificantDigits | number | 是 | 是 | 表示要使用的最大有效位数，取值范围：1~21。maximumSignificantDigits属性默认值为21。 | ## RelativeTimeFormat8+ @@ -683,7 +683,7 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```js + ```ts // 使用系统locale创建RelativeTimeFormat对象 let relativetimefmt = new Intl.RelativeTimeFormat(); ``` @@ -705,7 +705,7 @@ constructor(locale: string | Array<string>, options?: RelativeTimeFormatIn | options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions8) | 否 | 用于创建相对时间格式化对象的选项。 | **示例：** - ```js + ```ts // 使用 zh-CN locale创建RelativeTimeFormat对象，localeMatcher设置为lookup，numeric设置为always，style设置为long let relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"}); ``` @@ -733,7 +733,7 @@ format(value: number, unit: string): string | string | 格式化后的相对时间。 | **示例：** - ```js + ```ts // 使用 zh-CN locale创建RelativeTimeFormat对象 let relativetimefmt = new Intl.RelativeTimeFormat("zh-CN"); // 计算 zh-CN locale中数字3，单位quarter的本地化表示 @@ -763,7 +763,7 @@ formatToParts(value: number, unit: string): Array<object> | Array<object> | 返回可用于自定义区域设置格式的相对时间格式的对象数组。 | **示例：** - ```js + ```ts // 使用 en locale创建RelativeTimeFormat对象，numeric设置为auto let relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"}); let parts = relativetimefmt.formatToParts(10, "seconds"); // parts = [ {type: "literal", value: "in"}, {type: "integer", value: 10, unit: "second"}, {type: "literal", value: "seconds"} ] @@ -785,7 +785,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions | [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions8) | RelativeTimeFormat 对象的格式化选项。 | **示例：** - ```js + ```ts // 使用 en-GB locale创建RelativeTimeFormat对象 let relativetimefmt= new Intl.RelativeTimeFormat("en-GB", { style: "short" }); // 获取RelativeTimeFormat对象配置项 @@ -797,15 +797,14 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions ## RelativeTimeFormatInputOptions8+ 表示RelativeTimeFormat对象可设置的属性。 -在API9中，RelativeTimeFormatInputOptions中的属性修改为可选属性。 +从API9开始，RelativeTimeFormatInputOptions中的属性改为可选。 **系统能力**：SystemCapability.Global.I18n - | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------- | ------ | ---- | ---- | ---------------------------------------- | -| localeMatcher | string | 是 | 是 | locale匹配算法，取值包括："best fit", "lookup"。 | -| numeric | string | 是 | 是 | 输出消息的格式，取值包括："always", "auto"。 | -| style | string | 是 | 是 | 国际化消息的长度，取值包括："long", "short", "narrow"。 | +| localeMatcher | string | 是 | 是 | locale匹配算法，取值包括："best fit", "lookup"。localeMatcher属性默认值为best fit。 | +| numeric | string | 是 | 是 | 输出消息的格式，取值包括："always", "auto"。numeric属性默认值为always。 | +| style | string | 是 | 是 | 国际化消息的长度，取值包括："long", "short", "narrow"。style属性默认值为long。 | ## RelativeTimeFormatResolvedOptions8+ @@ -819,4 +818,4 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions | locale | string | 是 | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 | | numeric | string | 是 | 是 | 输出消息的格式，取值包括："always", "auto"。 | | style | string | 是 | 是 | 国际化消息的长度，取值包括："long", "short", "narrow"。 | -| numberingSystem | string | 是 | 是 | 使用的数字系统。 | +| numberingSystem | string | 是 | 是 | 使用的数字系统。 | \ No newline at end of file