Tabulate APIs
The tabulate component provides a nice and easy way to perform pretty-printing of tabular data to the console or file.
The tabulate.hpp header provides a convenience include / wrapper around p-ranav/tabulate. It also exposes tabulate’s include folder, so including tabulate.hpp is completely equivalent to including both tabulate/table.hpp. Please see the documentation for tabulate if you have any questions about usage beyond the examples provided here.
API Reference
Header File
Macros
-
__unix__
Classes
-
class __tabulate_documentation__
Table maker for modern c++ convenience wrapper around p-ranav/tabulate which exposes tabulate::Table for creating human-readable tables in console/terminal applications.
Tabulate Example
using namespace tabulate; using Row_t = Table::Row_t; Table universal_constants; universal_constants.add_row({"Quantity", "Value"}); universal_constants.add_row({"Characteristic impedance of vacuum", "376.730 313 461... Ω"}); universal_constants.add_row( {"Electric constant (permittivity of free space)", "8.854 187 817... × 10⁻¹²F·m⁻¹"}); universal_constants.add_row({"Magnetic constant (permeability of free space)", "4π × 10⁻⁷ N·A⁻² = 1.2566 370 614... × 10⁻⁶ N·A⁻²"}); universal_constants.add_row({"Gravitational constant (Newtonian constant of gravitation)", "6.6742(10) × 10⁻¹¹m³·kg⁻¹·s⁻²"}); universal_constants.add_row({"Planck's constant", "6.626 0693(11) × 10⁻³⁴ J·s"}); universal_constants.add_row({"Dirac's constant", "1.054 571 68(18) × 10⁻³⁴ J·s"}); universal_constants.add_row({"Speed of light in vacuum", "299 792 458 m·s⁻¹"}); universal_constants.format() .font_style({FontStyle::bold}) .border_top(" ") .border_bottom(" ") .border_left(" ") .border_right(" ") .corner(" "); universal_constants[0] .format() .padding_top(1) .padding_bottom(1) .font_align(FontAlign::center) .font_style({FontStyle::underline}) .font_background_color(Color::red); universal_constants.column(1).format().font_color(Color::yellow); universal_constants[0][1].format().font_background_color(Color::blue).font_color(Color::white); std::cout << universal_constants << std::endl << std::endl;
Tabulate to Markdown Example
using namespace tabulate; Table movies; movies.add_row({"S/N", "Movie Name", "Director", "Estimated Budget", "Release Date"}); movies.add_row({"tt1979376", "Toy Story 4", "Josh Cooley", "$200,000,000", "21 June 2019"}); movies.add_row({"tt3263904", "Sully", "Clint Eastwood", "$60,000,000", "9 September 2016"}); movies.add_row( {"tt1535109", "Captain Phillips", "Paul Greengrass", "$55,000,000", " 11 October 2013"}); // center align 'Director' column movies.column(2).format().font_align(FontAlign::center); // right align 'Estimated Budget' column movies.column(3).format().font_align(FontAlign::right); // right align 'Release Date' column movies.column(4).format().font_align(FontAlign::right); // Color header cells for (size_t i = 0; i < 5; ++i) { movies[0][i].format().font_color(Color::yellow).font_style({FontStyle::bold}); } // Export to Markdown fmt::print("Exporting to Markdown...\n"); MarkdownExporter exporter; auto markdown = exporter.dump(movies); // tabulate::table std::cout << "Tabulate movie table:\n"; std::cout << movies << "\n\n"; // Exported Markdown std::cout << "Markdown movie table:\n"; std::cout << markdown << std::endl << std::endl;
Complex Tabulate Example
using namespace tabulate; using Row_t = Table::Row_t; Table readme; readme.format().border_color(Color::yellow); readme.add_row(Row_t{"🔥tabulate for Modern C++🔥"}); readme[0].format().font_align(FontAlign::center).font_color(Color::yellow); readme.add_row(Row_t{"https://github.com/p-ranav/tabulate"}); readme[1] .format() .font_align(FontAlign::center) .font_style({FontStyle::underline, FontStyle::italic}) .font_color(Color::white) .hide_border_top(); readme.add_row(Row_t{"Tabulate is a header-only library for printing aligned, formatted, and " "colorized tables in Modern C++"}); readme[2].format().font_style({FontStyle::italic}).font_color(Color::magenta); Table highlights; highlights.add_row(Row_t{"Header-only Library", "Requires C++17", "MIT License"}); readme.add_row(Row_t{highlights}); readme[3].format().font_align(FontAlign::center).hide_border_top(); Table empty_row; empty_row.format().hide_border(); readme.add_row(Row_t{empty_row}); readme[4].format().hide_border_left().hide_border_right(); readme.add_row(Row_t{"Easily format and align content within cells"}); readme[5].format().font_align(FontAlign::center); Table format; format.add_row(Row_t{"Horizontal Alignment", "Left aligned", "Center aligned", "Right aligned"}); format[0].format().font_align(FontAlign::center); format[0][0].format().font_color(Color::green).column_separator(":"); format.column(1).format().width(25).font_align(FontAlign::left); format.column(2).format().width(25).font_align(FontAlign::center); format.column(3).format().width(25).font_align(FontAlign::right); format.add_row({"Word-Wrapping algorithm taking shamelessly from StackOverflow", "Long sentences automatically word-wrap based on the width of the " "column", "Word-wrapping also plays nicely with alignment rules. For instance, " "this cell is center " "aligned.", "Enforce \ncustom word-wrapping \nby embedding '\\n' \ncharacters in " "your cell\n content."}); format[1][0].format().font_align(FontAlign::center); format[1][2].format().font_align(FontAlign::center); format[1][3].format().font_align(FontAlign::right); format.column(0).format().width(23); format.column(1).format().border_left(":"); readme.add_row(Row_t{format}); readme[5] .format() .border_color(Color::green) .font_color(Color::cyan) .font_style({FontStyle::underline}) .padding_top(0) .padding_bottom(0); readme[6].format().hide_border_top().padding_top(0); readme.add_row(Row_t{empty_row}); readme[7].format().hide_border_left().hide_border_right(); Table embedded_table; embedded_table.add_row( {"You can even\n embed tables...", Table().add_row({"within tables", Table().add_row({"within tables", Table().add_row(Row_t{ "within tables", Table().add_row(Row_t{"within tables.. "})})})})}); readme.add_row(Row_t{"Nested Representations"}); readme[8].format().font_align(FontAlign::center); readme.add_row(Row_t{embedded_table}); readme[9].format().hide_border_top().border_color(Color::white).font_color(Color::yellow); readme.add_row(Row_t{"ᚠ ᚡ ᚢ ᚣ ᚤ ᚥ ᚦ ᚧ ᚨ ᚩ ᚪ ᚫ ᚬ ᚭ ᚮ ᚯ ᚰ ᚱ ᚲ ᚳ ᚴ ᚵ ᚶ ᚷ ᚸ ᚹ ᚺ " "ᚻ ᚼ ᚽ ᚾ ᚿ ᛀ ᛁ ᛂ ᛃ ᛄ ᛅ ᛆ ᛇ " "ᛈ ᛉ ᛊ ᛋ ᛌ ᛍ ᛎ ᛏ ᛐ ᛑ ᛒ ᛓ"}); readme[10] .format() .font_background_color(Color::red) .hide_border_top() .multi_byte_characters(true); // Print the table std::cout << readme << "\n\n"; // NOTE: the below chart / table takes too much memory to run on the ESP32 // because it has a lot of rows and columns. Enable the below code to run it on // an ESP system which has external PSRAM enabled. #if 0 Table chart; chart.format() .font_color(Color::white) .padding_left(0) .padding_right(0) .column_separator("") .hide_border(); for (size_t i = 0; i < 9; ++i) { Row_t row; row.push_back(std::to_string(90 - i * 10)); for (size_t j = 0; j <= 50; ++j) { row.push_back(" "); } chart.add_row(row); } Row_t row; for (int i = 0; i <= 12; ++i) { if ((i + 1) % 4 == 0) { row.push_back(std::to_string(i + 1)); } else { row.push_back(" "); } } chart.add_row(row); chart.add_row(Row_t{}); chart.column(0).format().padding_left(1).padding_right(1).border_left(" "); for (size_t i = 1; i <= 18; ++i) { chart.column(i).format().width(2); } chart.column(2).format().border_color(Color::white).border_left("|").border_top("-"); chart.column(2)[8].format().background_color(Color::red); chart.column(2)[7].format().background_color(Color::red); chart.column(3)[8].format().background_color(Color::yellow); chart.column(3)[7].format().background_color(Color::yellow); chart.column(3)[6].format().background_color(Color::yellow); chart.column(6)[8].format().background_color(Color::red); chart.column(6)[7].format().background_color(Color::red); chart.column(6)[6].format().background_color(Color::red); chart.column(6)[5].format().background_color(Color::red); chart.column(7)[8].format().background_color(Color::yellow); chart.column(7)[7].format().background_color(Color::yellow); chart.column(7)[6].format().background_color(Color::yellow); chart.column(7)[5].format().background_color(Color::yellow); chart.column(7)[4].format().background_color(Color::yellow); chart.column(10)[8].format().background_color(Color::red); chart.column(10)[7].format().background_color(Color::red); chart.column(10)[6].format().background_color(Color::red); chart.column(10)[5].format().background_color(Color::red); chart.column(10)[4].format().background_color(Color::red); chart.column(10)[3].format().background_color(Color::red); chart.column(11)[8].format().background_color(Color::yellow); chart.column(11)[7].format().background_color(Color::yellow); chart.column(11)[6].format().background_color(Color::yellow); chart.column(11)[5].format().background_color(Color::yellow); chart.column(11)[4].format().background_color(Color::yellow); chart.column(11)[3].format().background_color(Color::yellow); chart.column(11)[2].format().background_color(Color::yellow); chart.column(11)[1].format().background_color(Color::yellow); chart[2][15].format().background_color(Color::red); chart[2][16].set_text("Batch 1"); chart.column(16).format().padding_left(1).width(20); chart[4][15].format().background_color(Color::yellow); chart[4][16].set_text("Batch 2"); Table legend; legend.add_row(Row_t{"Batch 1", "10", "40", "50", "20", "10", "50"}); legend.add_row(Row_t{"Batch 2", "30", "60", "(70)", "50", "40", "30"}); legend[0].format().font_align(FontAlign::center); legend[1].format().font_align(FontAlign::center); legend.column(0) .format() .font_align(FontAlign::right) .font_color(Color::green) .font_background_color(Color::grey); legend.column(2).format().font_color(Color::white).font_background_color(Color::red); legend[1][3].format().font_style({FontStyle::italic}).font_color(Color::yellow); chart.column(17).format().width(50); chart[4][17].set_text("Cells, rows, and columns"); chart[5][17].set_text("can be independently formatted."); chart[7][17].set_text("This cell is green and italic"); chart[7][17].format().color(Color::green).font_style({FontStyle::italic}); chart[8][17].set_text("This one's yellow and right-aligned"); chart[8][17].format().color(Color::yellow).font_align(FontAlign::right); chart[9][17].set_text("This one's on 🔥🔥🔥"); std::cout << chart; std::cout << legend << "\n\n"; #endif
Note
This class does not really exist or do anything, but it’s the only way I could figure out how to get this documentation built into the system :(