File: advanced-usage.md

package info (click to toggle)
node-cli-table 0.3.11%2B~cs0.13.4-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,036 kB
  • sloc: javascript: 7,508; makefile: 9
file content (247 lines) | stat: -rw-r--r-- 7,715 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
##### use colSpan to span columns - (colSpan above normal cell)
    ┌───────────────┐
    │ greetings     │
    ├───────────────┤
    │ greetings     │
    ├───────┬───────┤
    │ hello │ howdy │
    └───────┴───────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        [{colSpan:2,content:'greetings'}],
        [{colSpan:2,content:'greetings'}],
        ['hello','howdy']
      );

```


##### use colSpan to span columns - (colSpan below normal cell)
    ┌───────┬───────┐
    │ hello │ howdy │
    ├───────┴───────┤
    │ greetings     │
    ├───────────────┤
    │ greetings     │
    └───────────────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        ['hello','howdy'],
        [{colSpan:2,content:'greetings'}],
        [{colSpan:2,content:'greetings'}]
      );

```


##### use rowSpan to span rows - (rowSpan on the left side)
    ┌───────────┬───────────┬───────┐
    │ greetings │           │ hello │
    │           │ greetings ├───────┤
    │           │           │ howdy │
    └───────────┴───────────┴───────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        [{rowSpan:2,content:'greetings'},{rowSpan:2,content:'greetings',vAlign:'center'},'hello'],
        ['howdy']
      );

```


##### use rowSpan to span rows - (rowSpan on the right side)
    ┌───────┬───────────┬───────────┐
    │ hello │ greetings │           │
    ├───────┤           │           │
    │ howdy │           │ greetings │
    └───────┴───────────┴───────────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        ['hello',{rowSpan:2,content:'greetings'},{rowSpan:2,content:'greetings',vAlign:'bottom'}],
        ['howdy']
      );

```


##### mix rowSpan and colSpan together for complex table layouts
    ┌───────┬─────┬────┐
    │ hello │ sup │ hi │
    ├───────┤     │    │
    │ howdy │     │    │
    ├───┬───┼──┬──┤    │
    │ o │ k │  │  │    │
    └───┴───┴──┴──┴────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        [{content:'hello',colSpan:2},{rowSpan:2, colSpan:2,content:'sup'},{rowSpan:3,content:'hi'}],
        [{content:'howdy',colSpan:2}],
        ['o','k','','']
      );

```


##### multi-line content will flow across rows in rowSpan cells
    ┌───────┬───────────┬───────────┐
    │ hello │ greetings │ greetings │
    ├───────┤ friends   │ friends   │
    │ howdy │           │           │
    └───────┴───────────┴───────────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        ['hello',{rowSpan:2,content:'greetings\nfriends'},{rowSpan:2,content:'greetings\nfriends'}],
        ['howdy']
      );

```


##### multi-line content will flow across rows in rowSpan cells - (complex layout)
    ┌───────┬─────┬────┐
    │ hello │ sup │ hi │
    ├───────┤ man │ yo │
    │ howdy │ hey │    │
    ├───┬───┼──┬──┤    │
    │ o │ k │  │  │    │
    └───┴───┴──┴──┴────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        [{content:'hello',colSpan:2},{rowSpan:2, colSpan:2,content:'sup\nman\nhey'},{rowSpan:3,content:'hi\nyo'}],
        [{content:'howdy',colSpan:2}],
        ['o','k','','']
      );

```


##### rowSpan cells can have a staggered layout
    ┌───┬───┐
    │ a │ b │
    │   ├───┤
    │   │ c │
    ├───┤   │
    │ d │   │
    └───┴───┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        [{content:'a',rowSpan:2},'b'],
        [{content:'c',rowSpan:2}],
        ['d']
      );

```


##### the layout manager automatically create empty cells to fill in the table
    ┌───┬───┬──┐
    │ a │ b │  │
    │   ├───┤  │
    │   │   │  │
    │   ├───┴──┤
    │   │ c    │
    ├───┤      │
    │   │      │
    └───┴──────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      //notice we only create 3 cells here, but the table ends up having 6.
      table.push(
        [{content:'a',rowSpan:3,colSpan:2},'b'],
        [],
        [{content:'c',rowSpan:2,colSpan:2}],
        []
      );
```


##### use table `rowHeights` option to fix row height. The truncation symbol will be shown on the last line.
    ┌───────┐
    │ hello │
    │ hi…   │
    └───────┘
```javascript
      var table = new Table({rowHeights:[2],style:{head:[],border:[]}});

      table.push(['hello\nhi\nsup']);

```


##### if `colWidths` is not specified, the layout manager will automatically widen rows to fit the content
    ┌─────────────┐
    │ hello there │
    ├──────┬──────┤
    │ hi   │ hi   │
    └──────┴──────┘
```javascript
      var table = new Table({style:{head:[],border:[]}});

      table.push(
        [{colSpan:2,content:'hello there'}],
        ['hi', 'hi']
      );

```


##### you can specify a column width for only the first row, other rows will be automatically widened to fit content
    ┌─────────────┐
    │ hello there │
    ├────┬────────┤
    │ hi │   hi   │
    └────┴────────┘
```javascript
      var table = new Table({colWidths:[4],style:{head:[],border:[]}});

      table.push(
        [{colSpan:2,content:'hello there'}],
        ['hi',{hAlign:'center',content:'hi'}]
      );

```


##### a column with a null column width will be automatically widened to fit content
    ┌─────────────┐
    │ hello there │
    ├────────┬────┤
    │     hi │ hi │
    └────────┴────┘
```javascript
      var table = new Table({colWidths:[null, 4],style:{head:[],border:[]}});

      table.push(
        [{colSpan:2,content:'hello there'}],
        [{hAlign:'right',content:'hi'}, 'hi']
      );

```


##### feel free to use colors in your content strings, column widths will be calculated correctly
![table image](./examples/screenshots/truncation-with-colors.png)
```javascript
      var table = new Table({colWidths:[5],style:{head:[],border:[]}});

      table.push([colors.red('hello')]);

```