W3Cschool
恭喜您成為首批注冊(cè)用戶(hù)
獲得88經(jīng)驗(yàn)值獎(jiǎng)勵(lì)
本模塊提供轉(zhuǎn)換xml文本為JavaScript對(duì)象的功能。
本模塊首批接口從API version 8開(kāi)始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。
convertToJSObject(xml: string, options?: ConvertOptions) : Object
轉(zhuǎn)換xml文本為JavaScript對(duì)象。
系統(tǒng)能力: SystemCapability.Utils.Lang
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
xml | string | 是 | 傳入的xml文本。 |
options | 否 | 轉(zhuǎn)換選項(xiàng),默認(rèn)值是ConvertOptions對(duì)象 , 由其中各個(gè)屬性的默認(rèn)值組成。。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
Object | 處理后返回的JavaScript對(duì)象。 |
錯(cuò)誤碼:
以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)語(yǔ)言基礎(chǔ)類(lèi)庫(kù)錯(cuò)誤碼。
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
10200002 | Invalid xml string. |
示例:
- try {
- let xml =
- '<?xml version="1.0" encoding="utf-8"?>' +
- '<note importance="high" logged="true">' +
- ' <title>Happy</title>' +
- ' <todo>Work</todo>' +
- ' <todo>Play</todo>' +
- '</note>';
- let conv = new convertxml.ConvertXML()
- let options = {
- trim: false, declarationKey: "_declaration",
- instructionKey: "_instruction", attributesKey: "_attributes",
- textKey: "_text", cdataKey: "_cdata", doctypeKey: "_doctype",
- commentKey: "_comment", parentKey: "_parent", typeKey: "_type",
- nameKey: "_name", elementsKey: "_elements"
- }
- let result = JSON.stringify(conv.convertToJSObject(xml, options));
- console.log(result);
- } catch (e) {
- console.log(e.toString());
- }
- // 輸出(寬泛型)
- // {"_declaration":{"_attributes":{"version":"1.0","encoding":"utf-8"}},"_elements":[{"_type":"element","_name":"note","_attributes":{"importance":"high","logged":"true"},"_elements":[{"_type":"element","_name":"title","_elements":[{"_type":"text","_text":"Happy"}]},{"_type":"element","_name":"todo","_elements":[{"_type":"text","_text":"Work"}]},{"_type":"element","_name":"todo","_elements":[{"_type":"text","_text":"Play"}]}]}]}
convert(xml: string, options?: ConvertOptions) : Object
轉(zhuǎn)換xml文本為JavaScript對(duì)象。
從API version 8開(kāi)始支持,從API version 9開(kāi)始廢棄,建議使用convertToJSObject9+替代。
系統(tǒng)能力: SystemCapability.Utils.Lang
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
xml | string | 是 | 傳入的xml文本。 |
options | 否 | 轉(zhuǎn)換選項(xiàng),默認(rèn)值是ConvertOptions對(duì)象 , 由其中各個(gè)屬性的默認(rèn)值組成。。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
Object | 處理后返回的JavaScript對(duì)象。 |
示例:
- let xml =
- '<?xml version="1.0" encoding="utf-8"?>' +
- '<note importance="high" logged="true">' +
- ' <title>Happy</title>' +
- ' <todo>Work</todo>' +
- ' <todo>Play</todo>' +
- '</note>';
- let conv = new convertxml.ConvertXML();
- let options = {trim : false, declarationKey:"_declaration",
- instructionKey : "_instruction", attributesKey : "_attributes",
- textKey : "_text", cdataKey:"_cdata", doctypeKey : "_doctype",
- commentKey : "_comment", parentKey : "_parent", typeKey : "_type",
- nameKey : "_name", elementsKey : "_elements"}
- let result = JSON.stringify(conv.convert(xml, options));
- console.log(result);
- // 輸出(寬泛型)
- // {"_declaration":{"_attributes":{"version":"1.0","encoding":"utf-8"}},"_elements":[{"_type":"element","_name":"note","_attributes":{"importance":"high","logged":"true"},"_elements":[{"_type":"element","_name":"title","_elements":[{"_type":"text","_text":"Happy"}]},{"_type":"element","_name":"todo","_elements":[{"_type":"text","_text":"Work"}]},{"_type":"element","_name":"todo","_elements":[{"_type":"text","_text":"Play"}]}]}]}
轉(zhuǎn)換選項(xiàng)。
系統(tǒng)能力: SystemCapability.Utils.Lang
名稱(chēng) | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
trim | boolean | 是 | 是否修剪位于文本前后的空白字符。 |
ignoreDeclaration | boolean | 否 | 是否忽略xml寫(xiě)入聲明指示,默認(rèn)false。 |
ignoreInstruction | boolean | 否 | 是否忽略xml的寫(xiě)入處理指令,默認(rèn)false。 |
ignoreAttributes | boolean | 否 | 是否跨多行打印屬性并縮進(jìn)屬性,默認(rèn)false。 |
ignoreComment | boolean | 否 | 是否忽略元素的注釋信息,默認(rèn)false。 |
ignoreCDATA | boolean | 否 | 是否忽略元素的CDATA信息,默認(rèn)false。 |
ignoreDoctype | boolean | 否 | 是否忽略元素的Doctype信息,默認(rèn)false。 |
ignoreText | boolean | 否 | 是否忽略元素的文本信息,默認(rèn)false。 |
declarationKey | string | 是 | 用于輸出對(duì)象中declaration的屬性鍵的名稱(chēng)。 |
instructionKey | string | 是 | 用于輸出對(duì)象中instruction的屬性鍵的名稱(chēng)。 |
attributesKey | string | 是 | 用于輸出對(duì)象中attributes的屬性鍵的名稱(chēng)。 |
textKey | string | 是 | 用于輸出對(duì)象中text的屬性鍵的名稱(chēng)。 |
cdataKey | string | 是 | 用于輸出對(duì)象中cdata的屬性鍵的名稱(chēng)。 |
doctypeKey | string | 是 | 用于輸出對(duì)象中doctype的屬性鍵的名稱(chēng)。 |
commentKey | string | 是 | 用于輸出對(duì)象中comment的屬性鍵的名稱(chēng)。 |
parentKey | string | 是 | 用于輸出對(duì)象中parent的屬性鍵的名稱(chēng)。 |
typeKey | string | 是 | 用于輸出對(duì)象中type的屬性鍵的名稱(chēng)。 |
nameKey | string | 是 | 用于輸出對(duì)象中name的屬性鍵的名稱(chēng)。 |
elementsKey | string | 是 | 用于輸出對(duì)象中elements的屬性鍵的名稱(chēng)。 |
Copyright©2021 w3cschool編程獅|閩ICP備15016281號(hào)-3|閩公網(wǎng)安備35020302033924號(hào)
違法和不良信息舉報(bào)電話(huà):173-0602-2364|舉報(bào)郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號(hào)
聯(lián)系方式:
更多建議: