# console.progress 库模块帮助文档

## console 成员列表 <a id="console" href="#console">&#x23;</a>

### console.progress() <a id="console.progress" href="#console.progress">&#x23;</a>
[返回对象:ConsoleProgressObject](#ConsoleProgressObject)

### console.progress(背景字符,前景字符) <a id="console.progress" href="#console.progress">&#x23;</a>
所有参数可选，默认值都设为"─"字符

## console.progress 成员列表 <a id="console.progress" href="#console.progress">&#x23;</a>

控制台简单进度条。  
[使用范例](https://www.aardio.com/zh-cn/docs/examples/Console/loading.html)

创建控制台简单进度条

### console.progress.singleLine <a id="console.progress.singleLine" href="#console.progress.singleLine">&#x23;</a>
创建控制台简单进度条,  
进度条与文本显示在同一行

### console.progress.singleLine(宽度,背景字符,前景字符) <a id="console.progress.singleLine" href="#console.progress.singleLine">&#x23;</a>
所有参数可选，默认值都设为"─"字符

### console.progress.singleLine(） <a id="console.progress.singleLine" href="#console.progress.singleLine">&#x23;</a>
[返回对象:ConsoleProgressObject](#ConsoleProgressObject)

## ConsoleProgressObject 成员列表 <a id="ConsoleProgressObject" href="#ConsoleProgressObject">&#x23;</a>

### ConsoleProgressObject.addProgress <a id="ConsoleProgressObject.addProgress" href="#ConsoleProgressObject.addProgress">&#x23;</a>
增加进度

### ConsoleProgressObject.addProgress(百分比,状态文本) <a id="ConsoleProgressObject.addProgress" href="#ConsoleProgressObject.addProgress">&#x23;</a>
百分比为0到100的数值，状态文本为可选参数

### ConsoleProgressObject.backColor <a id="ConsoleProgressObject.backColor" href="#ConsoleProgressObject.backColor">&#x23;</a>
背景颜色,  
请使用console.color下面的值指定

### ConsoleProgressObject.backText <a id="ConsoleProgressObject.backText" href="#ConsoleProgressObject.backText">&#x23;</a>
背景字符，默认为"─"  
可以为空格，但不能为空字符串

### ConsoleProgressObject.backTextColor <a id="ConsoleProgressObject.backTextColor" href="#ConsoleProgressObject.backTextColor">&#x23;</a>
背景字符颜色,  
请使用console.color下面的值指定

### ConsoleProgressObject.clear() <a id="ConsoleProgressObject.clear" href="#ConsoleProgressObject.clear">&#x23;</a>
清除在屏幕上显示的进度

### ConsoleProgressObject.doneColor <a id="ConsoleProgressObject.doneColor" href="#ConsoleProgressObject.doneColor">&#x23;</a>
进度完成后的字符颜色,  
请使用console.color下面的值指定

### ConsoleProgressObject.doneText <a id="ConsoleProgressObject.doneText" href="#ConsoleProgressObject.doneText">&#x23;</a>
进度完成后的显示文本

### ConsoleProgressObject.foreColor <a id="ConsoleProgressObject.foreColor" href="#ConsoleProgressObject.foreColor">&#x23;</a>
前景颜色,  
请使用console.color下面的值指定

### ConsoleProgressObject.foreText <a id="ConsoleProgressObject.foreText" href="#ConsoleProgressObject.foreText">&#x23;</a>
前景字符，默认为"─"  
可以为空格，但不能为空字符串

### ConsoleProgressObject.foreTextColor <a id="ConsoleProgressObject.foreTextColor" href="#ConsoleProgressObject.foreTextColor">&#x23;</a>
前景字符颜色,  
请使用console.color下面的值指定

### ConsoleProgressObject.reset() <a id="ConsoleProgressObject.reset" href="#ConsoleProgressObject.reset">&#x23;</a>
重置进度条  
如果上次进度没有完成,  
要显示新的进度条前必须调用此函数

### ConsoleProgressObject.setProgress <a id="ConsoleProgressObject.setProgress" href="#ConsoleProgressObject.setProgress">&#x23;</a>
设置进度

### ConsoleProgressObject.setProgress(百分比,状态文本) <a id="ConsoleProgressObject.setProgress" href="#ConsoleProgressObject.setProgress">&#x23;</a>
百分比为0到100的数值，状态文本为可选参数