# string.textTable 库模块帮助文档

## string 成员列表 <a id="string" href="#string">&#x23;</a>

### string.textTable <a id="string.textTable" href="#string.textTable">&#x23;</a>
用于生成文本化表格。  
主要用于 console.table 库。

### string.textTable() <a id="string.textTable" href="#string.textTable">&#x23;</a>
创建文本化表格。  
可选使用参数 @1 传入一个字符串数组以指定列名数组，如果所有列名为空则不显示列标题。  
也可以用多个字符串参数指定列名。

[返回对象:StringTextTableObject](#StringTextTableObject)

## StringTextTableObject 成员列表 <a id="StringTextTableObject" href="#StringTextTableObject">&#x23;</a>

### StringTextTableObject.count() <a id="StringTextTableObject.count" href="#StringTextTableObject.count">&#x23;</a>
返回已添加的行数。

### StringTextTableObject.fields <a id="StringTextTableObject.fields" href="#StringTextTableObject.fields">&#x23;</a>
可选用此属性指定列名数组。

### StringTextTableObject.gridLines <a id="StringTextTableObject.gridLines" href="#StringTextTableObject.gridLines">&#x23;</a>
是否在所有单元格之间显示网络线。  
输出格式设为 markdown 时此属性无效。

### StringTextTableObject.mode <a id="StringTextTableObject.mode" href="#StringTextTableObject.mode">&#x23;</a>
输出风格，可选值如下：  
"simple": 用 ASCII 字符输出表格线，兼容旧系统。  
"fancy": 用 Unicode 字符输出表格线，较美观。  
"markdown": 输出符合 Markdown 语法的表格。  
指定为其他值则仅保留最基本的坚线，不输出水平线与方框。

### StringTextTableObject.push() <a id="StringTextTableObject.push" href="#StringTextTableObject.push">&#x23;</a>
添加一行数据。  
可用参数 @1 指定一个数组，  
指定多个参数则自动合并为数组。

### StringTextTableObject.stringify() <a id="StringTextTableObject.stringify" href="#StringTextTableObject.stringify">&#x23;</a>
将表对象转换为文本化表格，返回字符串。   
如果未指定参数则输出之前添加的所有数据。  
如果参数指定表对象，则先清空之前添加的所有行，然后转换并添加参数指定的表格数据。  
参数表可以是以下格式：  
- 数组的数组:第一层数组逐行输出，第二层数组逐列输出。  
- 键值对数组:逐行输出数组，输出列标题同名的字段值，  
未指定列标题则自动获取所有字段作为列标题。  
- 其他格式的表：逐行输出所有键值对。  
在函数返回后可用 count 函数获取实际输出的数据行总数。

### StringTextTableObject.windowWidth <a id="StringTextTableObject.windowWidth" href="#StringTextTableObject.windowWidth">&#x23;</a>
可选指定最大显示宽度。  
单个非 ASCII 字符宽度为 2, ASCII 字符宽度为 1 。
