Skip to content

D
Docs

yang2765 / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 0
Fork 0
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 688032f2 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 8bcd20f5
隐藏空白更改
内联 并排
Showing with 97 addition and 96 deletion
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @ 688032f2
......@@ -7,11 +7,6 @@ import audio from '@ohos.multimedia.audio';
```
## 权限
无
## getAudioManager
getAudioManager(): AudioManager
......@@ -115,6 +110,7 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err)=>{
if (err) {
console.error('Failed to set the volume. ${err.message}');
......@@ -146,6 +142,7 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise&lt;void&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(()=>
console.log('Promise returned to indicate a successful volume setting.');
)
......@@ -167,6 +164,7 @@ getVolume(volumeType: AudioVolumeType, callback: AsyncCallback&lt;number&gt;): v
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
console.error('Failed to obtain the volume. ${err.message}');
......@@ -197,6 +195,7 @@ getVolume(volumeType: AudioVolumeType): Promise&lt;number&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) =>
console.log('Promise returned to indicate that the volume is obtained.' + value);
)
......@@ -218,6 +217,7 @@ getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback&lt;number&gt;)
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
console.error('Failed to obtain the minimum volume. ${err.message}');
......@@ -248,6 +248,7 @@ getMinVolume(volumeType: AudioVolumeType): Promise&lt;number&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) =>
console.log('Promised returned to indicate that the minimum volume is obtained.' + value);
)
......@@ -269,6 +270,7 @@ getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback&lt;number&gt;)
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
console.error('Failed to obtain the maximum volume. ${err.message}');
......@@ -299,6 +301,7 @@ getMaxVolume(volumeType: AudioVolumeType): Promise&lt;number&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data)=>
console.log('Promised returned to indicate that the maximum volume is obtained.');
)
......@@ -321,6 +324,7 @@ mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback&lt;void
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => {
if (err) {
console.error('Failed to mute the stream. ${err.message}');
......@@ -353,6 +357,7 @@ mute(volumeType: AudioVolumeType, mute: boolean): Promise&lt;void&gt;
```
var audioManager = audio.getAudioManager();
audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() =>
console.log('Promise returned to indicate that the stream is muted.');
)
......@@ -375,6 +380,7 @@ isMute(volumeType: AudioVolumeType, callback: AsyncCallback&lt;boolean&gt;): voi
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
console.error('Failed to obtain the mute status. ${err.message}');
......@@ -406,6 +412,7 @@ isMute(volumeType: AudioVolumeType): Promise&lt;boolean&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) =>
console.log('Promise returned to indicate that the mute status of the stream is obtained.' + value);
)
......@@ -427,6 +434,7 @@ isActive(volumeType: AudioVolumeType, callback: AsyncCallback&lt;boolean&gt;): v
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
console.error('Failed to obtain the active status of the stream. ${err.message}');
......@@ -457,6 +465,7 @@ isActive(volumeType: AudioVolumeType): Promise&lt;boolean&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) =>
console.log('Promise returned to indicate that the active status of the stream is obtained.' + value);
)
......@@ -478,6 +487,7 @@ setRingerMode(mode: AudioRingMode, callback: AsyncCallback&lt;void&gt;): void
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => {
if (err) {
console.error('Failed to set the ringer mode.​ ${err.message}');
......@@ -508,6 +518,7 @@ setRingerMode(mode: AudioRingMode): Promise&lt;void&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() =>
console.log('Promise returned to indicate a successful setting of the ringer mode.');
)
......@@ -529,6 +540,7 @@ getRingerMode(callback: AsyncCallback&lt;AudioRingMode&gt;): void
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getRingerMode((err, value) => {
if (err) {
console.error('Failed to obtain the ringer mode.​ ${err.message}');
......@@ -554,6 +566,7 @@ getRingerMode(): Promise&lt;AudioRingMode&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getRingerMode().then((value) =>
console.log('Promise returned to indicate that the ringer mode is obtained.' + value);
)
......@@ -576,6 +589,7 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback&lt;void&gt
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
if (err) {
console.error('Failed to set the audio parameter. ${err.message}');
......@@ -607,6 +621,7 @@ setAudioParameter(key: string, value: string): Promise&lt;void&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setAudioParameter('PBits per sample', '8 bit').then(() =>
console.log('Promise returned to indicate a successful setting of the audio parameter.');
)
......@@ -628,6 +643,7 @@ getAudioParameter(key: string, callback: AsyncCallback&lt;string&gt;): void
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getAudioParameter('PBits per sample', (err, value) => {
if (err) {
console.error('Failed to obtain the value of the audio parameter. ${err.message}');
......@@ -658,6 +674,7 @@ getAudioParameter(key: string): Promise&lt;string&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getAudioParameter('PBits per sample').then((value) =>
console.log('Promise returned to indicate that the value of the audio parameter is obtained.' + value);
)
......@@ -678,6 +695,7 @@ getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback&lt;AudioDeviceDescrip
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value)=>{
if (err) {
console.error('Failed to obtain the device list. ${err.message}');
......@@ -708,6 +726,7 @@ audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value)=>{
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data)=>
console.log('Promise returned to indicate that the device list is obtained.');
)
......@@ -730,6 +749,7 @@ setDeviceActive(deviceType: DeviceType, active: boolean, callback: AsyncCallback
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true, (err)=> {
if (err) {
console.error('Failed to set the active status of the device. ${err.message}');
......@@ -762,6 +782,7 @@ setDeviceActive(deviceType: DeviceType, active: boolean): Promise&lt;void&gt;
```
var audioManager = audio.getAudioManager();
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(()=>
console.log('Promise returned to indicate that the device is set to the active status.');
)
......@@ -783,6 +804,7 @@ isDeviceActive(deviceType: DeviceType, callback: AsyncCallback&lt;boolean&gt;):
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isDeviceActive(audio.DeviceType.SPEAKER, (err, value) => {
if (err) {
console.error('Failed to obtain the active status of the device. ${err.message}');
......@@ -814,6 +836,7 @@ isDeviceActive(deviceType: DeviceType): Promise&lt;boolean&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isDeviceActive(audio.DeviceType.SPEAKER).then((value) =>
console.log('Promise returned to indicate that the active status of the device is obtained.' + value);
)
......@@ -835,6 +858,7 @@ setMicrophoneMute(mute: boolean, callback: AsyncCallback&lt;void&gt;): void
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setMicrophoneMute(true, (err) => {
if (err) {
console.error('Failed to mute the microphone. ${err.message}');
......@@ -865,6 +889,7 @@ setMicrophoneMute(mute: boolean): Promise&lt;void&gt;
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.setMicrophoneMute(true).then(() =>
console.log('Promise returned to indicate that the microphone is muted.');
)
......@@ -885,6 +910,7 @@ isMicrophoneMute(callback: AsyncCallback&lt;boolean&gt;): void
**示例：**
```
var audioManager = audio.getAudioManager();
audioManager.isMicrophoneMute((err, value) => {
if (err) {
console.error('Failed to obtain the mute status of the microphone. ${err.message}');
......@@ -910,6 +936,7 @@ isMicrophoneMute(): Promise&lt;boolean&gt;
```
var audioManager = audio.getAudioManager();
audioManager.isMicrophoneMute().then((value) =>
console.log('Promise returned to indicate that the mute status of the microphone is obtained.', + value);
)
......
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
浏览文件 @ 688032f2
......@@ -7,14 +7,9 @@
## 导入模块
```
import convertxml from '@ohos.convertxml'
import convertxml from '@ohos.convertxml';
```
## 权限
无
## ConvertXML
......@@ -48,7 +43,7 @@ convert(xml: string, options?: ConvertOptions) : Object
' <todo>Work</todo>' +
' <todo>Play</todo>' +
'</note>';
var conv= new convertxml.ConvertXML();
var conv = new convertxml.ConvertXML();
var result1 = conv.convert(xml, {trim: false, ignoreDeclaration: false});
console.log(result1)
```
......@@ -63,7 +58,7 @@ convert(xml: string, options?: ConvertOptions) : Object
| ignoreInstruction | boolean | 否 | 是否忽略xml的写入处理指令，默认false。 |
| ignoreAttributes | boolean | 否 | 是否跨多行打印属性并缩进属性，默认false。 |
| ignoreComment | boolean | 否 | 是否忽略元素的注释信息，默认false。 |
| ignoreCdata | boolean | 否 | 是否忽略元素的CData信息，默认false。 |
| ignoreCDATA | boolean | 否 | 是否忽略元素的CDATA信息，默认false。 |
| ignoreDoctype | boolean | 否 | 是否忽略元素的Doctype信息，默认false。 |
| ignoreText | boolean | 否 | 是否忽略元素的文本信息，默认false。 |
| declarationKey | string | 否 | 用于输出对象中declaration的属性键的名称，默认_declaration。 |
......
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 688032f2
......@@ -575,6 +575,7 @@ prepare(config: AudioRecorderConfig): void
**示例：**
```
var audiorecorder = media.createAudioRecorder();
let audioRecorderConfig = {
audioEncoder : AAC_LC ,
audioEncodeBitRate : 22050,
......@@ -596,6 +597,7 @@ start(): void
**示例：**
```
var audiorecorder = media.createAudioRecorder();
audiorecorder.start();
```
......@@ -608,6 +610,7 @@ stop(): void
**示例：**
```
var audiorecorder = media.createAudioRecorder();
audiorecorder.stop();
```
......@@ -620,6 +623,7 @@ release(): void
**示例：**
```
var audiorecorder = media.createAudioRecorder();
audiorecorder.release();
```
......@@ -634,6 +638,7 @@ reset(): void
**示例：**
```
var audiorecorder = media.createAudioRecorder();
audiorecorder.reset();
```
......@@ -653,6 +658,7 @@ on(type: 'prepare' | 'start' | 'stop' | 'release' | 'reset', callback: () => voi
**示例：**
```
var audiorecorder = media.createAudioRecorder();
audiorecorder.on('prepare', () => {
console.log('Preparation succeeded.');
audiorecorder.start();
......
zh-cn/application-dev/reference/apis/js-apis-process.md
浏览文件 @ 688032f2
......@@ -11,11 +11,6 @@ import process from '@ohos.process';
```
## 权限
无
## 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
......@@ -295,7 +290,7 @@ getPastCputime() :number
getSystemConfig(name:number): number
用该方法发送signal到指定的进程。
获取系统配置信息。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-uri.md
浏览文件 @ 688032f2
......@@ -90,9 +90,10 @@ equals(other: URI): boolean
uriInstance.equals(uriInstance1);
```
### checkIsAbsolute
checkIsAbsolute(): boolean
判断此URI是否为绝对URI（是否定义了scheme组件）。
- 返回值：
......
zh-cn/application-dev/reference/apis/js-apis-url.md
浏览文件 @ 688032f2
......@@ -11,11 +11,6 @@ import Url from '@ohos.url'
```
## 权限
无
## URLSearchParams
......
zh-cn/application-dev/reference/apis/js-apis-util.md
浏览文件 @ 688032f2
......@@ -15,11 +15,6 @@ import util from '@ohos.util';
```
## 权限
无
## util.printf
printf(format: string, ...args: Object[]): string
......@@ -296,7 +291,7 @@ RationalNumber的构造函数。
- 示例：
```
var rationalNumber = new util.RationalNumber(1,2)；
var rationalNumber = new util.RationalNumber(1,2);
```
......@@ -551,7 +546,7 @@ constructor(capacity?:number)
- 示例：
```
var lrubuffer= new util.LruBuffer()；
var lrubuffer= new util.LruBuffer();
```
......@@ -661,7 +656,7 @@ getMissCount():number
```
var pro = new util.LruBuffer();
pro.put(2,10);
pro.get(2)
pro.get(2);
var result = pro.getMissCount();
```
......@@ -896,7 +891,7 @@ afterRemoval(isEvict:boolean,key:K,value:V,newValue:V):void
}
}
}
ChildLruBuffer.getInstance().afterRemoval(false,10,30,null)；
ChildLruBuffer.getInstance().afterRemoval(false,10,30,null);
```
......@@ -1115,7 +1110,7 @@ intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope
var tempMiDF = new Temperature(35);
var tempMidS = new Temperature(39);
var range = new util.Scope(tempLower, tempUpper);
var result = range.intersect(tempMiDF, tempMidS)；
var result = range.intersect(tempMiDF, tempMidS);
```
......@@ -1135,7 +1130,7 @@ getUpper():ScopeType
var tempLower = new Temperature(30);
var tempUpper = new Temperature(40);
var range = new util.Scope(tempLower, tempUpper);
var result = range.getUpper()；
var result = range.getUpper();
```
......@@ -1155,7 +1150,7 @@ getLower():ScopeType
var tempLower = new Temperature(30);
var tempUpper = new Temperature(40);
var range = new util.Scope(tempLower, tempUpper);
var result = range.getLower()；
var result = range.getLower();
```
......@@ -1183,7 +1178,7 @@ expand(lowerObj:ScopeType,upperObj:ScopeType):Scope
var tempMiDF = new Temperature(35);
var tempMidS = new Temperature(39);
var range = new util.Scope(tempLower, tempUpper);
var result = range.expand(tempMiDF, tempMidS)；
var result = range.expand(tempMiDF, tempMidS);
```
......@@ -1211,7 +1206,7 @@ expand(range:Scope):Scope
var tempMidS = new Temperature(39);
var range = new util.Scope(tempLower, tempUpper);
var rangeFir = new util.Scope(tempMiDF, tempMidS);
var result = range.expand(rangeFir)；
var result = range.expand(rangeFir);
```
......@@ -1237,7 +1232,7 @@ expand(value:ScopeType):Scope
var tempUpper = new Temperature(40);
var tempMiDF = new Temperature(35);
var range = new util.Scope(tempLower, tempUpper);
var result = range.expand(tempMiDF)；
var result = range.expand(tempMiDF);
```
......@@ -1263,7 +1258,7 @@ contains(value:ScopeType):boolean
var tempUpper = new Temperature(40);
var tempMiDF = new Temperature(35);
var range = new util.Scope(tempLower, tempUpper);
range.contains(tempMiDF)；
range.contains(tempMiDF);
```
......@@ -1291,7 +1286,7 @@ contains(range:Scope):boolean
var tempLess = new Temperature(20);
var tempMore = new Temperature(45);
var rangeSec = new util.Scope(tempLess, tempMore);
var result = range.contains(rangeSec)；
var result = range.contains(rangeSec);
```
......@@ -1309,7 +1304,7 @@ clamp(value:ScopeType):ScopeType
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value |
| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 |
- 示例：
```
......@@ -1317,7 +1312,7 @@ clamp(value:ScopeType):ScopeType
var tempUpper = new Temperature(40);
var tempMiDF = new Temperature(35);
var range = new util.Scope(tempLower, tempUpper);
var result = range.clamp(tempMiDF)；
var result = range.clamp(tempMiDF);
```
......@@ -1332,7 +1327,7 @@ Base64的构造函数。
- 示例：
```
var base64 = new util.Base64()；
var base64 = new util.Base64();
```
......@@ -1429,12 +1424,11 @@ encode(src:Uint8Array):Promise&lt;Uint8Array&gt;
var that = new util.Base64();
var array = new Uint8Array([115,49,51]);
var rarray = new Uint8Array([99,122,69,122]);
await that.encode(array).then(val=>{
that.encode(array).then(val=>{
for (var i = 0; i < rarray.length; i++) {
expect(val[i]).assertEqual(rarray[i])
}
})
done();
```
......@@ -1458,10 +1452,9 @@ encodeToString(src:Uint8Array):Promise&lt;string&gt;
```
var that = new util.Base64();
var array = new Uint8Array([115,49,51]);
await that.encodeToString(array).then(val=>{
that.encodeToString(array).then(val=>{
expect(val).assertEqual('czEz')
})
done();
```
......@@ -1486,12 +1479,11 @@ decode(src:Uint8Array | string):Promise&lt;Uint8Array&gt;
var that = new util.Base64();
var array = new Uint8Array([99,122,69,122]);
var rarray = new Uint8Array([115,49,51]);
await that.decode(array).then(val=>{
that.decode(array).then(val=>{
for (var i = 0; i < rarray.length; i++) {
expect(val[i]).assertEqual(rarray[i])
}
})
done();
```
......@@ -1588,7 +1580,7 @@ isArgumentsObject(value: Object):boolean
isArrayBuffer(value: Object):boolean
检查输入的value是否是ArrayBuffer对象类型。
检查输入的value是否是ArrayBuffer类型。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-worker.md
浏览文件 @ 688032f2
......@@ -11,11 +11,6 @@ import worker from '@ohos.worker';
```
## 权限
无
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
......@@ -51,7 +46,7 @@ worker构造函数。
| options | [WorkerOptions](#workeroptions) | 否 | worker构造的选项。 |
- 返回值：
| 参数名 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| worker | 执行Worker构造函数生成的Worker对象，失败则返回undefined。 |
......@@ -294,7 +289,7 @@ dispatchEvent(event: Event): boolean
| event | [Event](#event) | 是 | 需要分发的事件。 |
- 返回值：
| 参数名 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| boolean | 分发的结果，false表示分发失败。 |
......@@ -347,7 +342,7 @@ worker向宿主线程发送消息。
```
```
// worker.js
import worker from "@ohos.worker";
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e){
parentPort.postMessage("receive data from main.js")
......@@ -369,7 +364,7 @@ close(): void
```
```
// worker.js
import worker from "@ohos.worker";
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e) {
parentPort.close()
......@@ -397,7 +392,7 @@ DedicatedWorkerGlobalScope的onmessage属性表示worker线程收到来自其宿
```
```
// worker.js
import worker from "@ohos.worker";
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e) {
console.log("receive main.js message")
......@@ -424,7 +419,7 @@ DedicatedWorkerGlobalScope的onmessageerror属性表示当 Worker 对象接收
```
```
// worker.js
import worker from "@ohos.worker";
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessageerror= function(e) {
console.log("worker.js onmessageerror")
......@@ -466,7 +461,7 @@ DedicatedWorkerGlobalScope的onmessageerror属性表示当 Worker 对象接收
| evt | [Event](#event) | 是 | 回调的事件类。 |
- 返回值
| 参数名 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| void&nbsp;\|&nbsp;Promise&lt;void&gt; | 无返回值或者以Promise形式返回。 |
......@@ -533,7 +528,7 @@ WorkerGlobalScope的onerror属性表示worker在执行过程中发生异常被
```
```
// worker.js
import worker from "@ohos.worker";
import worker from '@ohos.worker';
const parentPort = worker.parentPort
parentPort.onerror = function(e){
console.log("worker.js onerror")
......
zh-cn/application-dev/reference/apis/js-apis-xml.md
浏览文件 @ 688032f2
......@@ -11,11 +11,6 @@ import xml from '@ohos.xml';
```
## 权限
无
## XmlSerializer
......@@ -28,7 +23,7 @@ XmlSerializer的构造函数。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| buffer | ArrayBuffer&nbsp;\|&nbsp;DataView | 是 | 用于接收写入xml信息的ArrayBuffer&nbsp;\|&nbsp;DataView内存。 |
| buffer | ArrayBuffer&nbsp;\|&nbsp;DataView | 是 | 用于接收写入xml信息的ArrayBuffer或DataView内存。 |
| encoding | string | 否 | 编码格式。 |
- 示例：
......@@ -48,8 +43,8 @@ setAttributes(name: string, value: string)：void
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 属性的key值 |
| value | string | 是 | 属性的value值 |
| name | string | 是 | 属性的key值。 |
| value | string | 是 | 属性的value值。 |
- 示例：
```
......@@ -67,7 +62,7 @@ addEmptyElement(name: string): void
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 该空元素的元素名 |
| name | string | 是 | 该空元素的元素名。 |
- 示例：
```
......@@ -93,12 +88,12 @@ setDeclaration(): void
startElement(name: string): void
XmlSerializer的构造函数。
根据给定名称写入元素开始标记。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 当前元素的元素名 |
| name | string | 是 | 当前元素的元素名。 |
- 示例：
```
......@@ -113,7 +108,7 @@ XmlSerializer的构造函数。
endElement(): void
设置结束元素方法。
写入元素结束标记。
- 示例：
```
......@@ -135,8 +130,8 @@ setNamespace(prefix: string, namespace: string): void
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| prefix | string | 是 | 当前元素及其子元素的前缀 |
| namespace | string | 是 | 当前元素及其子元素的命名空间 |
| prefix | string | 是 | 当前元素及其子元素的前缀。 |
| namespace | string | 是 | 当前元素及其子元素的命名空间。 |
- 示例：
```
......@@ -148,43 +143,43 @@ setNamespace(prefix: string, namespace: string): void
thatSer.endElement();// = >'<?xml version="1.0" encoding="utf-8"?>\r\n<h:note xmlns:h="http://www.w3.org/TR/html4/"/>';
```
### setCommnet
### setComment
setCommnet(text: string): void
setComment(text: string): void
写入comment属性。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 当前元素的注释内容 |
| text | string | 是 | 当前元素的注释内容。 |
- 示例：
```
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setCommnet("Hi!");
thatSer.setComment("Hi!");
thatSer.endElement(); // => '<note>\r\n <!--Hi!-->\r\n</note>';
```
### setCData
### setCDATA
setCData(text: string): void
setCDATA(text: string): void
写入CData属性。
写入CDATA属性。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | CDate属性的内容 |
| text | string | 是 | CDATA属性的内容。 |
- 示例：
```
var arrayBuffer = new ArrayBuffer(1028);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setCData('root SYSTEM') // => '<![CDATA[root SYSTEM]]>';
thatSer.setCDATA('root SYSTEM') // => '<![CDATA[root SYSTEM]]>';
```
......@@ -197,7 +192,7 @@ setText(text: string): void
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | text属性的内容 |
| text | string | 是 | text属性的内容。 |
- 示例：
```
......@@ -219,7 +214,7 @@ setDocType(text: string): void
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | DocType属性的内容 |
| text | string | 是 | DocType属性的内容。 |
- 示例：
```
......@@ -241,8 +236,8 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string)
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| buffer | ArrayBuffer&nbsp;\|&nbsp;DataView | 是 | 含有xml文本信息的ArrayBuffer&nbsp;或者DataView |
| encoding | string | 否 | 编码格式（仅支持utf-8） |
| buffer | ArrayBuffer&nbsp;\|&nbsp;DataView | 是 | 含有xml文本信息的ArrayBuffer或者DataView。 |
| encoding | string | 否 | 编码格式（仅支持utf-8）。 |
- 示例：
```
......@@ -325,12 +320,12 @@ xml解析选项。
getColumnNumber(): number
获取当前行号，从1开始。
获取当前列号，从1开始。
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| number | 返回当前行号。 |
| number | 返回当前列号。 |
### getDepth
......@@ -349,12 +344,12 @@ getDepth(): number
getLineNumber(): number
获取当前列号，从1开始。
获取当前行号，从1开始。
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| number | 返回当前列号。 |
| number | 返回当前行号。 |
### getName
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或