diff --git a/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n-sys.md b/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n-sys.md index 40ef0caa8caef24a87a4a1c5a41f35ebb5c26a25..4ae77f85bad74539261cad05285e0240e0851723 100644 --- a/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n-sys.md +++ b/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n-sys.md @@ -898,12 +898,12 @@ static getTimeZoneCityItemArray(): Array<TimeZoneCityItem> **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | --------------- | ------ | --------------------------------------- | -| id | string | 是 | 语言代码或国家地区代码，如"zh"、"CN"。 | -| suggestionType | [SuggestionType](#suggestiontype10) | 是 | 语言或国家地区推荐类型。 | -| displayName | string | 是 | id在SystemLocaleManager的指定区域下的表示。| -| localName | string | 否 | id的本地名称。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | --------------- | ------ | ------ | --------------------------------------- | +| id | string | 否 | 否 | 语言代码或国家地区代码，如"zh"、"CN"。 | +| suggestionType | [SuggestionType](#suggestiontype10) | 否 | 否 | 语言或国家地区推荐类型。 | +| displayName | string | 否 | 否 | id在SystemLocaleManager的指定区域下的表示。| +| localName | string | 否 | 是 | id的本地名称。只有在表示语言相关信息时才存在该选项。 | ## TimeZoneCityItem10+ @@ -913,14 +913,14 @@ static getTimeZoneCityItemArray(): Array<TimeZoneCityItem> **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | --------------- | ------ | --------------------------------------- | -| zoneId | string | 是 | 时区ID，例如Asia/Shanghai。 | -| cityId | string | 是 | 城市ID，例如Shanghai。 | -| cityDisplayName | string | 是 | 城市ID在系统区域下显示的名称。 | -| offset | int | 是 | 时区ID的偏移量。 | -| zoneDisplayName | string | 是 | 时区ID在系统区域下显示的名称。 | -| rawOffset | int | 否 | 时区ID的固定偏移量。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | --------------- | ------ | ------ | --------------------------------------- | +| zoneId | string | 否 | 否 | 时区ID，例如Asia/Shanghai。 | +| cityId | string | 否 | 否 | 城市ID，例如Shanghai。 | +| cityDisplayName | string | 否 | 否 | 城市ID在系统区域下显示的名称。 | +| offset | number | 否 | 否 | 时区ID的偏移量。 | +| zoneDisplayName | string | 否 | 否 | 时区ID在系统区域下显示的名称。 | +| rawOffset | number | 否 | 是 | 时区ID的固定偏移量。 | ## SuggestionType10+ @@ -946,8 +946,8 @@ static getTimeZoneCityItemArray(): Array<TimeZoneCityItem> **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | --------------- | ---- | --------------------------------------- | -| locale | string | 否 | [表示区域ID的字符串](../../internationalization/i18n-locale-culture.md#实现原理)，由语言、脚本、国家或地区组成，如"zh-Hans-CN"。
默认值：系统当前区域ID。 | -| isUseLocalName | boolean | 否 | true表示使用本地名称进行排序，false表示不使用本地名称进行排序。
若调用方法为getLanguageInfoArray，isUseLocalName属性默认值为true。
若调用方法为getRegionInfoArray，isUseLocalName属性默认值为false。 | -| isSuggestedFirst | boolean | 否 | true表示将推荐语言或国家地区在排序结果中置顶，false表示不将推荐语言或国家地区在排序结果中置顶。
默认值：true。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | --------------- | ---- | ---- | --------------------------------------- | +| locale | string | 否 | 是 | [表示区域ID的字符串](../../internationalization/i18n-locale-culture.md#实现原理)，由语言、脚本、国家或地区组成，如"zh-Hans-CN"。
默认值：系统当前区域ID。 | +| isUseLocalName | boolean | 否 | 是 | true表示使用本地名称进行排序，false表示不使用本地名称进行排序。
若调用方法为getLanguageInfoArray，isUseLocalName属性默认值为true。
若调用方法为getRegionInfoArray，isUseLocalName属性默认值为false。 | +| isSuggestedFirst | boolean | 否 | 是 | true表示将推荐语言或国家地区在排序结果中置顶，false表示不将推荐语言或国家地区在排序结果中置顶。
默认值：true。 | diff --git a/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n.md b/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n.md index 7525b2116a46880fc5b63f4f8dc775b45ab76a61..ffc7e249dbaf7a42746aa14a16097e38dc0a0b20 100644 --- a/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n.md +++ b/zh-cn/application-dev/reference/apis-localization-kit/js-apis-i18n.md @@ -767,11 +767,11 @@ findEntityInfo(text: string): Array<EntityInfoItem> **系统能力：** SystemCapability.Global.I18n -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | ---- | ---- | ---- | ---- | ----------------- | -| type | string | 是 | 是 | 实体的类型，当前支持phone_number和date类型。phone_number表示实体类型是电话号码，date表示实体类型是时间日期。 | -| begin | number | 是 | 是 | 实体在输入字符串中的起始位置。 | -| end | number | 是 | 是 | 实体在输入字符串中的终止位置。 | +| type | string | 否 | 否 | 实体的类型，当前支持phone_number和date类型。phone_number表示实体类型是电话号码，date表示实体类型是时间日期。 | +| begin | number | 否 | 否 | 实体在输入字符串中的起始位置。 | +| end | number | 否 | 否 | 实体在输入字符串中的终止位置。 | ## Calendar8+ @@ -1266,8 +1266,8 @@ isValidNumber(number: string): boolean **示例：** ```ts - let phonenumberfmt: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN'); - let isValidNumber: boolean = phonenumberfmt.isValidNumber('158****2312'); // isValidNumber = true + let formatter: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN'); + let isValidNumber: boolean = formatter.isValidNumber('158****2312'); // isValidNumber = true ``` @@ -1298,18 +1298,18 @@ format(number: string): string **示例：** ```ts - let phonenumberfmt: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN'); + let formatter: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN'); // formattedPhoneNumber = '158 **** 2312' - let formattedPhoneNumber: string = phonenumberfmt.format('158****2312'); + let formattedPhoneNumber: string = formatter.format('158****2312'); // 拨号中的电话号码格式化 let option: i18n.PhoneNumberFormatOptions = { type: 'TYPING' }; - let phoneNumberFmt: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN', option); + let typingFormatter: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN', option); let phoneNumber: string = '130493'; let formatResult: string = ''; for (let i = 0; i < phoneNumber.length; i++) { formatResult += phoneNumber.charAt(i); - formatResult = phoneNumberFmt.format(formatResult); // formatResult = '130 493' + formatResult = typingFormatter.format(formatResult); // formatResult = '130 493' } ``` @@ -1338,9 +1338,9 @@ getLocationName(number: string, locale: string): string **示例：** ```ts - let phonenumberfmt: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN'); - let locationName: string = phonenumberfmt.getLocationName('158****2345', 'zh-CN'); // locationName = '广东省湛江市' - let locName: string = phonenumberfmt.getLocationName('0039312****789', 'zh-CN'); // locName = '意大利' + let phonenumberFormat: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN'); + let locationName: string = phonenumberFormat.getLocationName('158****2345', 'zh-CN'); // locationName = '广东省湛江市' + let locName: string = phonenumberFormat.getLocationName('0039312****789', 'zh-CN'); // locName = '意大利' ``` @@ -1352,9 +1352,9 @@ getLocationName(number: string, locale: string): string **系统能力：** SystemCapability.Global.I18n -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | ---- | ------ | ---- | ---- | ---------------------------------------- | -| type | string | 是 | 是 | 表示对电话号码格式化的类型，取值包括：'E164', 'INTERNATIONAL', 'NATIONAL', 'RFC3966', 'TYPING'。
-在API version 8版本，type为必填项。
-API version 9版本开始，type为选填项。
-API version 12版本开始支持TYPING，表示对拨号中的电话号码实时格式化。| +| type | string | 否 | 是 | 表示对电话号码格式化的类型，取值包括：'E164', 'INTERNATIONAL', 'NATIONAL', 'RFC3966', 'TYPING'。
-在API version 8版本，type为必填项。
-API version 9版本开始，type为选填项。
-API version 12版本开始支持TYPING，表示对拨号中的电话号码实时格式化。| ## UnitInfo8+ @@ -1365,10 +1365,10 @@ getLocationName(number: string, locale: string): string **系统能力：** SystemCapability.Global.I18n -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | ------------- | ------ | ---- | ---- | ---------------------------------------- | -| unit | string | 是 | 是 | 单位的名称，如：'meter', 'inch', 'cup'等。 | -| measureSystem | string | 是 | 是 | 单位的度量体系，取值包括：'SI', 'US', 'UK'。 | +| unit | string | 否 | 否 | 单位的名称，如：'meter', 'inch', 'cup'等。 | +| measureSystem | string | 否 | 否 | 单位的度量体系，取值包括：'SI', 'US', 'UK'。 | ## i18n.getInstance8+ @@ -3175,13 +3175,13 @@ getHolidayInfoItemArray(year?: number): Array<[HolidayInfoItem](#holidayinfoi **系统能力：** SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | --------------- | ------ | --------------------------------------- | -| baseName | string | 是 | 节假日的英文名称。 | -| year | number | 是 | 节假日所在年。 | -| month | number | 是 | 节假日所在月。 | -| day | number | 是 | 节假日所在日。 | -| localNames | Array<[HolidayLocalName](#holidaylocalname11)> | 否 | 节假日的本地名称列表。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | --------------- | ------ | ------ | --------------------------------------- | +| baseName | string | 否 | 否 | 节假日的英文名称。 | +| year | number | 否 | 否 | 节假日所在年。 | +| month | number | 否 | 否 | 节假日所在月。 | +| day | number | 否 | 否 | 节假日所在日。 | +| localNames | Array<[HolidayLocalName](#holidaylocalname11)> | 否 | 是 | 节假日的本地名称列表。 | ## HolidayLocalName11+ @@ -3191,10 +3191,10 @@ getHolidayInfoItemArray(year?: number): Array<[HolidayInfoItem](#holidayinfoi **系统能力：** SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | -----------------| ------ | --------------------------------------- | -| language | string | 是 | 语言，例如ar，en，tr。 | -| name | string | 是 | 节假日的本地名称，例如Sacrifice Feast（宰牲节）的土耳其语名称为Kurban Bayrami。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | -----------------| ------ | ------ | --------------------------------------- | +| language | string | 否 | 否 | 语言，例如ar，en，tr。 | +| name | string | 否 | 否 | 节假日的本地名称，例如Sacrifice Feast（宰牲节）的土耳其语名称为Kurban Bayrami。 | ## i18n.getSimpleDateTimeFormatByPattern20+ @@ -3679,12 +3679,12 @@ format(value: number): StyledString **系统能力：** SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | --------------- | ------ | --------------------------------------- | -| integer | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 指定整数部分的文本样式。默认值：默认的文本样式。 | -| decimal | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 指定小数点的文本样式。默认值：默认的文本样式。 | -| fraction | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 指定小数部分的文本样式。默认值：默认的文本样式。 | -| unit | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 指定单位部分的文本样式。默认值：默认的文本样式。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | --------------- | ------ | ------ | --------------------------------------- | +| integer | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 是 | 指定整数部分的文本样式。默认值：默认的文本样式。 | +| decimal | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 是 | 指定小数点的文本样式。默认值：默认的文本样式。 | +| fraction | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 是 | 指定小数部分的文本样式。默认值：默认的文本样式。 | +| unit | [TextStyle](../apis-arkui/arkui-ts/ts-universal-styled-string.md#textstyle) | 否 | 是 | 指定单位部分的文本样式。默认值：默认的文本样式。 | ## i18n.getDisplayCountry(deprecated) diff --git a/zh-cn/application-dev/reference/apis-localization-kit/js-apis-intl.md b/zh-cn/application-dev/reference/apis-localization-kit/js-apis-intl.md index dc5e6d44a4eecf90bbf5fdfc2f95a64f3ba7f79f..04b0a33ae6c9d19b9c42ee23cd2d0d0bf7146089 100644 --- a/zh-cn/application-dev/reference/apis-localization-kit/js-apis-intl.md +++ b/zh-cn/application-dev/reference/apis-localization-kit/js-apis-intl.md @@ -202,14 +202,14 @@ minimize(): Locale **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | ------- | ---- |---------------------------------------- | -| calendar | string | 否 |日历参数，取值包括：
"buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 | -| collation | string | 否 |区域的排序规则，取值包括：
"big5han"：拉丁字母使用的拼音排序。
"compat"：兼容性排序，仅用于阿拉伯语。
"dict"：词典风格排序，仅用于僧伽罗语。
"direct"：二进制码点排序。
"ducet"：按Unicode排序元素表排序。
"eor"：按欧洲排序规则排序。
"gb2312"：拼音排序，仅用于中文排序。
"phonebk"：电话本风格排序。
"phonetic"：发音排序。
"pinyin"：拼音排序。
"reformed"：瑞典语排序。
"searchjl"：韩语初始辅音搜索的特殊排序。
"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 | 否 | true表示对数字字符进行特殊的排序规则处理，false表示不对数字字符进行特殊的排序规则处理。默认值：false。 | -| caseFirst | string | 否 | 区域的排序规则是否考虑大小写，取值包括：
"upper"：大写排前面。
"lower"：小写排前面。
"false"：使用区域默认的大小写排序规则。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | ------- | ---- | ---- |---------------------------------------- | +| calendar | string | 否 | 是 |历法参数，取值包括：
"buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 | +| collation | string | 否 | 是 |区域的排序规则，取值包括：
"big5han"：拉丁字母使用的拼音排序。
"compat"：兼容性排序，仅用于阿拉伯语。
"dict"：词典风格排序，仅用于僧伽罗语。
"direct"：二进制码点排序。
"ducet"：按Unicode排序元素表排序。
"eor"：按欧洲排序规则排序。
"gb2312"：拼音排序，仅用于中文排序。
"phonebk"：电话本风格排序。
"phonetic"：发音排序。
"pinyin"：拼音排序。
"reformed"：瑞典语排序。
"searchjl"：韩语初始辅音搜索的特殊排序。
"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 | 否 | 是 | true表示将数字字符视为数字进行排序处理，false表示将数字字符视为普通字符进行排序处理。例如设置为true时，字符串“21”和字符串“123”比较，相当与数字21和123比较。默认值：false。 | +| caseFirst | string | 否 | 是 | 区域的排序规则是否考虑大小写，取值包括：
"upper"：大写排前面。
"lower"：小写排前面。
"false"：使用区域默认的大小写排序规则。 | > **说明：** > @@ -232,10 +232,10 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```ts - // 使用系统当前区域ID创建DateTimeFormat对象 - let datefmt= new intl.DateTimeFormat(); - ``` +```ts +// 使用系统当前区域ID创建DateTimeFormat对象 +let formatter: intl.DateTimeFormat = new intl.DateTimeFormat(); +``` ### constructor @@ -257,13 +257,13 @@ constructor(locale: string | Array<string>, options?: DateTimeOptions) | options | [DateTimeOptions](#datetimeoptions) | 否 | 创建时间、日期格式化对象时可设置的配置项。
若所有选项均未设置时，year、month、day三个属性的默认值为numeric。 | **示例：** - ```ts - // 使用zh-CN区域ID创建DateTimeFormat对象，日期风格为full，时间风格为medium - let datefmt= new intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' }); +```ts +// 使用zh-CN区域ID创建DateTimeFormat对象，日期风格为full，时间风格为medium +let formatter: intl.DateTimeFormat = new intl.DateTimeFormat('zh-CN', { dateStyle: 'full', timeStyle: 'medium' }); - // 使用区域ID列表创建DateTimeFormat对象，因为ban为非法区域ID，因此使用zh区域ID创建DateTimeFormat对象 - let datefmt= new intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' }); - ``` +// 使用区域ID列表创建DateTimeFormat对象，因为ban为非法区域ID，因此使用zh区域ID创建DateTimeFormat对象 +formatter = new intl.DateTimeFormat(['ban', 'zh'], { dateStyle: 'full', timeStyle: 'medium' }); +``` ### format @@ -290,16 +290,16 @@ format(date: Date): string | string | 格式化后的时间、日期字符串。 | **示例：** - ```ts - let date = new Date(2021, 11, 17, 3, 24, 0); // 时间日期为2021.12.17 03:24:00 - // 使用en-GB区域ID创建DateTimeFormat对象 - let datefmt = new intl.DateTimeFormat("en-GB"); - let formattedDate = datefmt.format(date); // formattedDate "17/12/2021" - - // 使用en-GB区域ID创建DateTimeFormat对象，dateStyle设置为full，timeStyle设置为medium - datefmt = new intl.DateTimeFormat("en-GB", { dateStyle: 'full', timeStyle: 'medium' }); - formattedDate = datefmt.format(date); // formattedDate "Friday, 17 December 2021 at 03:24:00" - ``` +```ts +let date: Date = new Date(2021, 11, 17, 3, 24, 0); // 时间日期为2021.12.17 03:24:00 +// 使用en-GB区域ID创建DateTimeFormat对象 +let formatter: intl.DateTimeFormat = new intl.DateTimeFormat('en-GB'); +let formattedDate: string = formatter.format(date); // formattedDate "17/12/2021" + +// 使用en-GB区域ID创建DateTimeFormat对象，dateStyle设置为full，timeStyle设置为medium +formatter = new intl.DateTimeFormat('en-GB', { dateStyle: 'full', timeStyle: 'medium' }); +formattedDate = formatter.format(date); // formattedDate "Friday, 17 December 2021, 03:24:00" +``` ### formatRange @@ -327,13 +327,13 @@ formatRange(startDate: Date, endDate: Date): string | string | 格式化后的时间段、日期段字符串。 | **示例：** - ```ts - let startDate = new Date(2021, 11, 17, 3, 24, 0); // 时间日期为2021.12.17 03:24:00 - let endDate = new Date(2021, 11, 18, 3, 24, 0); - // 使用en-GB区域ID创建DateTimeFormat对象 - let datefmt = new intl.DateTimeFormat("en-GB"); - let formattedDateRange = datefmt.formatRange(startDate, endDate); // formattedDateRange = "17/12/2021 - 18/12/2021" - ``` +```ts +let startDate: Date = new Date(2021, 11, 17, 3, 24, 0); // 时间日期为2021.12.17 03:24:00 +let endDate: Date = new Date(2021, 11, 18, 3, 24, 0); +// 使用en-GB区域ID创建DateTimeFormat对象 +let formatter: intl.DateTimeFormat = new intl.DateTimeFormat('en-GB'); +let formattedDateRange: string = formatter.formatRange(startDate, endDate); // formattedDateRange = "17/12/2021 - 18/12/2021" +``` ### resolvedOptions @@ -354,13 +354,13 @@ resolvedOptions(): DateTimeOptions | [DateTimeOptions](#datetimeoptions) | 时间、日期格式化对象设置的配置项。 | **示例：** - ```ts - let datefmt = new intl.DateTimeFormat("en-GB", { dateStyle: 'full', timeStyle: 'medium' }); - // 返回DateTimeFormat对象的配置项 - let options = datefmt.resolvedOptions(); - let dateStyle = options.dateStyle; // dateStyle = "full" - let timeStyle = options.timeStyle; // timeStyle = "medium" - ``` +```ts +let formatter: intl.DateTimeFormat = new intl.DateTimeFormat("en-GB", { dateStyle: 'full', timeStyle: 'medium' }); +// 返回DateTimeFormat对象的配置项 +let options: intl.DateTimeOptions = formatter.resolvedOptions(); +let dateStyle: string | undefined = options.dateStyle; // dateStyle = 'full' +let timeStyle: string | undefined = options.timeStyle; // timeStyle = 'medium' +``` ## DateTimeOptions @@ -373,27 +373,27 @@ resolvedOptions(): DateTimeOptions **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| --------------- | ------- | ---- | ---------------------------------------- | -| locale | string | 否 |合法的区域ID，如：zh-Hans-CN。
默认值：系统当前区域ID。 | -| dateStyle | string | 否 |日期显示格式，取值包括：
"long", "short", "medium", "full", "auto"。
不同取值的显示效果请参考[时间日期国际化表1](../../internationalization/i18n-time-date.md)。 | -| timeStyle | string | 否 |时间显示格式，取值包括：
"long", "short", "medium", "full", "auto"。
不同取值的显示效果请参考[时间日期国际化表2](../../internationalization/i18n-time-date.md)。 | -| hourCycle | string | 否 |时制格式，取值包括：
"h11", "h12", "h23", "h24"。
不设置dateStyle或timeStyle参数时的显示效果请参考[时间日期国际化表5](../../internationalization/i18n-time-date.md)。
设置dateStyle或timeStyle参数时的显示效果请参考[时间日期国际化表6](../../internationalization/i18n-time-date.md)。 | -| 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 | 否 | true表示使用12小时制，false表示使用24小时制。
同时设置hour12和hourCycle时，hourCycle不生效。
若hour12和hourCycle未设置且系统24小时开关打开时，hour12属性的默认值为false。| -| weekday | string | 否 | 星期的显示格式，取值包括：
"long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表4](../../internationalization/i18n-time-date.md)。 | -| era | string | 否 | 纪元的显示格式，取值包括：
"long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表9](../../internationalization/i18n-time-date.md)。 | -| year | string | 否 | 年份的显示格式，取值包括：
"numeric", "2-digit"。
不同取值的显示效果请参考[时间日期国际化表3](../../internationalization/i18n-time-date.md)。 | -| month | string | 否 | 月份的显示格式，取值包括：
"numeric", "2-digit", "long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表6](../../internationalization/i18n-time-date.md)。 | -| day | string | 否 | 日期的显示格式，取值包括：
"numeric", "2-digit"。 | -| hour | string | 否 | 小时的显示格式，取值包括：
"numeric", "2-digit"。 | -| minute | string | 否 | 分钟的显示格式，取值包括：
"numeric", "2-digit"。 | -| second | string | 否 | 秒钟的显示格式，取值包括：
"numeric", "2-digit"。 | -| timeZoneName | string | 否 | 时区名称的本地化表示，取值包括：
"long", "short", "auto"。
不同取值的显示效果请参考[时间日期国际化表8](../../internationalization/i18n-time-date.md)。 | -| dayPeriod | string | 否 | 时段的显示格式，取值包括：
"long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表10](../../internationalization/i18n-time-date.md)。 | -| localeMatcher | string | 否 | 要使用的区域匹配算法，取值包括：
"lookup"：精确匹配。
"best fit"：最佳匹配。 | -| formatMatcher | string | 否 | 要使用的格式匹配算法，取值包括：
"basic"：精确匹配。
"best fit"：最佳匹配。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| --------------- | ------- | ---- | ---- | ---------------------------------------- | +| locale | string | 否 | 是 |合法的区域ID，如：zh-Hans-CN。
默认值：系统当前区域ID。 | +| dateStyle | string | 否 | 是 |日期显示格式，取值包括：
"long", "short", "medium", "full", "auto"。
不同取值的显示效果请参考[时间日期国际化表1](../../internationalization/i18n-time-date.md)。 | +| timeStyle | string | 否 | 是 |时间显示格式，取值包括：
"long", "short", "medium", "full", "auto"。
不同取值的显示效果请参考[时间日期国际化表2](../../internationalization/i18n-time-date.md)。 | +| hourCycle | string | 否 | 是 |时制格式，取值包括：
"h11", "h12", "h23", "h24"。
不设置dateStyle或timeStyle参数时的显示效果请参考[时间日期国际化表5](../../internationalization/i18n-time-date.md)。
设置dateStyle或timeStyle参数时的显示效果请参考[时间日期国际化表6](../../internationalization/i18n-time-date.md)。 | +| 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 | 否 | 是 | true表示使用12小时制，false表示使用24小时制。
同时设置hour12和hourCycle时，hourCycle不生效。
若hour12和hourCycle未设置且系统24小时开关打开时，hour12属性的默认值为false。| +| weekday | string | 否 | 是 | 星期的显示格式，取值包括：
"long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表4](../../internationalization/i18n-time-date.md)。 | +| era | string | 否 | 是 | 纪元的显示格式，取值包括：
"long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表9](../../internationalization/i18n-time-date.md)。 | +| year | string | 否 | 是 | 年份的显示格式，取值包括：
"numeric", "2-digit"。
不同取值的显示效果请参考[时间日期国际化表3](../../internationalization/i18n-time-date.md)。 | +| month | string | 否 | 是 | 月份的显示格式，取值包括：
"numeric", "2-digit", "long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表6](../../internationalization/i18n-time-date.md)。 | +| day | string | 否 | 是 | 日期的显示格式，取值包括：
"numeric", "2-digit"。 | +| hour | string | 否 | 是 | 小时的显示格式，取值包括：
"numeric", "2-digit"。 | +| minute | string | 否 | 是 | 分钟的显示格式，取值包括：
"numeric", "2-digit"。 | +| second | string | 否 | 是 | 秒钟的显示格式，取值包括：
"numeric", "2-digit"。 | +| timeZoneName | string | 否 | 是 | 时区名称的本地化表示，取值包括：
"long", "short", "auto"。
不同取值的显示效果请参考[时间日期国际化表8](../../internationalization/i18n-time-date.md)。 | +| dayPeriod | string | 否 | 是 | 时段的显示格式，取值包括：
"long", "short", "narrow", "auto"。
不同取值的显示效果请参考[时间日期国际化表10](../../internationalization/i18n-time-date.md)。 | +| localeMatcher | string | 否 | 是 | 要使用的区域匹配算法，取值包括：
"lookup"：精确匹配。
"best fit"：最佳匹配。 | +| formatMatcher | string | 否 | 是 | 要使用的格式匹配算法，取值包括：
"basic"：精确匹配。
"best fit"：最佳匹配。 | ## NumberFormat @@ -408,10 +408,10 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```ts - // 使用系统当前区域ID创建NumberFormat对象 - let numfmt = new intl.NumberFormat(); - ``` +```ts +// 使用系统当前区域ID创建NumberFormat对象 +let formatter: intl.NumberFormat = new intl.NumberFormat(); +``` ### constructor @@ -432,10 +432,10 @@ constructor(locale: string | Array<string>, options?: NumberOptions) | options | [NumberOptions](#numberoptions) | 否 | 创建数字格式化对象时可设置的配置项。 | **示例：** - ```ts - // 使用en-GB区域ID创建NumberFormat对象，style设置为decimal，notation设置为scientific - let numfmt = new intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"}); - ``` +```ts +// 使用en-GB区域ID创建NumberFormat对象，style设置为decimal，notation设置为scientific +let formatter: intl.NumberFormat = new intl.NumberFormat('en-GB', { style: 'decimal', notation: 'scientific' }); +``` ### format @@ -461,18 +461,18 @@ format(number: number): string **示例：** - ```ts - // 使用区域ID列表创建NumberFormat对象，因为en-GB为合法的区域ID，因此使用en-GB创建NumberFormat对象 - let numfmt : intl.NumberFormat = new intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); - let formattedNumber : string = numfmt.format(1223); // formattedNumber = 1.223E3 - let options : intl.NumberOptions = { - roundingPriority: "lessPrecision", - maximumFractionDigits: 3, - maximumSignificantDigits: 3 - } - let numberFmt : intl.NumberFormat = new intl.NumberFormat("en", options); - let result : string = numberFmt.format(1.23456); // result = 1.23 - ``` +```ts +// 使用区域ID列表创建NumberFormat对象，因为en-GB为合法的区域ID，因此使用en-GB创建NumberFormat对象 +let formatter: intl.NumberFormat = new intl.NumberFormat(['en-GB', 'zh'], { style: 'decimal', notation: 'scientific' }); +let formattedNumber: string = formatter.format(1223); // formattedNumber = 1.223E3 +let options : intl.NumberOptions = { + roundingPriority: "lessPrecision", + maximumFractionDigits: 3, + maximumSignificantDigits: 3 +} +formatter = new intl.NumberFormat('en', options); +let result: string = formatter.format(1.23456); // result = 1.23 +``` ### formatRange18+ @@ -499,10 +499,10 @@ formatRange(startRange: number, endRange: number): string **示例：** - ```ts - let numfmt : intl.NumberFormat = new intl.NumberFormat("en-US", {style:'unit', unit:"meter"}); - let formattedRange : string = numfmt.formatRange(0, 3); // formattedRange: 0–3 m - ``` +```ts +let formatter: intl.NumberFormat = new intl.NumberFormat('en-US', { style: 'unit', unit: 'meter' }); +let formattedRange: string = formatter.formatRange(0, 3); // formattedRange: 0–3 m +``` ### resolvedOptions @@ -523,13 +523,13 @@ resolvedOptions(): NumberOptions **示例：** - ```ts - let numfmt = new intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); - // 获取NumberFormat对象配置项 - let options = numfmt.resolvedOptions(); - let style = options.style; // style = decimal - let notation = options.notation; // notation = scientific - ``` +```ts +let formatter: intl.NumberFormat = new intl.NumberFormat(['en-GB', 'zh'], { style: 'decimal', notation: 'scientific' }); +// 获取NumberFormat对象配置项 +let options: intl.NumberOptions = formatter.resolvedOptions(); +let style: string | undefined = options.style; // style = 'decimal' +let notation: string | undefined = options.notation; // notation = 'scientific' +``` ## NumberOptions @@ -537,30 +537,30 @@ resolvedOptions(): NumberOptions **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| ------------------------ | ------- | ---- | ---------------------------------------- | -| locale | string | 否 | 合法的区域ID， 如："zh-Hans-CN"。
默认值：系统当前区域ID。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| currency | string | 否 | 货币单位， 取值符合[ISO-4217标准](https://www.iso.org/iso-4217-currency-codes.html)，如："EUR"，"CNY"，"USD"等。
从API version 12开始支持三位数字代码，如："978"，"156"，"840"等。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| currencySign | string | 否 | 货币单位的符号显示，取值包括： "standard"，"accounting"。
默认值：standard。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| currencyDisplay | string | 否 | 货币的显示方式，取值包括："symbol", "narrowSymbol", "code", "name"。
默认值：symbol。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| unit | string | 否 | 单位名称，如："meter"，"inch"，“hectare”等。
从API version 18开始新增支持的组合单位有： "beat-per-minute", "body-weight-per-second", "breath-per-minute", "foot-per-hour", "jump-rope-per-minute", "meter-per-hour", "milliliter-per-minute-per-kilogram", "rotation-per-minute", "step-per-minute", "stroke-per-minute"。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| unitDisplay | string | 否 | 单位的显示格式，取值包括："long", "short", "narrow"。
默认值：short。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| 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", "elapsed-time-second", "size-file-byte", "size-shortfile-byte"。
默认值：default。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| signDisplay | string | 否 | 数字符号的显示格式，取值包括：
"auto"：自动判断是否显示正负符号。
"never"：不显示正负号。
"always"：总是显示正负号。
"exceptZero"：除了0都显示正负号。
默认值："auto"。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| compactDisplay | string | 否 | 紧凑显示格式，取值包括："long", "short"。
默认值：short。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| notation | string | 否 | 数字的表示方法，取值包括："standard", "scientific", "engineering", "compact"。
默认值：standard。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| localeMatcher | string | 否 | 要使用的区域匹配算法，取值包括："lookup", "best fit"。
默认值：best fit。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| style | string | 否 | 数字的显示格式，取值包括："decimal", "currency", "percent", "unit"。
默认值：decimal。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| 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"。
默认值：区域的默认数字系统。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| useGrouping | boolean | 否 | true表示分组显示，false表示不分组显示。
默认值：true。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| minimumIntegerDigits | number | 否 | 表示要使用的最小整数位数，取值范围：1~21。
默认值：1。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| minimumFractionDigits | number | 否 | 表示要使用的最小分数位数，取值范围：0~20。
默认值：0。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| maximumFractionDigits | number | 否 | 表示要使用的最大分数位数，取值范围：1~21。
默认值：3。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| minimumSignificantDigits | number | 否 | 表示要使用的最小有效位数，取值范围：1~21。
默认值：1。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| maximumSignificantDigits | number | 否 | 表示要使用的最大有效位数，取值范围：1~21。
默认值：21。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | -| roundingPriority18+ | string | 否 | 最大分数位数和最大有效位数同时设置时的舍入优先级，取值包括："auto"，"morePrecision" 取最大分数位数，"lessPrecision" 取最大有效位数。
默认值：auto。
**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | -| roundingIncrement18+ | number | 否 | 表示舍入增量，取值范围：1，2，5，10，20，25，50，100，200，250，500，1000，2000，2500，5000。
默认值：1。
**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | -| roundingMode18+ | string | 否 | 表示舍入模式，取值包括：
"ceil"：向上取整。
"floor"：向下取整。
"expand"：远离零取整。
"trunc"：向零取整。
"halfCeil"：半向上取整，大于等于增量的一半时向上取整，小于增量的一半时向下取整。
"halfFloor"：半向下取整，大于增量的一半时向上取整，小于等于增量的一半时向下取整。
"halfExpand"：半远离零取整，大于等于增量的一半时远离零取整，小于增量的一半时向零取整。
"halfTrunc"：半向零取整，大于增量的一半时远离零取整，小于等于增量的一半时向零取整。
"halfEven"：半向偶数取整，大于增量的一半时 远离零取整，小于增量的一半时向零取整，等于增量的一半时向最近的偶数位舍入。
默认值：halfExpand。
**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| ------------------------ | ------- | ---- | ---- | ---------------------------------------- | +| locale | string | 否 | 是 | 合法的区域ID， 如："zh-Hans-CN"。
默认值：系统当前区域ID。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| currency | string | 否 | 是 | 货币单位， 取值符合[ISO-4217标准](https://www.iso.org/iso-4217-currency-codes.html)，如："EUR"，"CNY"，"USD"等。
从API version 12开始支持三位数字代码，如："978"，"156"，"840"等。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| currencySign | string | 否 | 是 | 货币单位的符号显示，取值包括： "standard"，"accounting"。
默认值：standard。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| currencyDisplay | string | 否 | 是 | 货币的显示方式，取值包括："symbol", "narrowSymbol", "code", "name"。
默认值：symbol。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| unit | string | 否 | 是 | 单位名称，如："meter"，"inch"，“hectare”等。
从API version 18开始新增支持的组合单位有： "beat-per-minute", "body-weight-per-second", "breath-per-minute", "foot-per-hour", "jump-rope-per-minute", "meter-per-hour", "milliliter-per-minute-per-kilogram", "rotation-per-minute", "step-per-minute", "stroke-per-minute"。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| unitDisplay | string | 否 | 是 | 单位的显示格式，取值包括："long", "short", "narrow"。
默认值：short。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| 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", "elapsed-time-second", "size-file-byte", "size-shortfile-byte"。
默认值：default。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| signDisplay | string | 否 | 是 | 数字符号的显示格式，取值包括：
"auto"：自动判断是否显示正负符号。
"never"：不显示正负号。
"always"：总是显示正负号。
"exceptZero"：除了0都显示正负号。
默认值："auto"。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| compactDisplay | string | 否 | 是 | 紧凑显示格式，取值包括："long", "short"。
默认值：short。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| notation | string | 否 | 是 | 数字的表示方法，取值包括："standard", "scientific", "engineering", "compact"。
默认值：standard。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| localeMatcher | string | 否 | 是 | 要使用的区域匹配算法，取值包括："lookup", "best fit"。
默认值：best fit。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| style | string | 否 | 是 | 数字的显示格式，取值包括："decimal", "currency", "percent", "unit"。
默认值：decimal。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| 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"。
默认值：区域的默认数字系统。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| useGrouping | boolean | 否 | 是 | true表示分组显示，false表示不分组显示。
默认值：true。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| minimumIntegerDigits | number | 否 | 是 | 表示要使用的最小整数位数，取值范围：1~21。
默认值：1。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| minimumFractionDigits | number | 否 | 是 | 表示要使用的最小分数位数，取值范围：0~20。
默认值：0。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| maximumFractionDigits | number | 否 | 是 | 表示要使用的最大分数位数，取值范围：1~21。
默认值：3。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| minimumSignificantDigits | number | 否 | 是 | 表示要使用的最小有效位数，取值范围：1~21。
默认值：1。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| maximumSignificantDigits | number | 否 | 是 | 表示要使用的最大有效位数，取值范围：1~21。
默认值：21。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| roundingPriority18+ | string | 否 | 是 | 最大分数位数和最大有效位数同时设置时的舍入优先级，取值包括："auto"，"morePrecision" 取最大分数位数，"lessPrecision" 取最大有效位数。
默认值：auto。
**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | +| roundingIncrement18+ | number | 否 | 是 | 表示舍入增量，取值范围：1，2，5，10，20，25，50，100，200，250，500，1000，2000，2500，5000。
默认值：1。
**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | +| roundingMode18+ | string | 否 | 是 | 表示舍入模式，取值包括：
"ceil"：向上取整。
"floor"：向下取整。
"expand"：远离零取整。
"trunc"：向零取整。
"halfCeil"：半向上取整，大于等于增量的一半时向上取整，小于增量的一半时向下取整。
"halfFloor"：半向下取整，大于增量的一半时向上取整，小于等于增量的一半时向下取整。
"halfExpand"：半远离零取整，大于等于增量的一半时远离零取整，小于增量的一半时向零取整。
"halfTrunc"：半向零取整，大于增量的一半时远离零取整，小于等于增量的一半时向零取整。
"halfEven"：半向偶数取整，大于增量的一半时 远离零取整，小于增量的一半时向零取整，等于增量的一半时向最近的偶数位舍入。
默认值：halfExpand。
**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | > **说明：** > @@ -685,15 +685,15 @@ resolvedOptions(): CollatorOptions **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 | 说明 | -| ----------------- | ------- | ---- | ---------------------------------------- | -| localeMatcher(deprecated) | string | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.localeMatcher替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
区域匹配算法，取值范围：
"lookup"：模糊匹配。
"best fit"：准确匹配。
默认值："best fit"。 | -| usage(deprecated) | string | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.usage替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
比较的用途，取值范围：
"sort"：用作排序。
"search"：用作查找匹配的字符串。
默认值："sort"。 | -| sensitivity(deprecated) | string | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.sensitivity替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
表示字符串中的哪些差异会导致非零结果值，取值范围：
"base"：不同的字母比较不相等，比如：'a' ≠ 'b', 'a' = 'á', 'a' = 'A'。
"accent"：不同的字母或不同读音的相同字母比较不相等，比如'a' ≠ 'b', 'a' ≠ 'á', 'a' = 'A'。
"case"：不同的字母或相同字母大小写比较不相等，比如：'a' ≠ 'b', 'a' = 'á', 'a' ≠ 'A'。
"variant"：不同的字母或读音及其它有区别的标志或大小写都是不相等的，比如：'a' ≠ 'b', 'a' ≠ 'á', 'a' ≠ 'A'。
默认值："variant"。 | -| ignorePunctuation(deprecated) | boolean | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.ignorePunctuation替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
true表示忽略标点符号，false表示考虑标点符号。
默认值：false。 | -| collation(deprecated) | string | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.collation替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
区域的排序规则，取值包括：
"big5han"：拉丁字母使用的拼音排序。
"compat"：兼容性排序，仅用于阿拉伯语。
"dict"：词典风格排序，仅用于僧伽罗语。
"direct"：二进制码点排序。
"ducet"：按Unicode排序元素表排序。
"eor"：按欧洲排序规则排序。
"gb2312"：拼音排序，仅用于中文排序。
"phonebk"：电话本风格排序。
"phonetic"：发音排序。
"pinyin"：拼音排序。
"reformed"：瑞典语排序。
"searchjl"：韩语初始辅音搜索的特殊排序。
"stroke"：汉语的笔画排序。
"trad"：传统风格排序，如西班牙语。
"unihan"：统一汉字排序，用于日语、韩语、中文等汉字排序。
"zhuyin"：注音排序，仅用于中文排序。
默认值："default"。 | -| numeric(deprecated) | boolean | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.numeric替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
数字排序，取值包括：
true：使用数字排序，比如：'1' < '2' < '10' < '11'。
false：不使用数字排序，比如：'1' < '10' < '11' < '2'。
默认值：false。 | -| caseFirst(deprecated) | string | 否 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.caseFirst替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
区域的排序规则是否考虑大小写，取值包括：
"upper"：大写排前面。
"lower"：小写排前面。
"false"：使用区域默认的大小写排序规则。
默认值："false"。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| ----------------- | ------- | ---- | ---- | ---------------------------------------- | +| localeMatcher(deprecated) | string | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.localeMatcher替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
区域匹配算法，取值范围：
"lookup"：模糊匹配。
"best fit"：准确匹配。
默认值："best fit"。 | +| usage(deprecated) | string | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.usage替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
比较的用途，取值范围：
"sort"：用作排序。
"search"：用作查找匹配的字符串。
默认值："sort"。 | +| sensitivity(deprecated) | string | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.sensitivity替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
表示字符串中的哪些差异会导致非零结果值，取值范围：
"base"：不同的字母比较不相等，比如：'a' ≠ 'b', 'a' = 'á', 'a' = 'A'。
"accent"：不同的字母或不同读音的相同字母比较不相等，比如'a' ≠ 'b', 'a' ≠ 'á', 'a' = 'A'。
"case"：不同的字母或相同字母大小写比较不相等，比如：'a' ≠ 'b', 'a' = 'á', 'a' ≠ 'A'。
"variant"：不同的字母或读音及其它有区别的标志或大小写都是不相等的，比如：'a' ≠ 'b', 'a' ≠ 'á', 'a' ≠ 'A'。
默认值："variant"。 | +| ignorePunctuation(deprecated) | boolean | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.ignorePunctuation替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
true表示忽略标点符号，false表示考虑标点符号。
默认值：false。 | +| collation(deprecated) | string | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.collation替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
区域的排序规则，取值包括：
"big5han"：拉丁字母使用的拼音排序。
"compat"：兼容性排序，仅用于阿拉伯语。
"dict"：词典风格排序，仅用于僧伽罗语。
"direct"：二进制码点排序。
"ducet"：按Unicode排序元素表排序。
"eor"：按欧洲排序规则排序。
"gb2312"：拼音排序，仅用于中文排序。
"phonebk"：电话本风格排序。
"phonetic"：发音排序。
"pinyin"：拼音排序。
"reformed"：瑞典语排序。
"searchjl"：韩语初始辅音搜索的特殊排序。
"stroke"：汉语的笔画排序。
"trad"：传统风格排序，如西班牙语。
"unihan"：统一汉字排序，用于日语、韩语、中文等汉字排序。
"zhuyin"：注音排序，仅用于中文排序。
默认值："default"。 | +| numeric(deprecated) | boolean | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.numeric替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
数字排序，取值包括：
true：使用数字排序，比如：'1' < '2' < '10' < '11'。
false：不使用数字排序，比如：'1' < '10' < '11' < '2'。
默认值：false。 | +| caseFirst(deprecated) | string | 否 | 是 | 从API version 8开始支持，从API version 20开始不再维护，建议使用Intl.CollatorOptions.caseFirst替代，用法参考[Intl.Collator](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options)。
区域的排序规则是否考虑大小写，取值包括：
"upper"：大写排前面。
"lower"：小写排前面。
"false"：使用区域默认的大小写排序规则。
默认值："false"。 | ## PluralRules8+ @@ -737,10 +737,10 @@ constructor(locale: string | Array<string>, options?: PluralRulesOptions) | options | [PluralRulesOptions](#pluralrulesoptions8) | 否 | 创建单复数对象时设置的配置项。 | **示例：** - ```ts - // 使用zh-CN区域ID创建PluralRules对象，localeMatcher设置为lookup，type设置为cardinal - let pluralRules= new intl.PluralRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"}); - ``` +```ts +// 使用zh-CN区域ID创建PluralRules对象，localeMatcher设置为lookup，type设置为cardinal +let pluralRules: intl.PluralRules = new intl.PluralRules('zh-CN', { localeMatcher: 'lookup', type: 'cardinal' }); +``` ### select(deprecated) @@ -812,10 +812,10 @@ constructor() **系统能力**：SystemCapability.Global.I18n **示例：** - ```ts - // 使用系统区域创建RelativeTimeFormat对象 - let relativetimefmt = new intl.RelativeTimeFormat(); - ``` +```ts +// 使用系统区域创建RelativeTimeFormat对象 +let formatter: intl.RelativeTimeFormat = new intl.RelativeTimeFormat(); +``` ### constructor8+ @@ -836,10 +836,14 @@ constructor(locale: string | Array<string>, options?: RelativeTimeFormatIn | options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions8) | 否 | 创建相对时间格式化对象时可配置的选项。 | **示例：** - ```ts - // 使用zh-CN区域ID创建RelativeTimeFormat对象，localeMatcher设置为lookup，numeric设置为always，style设置为long - let relativeTimeFormat = new intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"}); - ``` +```ts +// 使用zh-CN区域ID创建RelativeTimeFormat对象，localeMatcher设置为lookup，numeric设置为always，style设置为long +let formatter: intl.RelativeTimeFormat = new intl.RelativeTimeFormat('zh-CN', { + localeMatcher: 'lookup', + numeric: 'always', + style: 'long' +}); +``` ### format8+ @@ -866,12 +870,12 @@ format(value: number, unit: string): string | string | 格式化后的相对时间。 | **示例：** - ```ts - // 使用zh-CN区域ID创建RelativeTimeFormat对象 - let relativetimefmt = new intl.RelativeTimeFormat("zh-CN"); - // 计算zh-CN区域中数字3，单位quarter的本地化表示 - let formatResult = relativetimefmt.format(3, "quarter"); // formatResult = "3个季度后" - ``` +```ts +// 使用zh-CN区域ID创建RelativeTimeFormat对象 +let formatter: intl.RelativeTimeFormat = new intl.RelativeTimeFormat('zh-CN'); +// 计算zh-CN区域中数字3，单位quarter的本地化表示 +let formatResult: string = formatter.format(3, 'quarter'); // formatResult = '3个季度后' +``` ### formatToParts8+ @@ -898,11 +902,11 @@ formatToParts(value: number, unit: string): Array<object> | Array<object> | 格式化结果中各个部分的对象数组。 | **示例：** - ```ts - // 使用en区域ID创建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"} ] - ``` +```ts +// 使用en区域ID创建RelativeTimeFormat对象，numeric设置为auto +let formatter: intl.RelativeTimeFormat = new intl.RelativeTimeFormat('en', { numeric: 'auto' }); +let parts: Array = formatter.formatToParts(10, 'seconds'); // parts = [ {type: 'literal', value: 'in'}, {type: 'integer', value: 10, unit: 'second'}, {type: 'literal', value: 'seconds'} ] +``` ### resolvedOptions8+ @@ -922,13 +926,13 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions | [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions8) | 相对时间格式化对象的格式化配置项。 | **示例：** - ```ts - // 使用en-GB区域ID创建RelativeTimeFormat对象 - let relativetimefmt= new intl.RelativeTimeFormat("en-GB", { style: "short" }); - // 获取RelativeTimeFormat对象配置项 - let options = relativetimefmt.resolvedOptions(); - let style = options.style; // style = "short" - ``` +```ts +// 使用en-GB区域ID创建RelativeTimeFormat对象 +let formatter: intl.RelativeTimeFormat = new intl.RelativeTimeFormat('en-GB', { style: 'short' }); +// 获取RelativeTimeFormat对象配置项 +let options: intl.RelativeTimeFormatResolvedOptions = formatter.resolvedOptions(); +let style: string = options.style; // style = 'short' +``` ## RelativeTimeFormatInputOptions8+ @@ -941,11 +945,11 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 |说明 | -| ------------- | ------ | ---- | ---------------------------------------- | -| localeMatcher | string | 否 | 区域匹配算法，取值包括："best fit", "lookup"。
默认值：best fit。 | -| numeric | string | 否 | 输出消息的格式，取值包括："always", "auto"。
默认值：always。 | -| style | string | 否 | 国际化消息的长度，取值包括："long", "short", "narrow"。
默认值：long。 | +| 名称 | 类型 | 只读 | 可选 |说明 | +| ------------- | ------ | ---- | ---- | ---------------------------------------- | +| localeMatcher | string | 否 | 是 | 区域匹配算法，取值包括："best fit", "lookup"。
默认值：best fit。 | +| numeric | string | 否 | 是 | 输出消息的格式，表示格式化结果中是否使用数字表示相对日期或时间。取值包括："always", "auto"。
默认值：always。 | +| style | string | 否 | 是 | 国际化消息的长度，取值包括："long", "short", "narrow"。
默认值：long。 | > **说明** > @@ -959,12 +963,12 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions **系统能力**：SystemCapability.Global.I18n -| 名称 | 类型 | 必填 |说明 | -| --------------- | ------ | ---- | ---------------------------------------- | -| locale | string | 是 | 表示区域ID的字符串，包括语言以及可选的脚本和区域。 | -| numeric | string | 是 | 输出消息的格式，取值包括："always", "auto"。 | -| style | string | 是 | 国际化消息的长度，取值包括："long", "short", "narrow"。 | -| 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"。 | +| 名称 | 类型 | 只读 | 可选 |说明 | +| --------------- | ------ | ---- | ---- | ---------------------------------------- | +| locale | string | 否 | 否 | 表示区域ID的字符串，包括语言以及可选的脚本和区域。 | +| numeric | string | 否 | 否 | 输出消息的格式，表示格式化结果中是否使用数字表示相对日期或时间。取值包括："always", "auto"。 | +| style | string | 否 | 否 | 国际化消息的长度，取值包括："long", "short", "narrow"。 | +| 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"。 | > **说明** >