Term::TablePrint - Print a table to the terminal and browse it interactively.
use Term::TablePrint :print-table; my @table = ( [ 'id', 'name' ], [ 1, 'Ruth' ], [ 2, 'John' ], [ 3, 'Mark' ], [ 4, 'Nena' ], ); # Functional style: print-table( @table ); # or OO style: my $pt = Term::TablePrint.new(); $pt.print-table( @table );
Importing the subroutine explicitly (
:print-table) might become compulsory (optional for now) with the next release.
print-table shows a table and lets the user interactively browse it. It provides a cursor which highlights the row on which it is located. The user can scroll through the table with the different cursor keys - see #KEYS.
If the table has more rows than the terminal, the table is divided up on as many pages as needed automatically. If the cursor reaches the end of a page, the next page is shown automatically until the last page is reached. Also if the cursor reaches the topmost line, the previous page is shown automatically if it is not already the first one.
If the terminal is too narrow to print the table, the columns are adjusted to the available width automatically.
If the option table-expand is enabled and a row is selected with
Return, each column of that row is output in its own line preceded by the column name. This might be useful if the columns were cut due to the too low terminal width.
The following modifications are made (at a copy of the original data) before the output.
Leading and trailing whitespaces are removed.
Spaces are squashed to a single white-space
In addition, characters of the Unicode property
Other are removed.
The elements in a column are right-justified if one or more elements of that column do not look like a number, else they are left-justified.
Keys to move around:
ArrowDownkey (or the
jkey) to move down and the
ArrowUpkey (or the
kkey) to move up.
Ctrl-B) to go back one page, the
Ctrl-F) to go forward one page.
Ctrl-A) to jump to the first row of the table, the
Ctrl-E) to jump to the last row of the table.
With keep-header disabled the
Return key closes the table if the cursor is on the header row.
If keep-header is enabled and table-expand is set to
Return key closes the table if the cursor is on the first row.
If keep-header and table-expand are enabled and the cursor is on the first row, pressing
Return three times in succession closes the table. If table-expand is set to
1 and the cursor is auto-jumped to the first row, it is required only one
Return to close the table.
If the cursor is not on the first row:
with the option table-expand disabled the cursor jumps to the table head if
with the option table-expand enabled each column of the selected row is output in its own line preceded by the column name if
Returnis pressed. Another
Returncloses this output and goes back to the table output. If a row is selected twice in succession, the pointer jumps to the head of the table or to the first row if keep-header is enabled.
If the width of the window is changed and the option table-expand is enabled, the user can rewrite the screen by choosing a row.
If the option choose-columns is enabled, the
SpaceBar key (or the right mouse key) can be used to select columns - see option /choose-columns.
The constructor method
new can be called with optional named arguments:
Expects as its value a hash. Sets the defaults for the instance. See #OPTIONS.
Expects as its value a window object created by ncurses
print-table uses this global window instead of creating their own without calling
endwin to restores the terminal before returning.
print-table prints the table passed with the first argument.
print-table( @table, %options );
The first argument is an array of arrays. The first array of these arrays holds the column names. The following arrays are the table rows where the elements are the field values.
As a optional second argument it can be passed a hash which holds the options.
String displayed above the table.
If add-header is set to 1,
print-table adds a header row - the columns are numbered starting with 1.
If choose-columns is set to 1, the user can choose which columns to print. The columns can be marked with the
SpaceBar. The list of marked columns including the highlighted column are printed as soon as
Return is pressed.
If choose-columns is set to 2, it is possible to change the order of the columns. Columns can be added (with the
SpaceBar and the
Return key) until the user confirms with the -ok- menu entry.
If keep-header is set to 1, the table header is shown on top of each page.
If keep-header is set to 0, the table header is shown on top of the first page.
Set the maximum number of used table rows. The used table rows are kept in memory.
To disable the automatic limit set max-rows to 0.
If the number of table rows is equal to or higher than max-rows, the last row of the output says
REACHED LIMIT "MAX_ROWS": $limit or
=LIMIT= $limit if the previous doesn't fit in the row.
The columns with a width below or equal min-col-width are only trimmed if it is still required to lower the row width despite all columns wider than min-col-width have been trimmed to min-col-width.
Set the mouse mode (see option
mouse in Term::Choose).
Set the progress bar threshold. If the number of fields (rows x columns) is higher than the threshold, a progress bar is shown while preparing the data for the output.
Set the number of spaces between columns.
If the option table-expand is set to
Return is pressed, the selected table row is printed with each column in its own line. Exception: if table-expand is set to
1 and the cursor auto-jumped to the first row, the first row will not be expanded.
If table-expand is set to 0, the cursor jumps to the to first row (if not already there) when
Return is pressed.
Set the string that will be shown on the screen instead of an undefined field.
Default: "" (empty string)
It is required a terminal that uses a monospaced font which supports the printed characters.
Matthäus Kiem email@example.com
LICENSE AND COPYRIGHT
Copyright 2016-2017 Matthäus Kiem.
This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.